docs-projeto

Generates READMEs, user manuals, technical docs, changelogs, and wikis from verified project code.

1|Updated Jul 7, 2026
One-click install
npx skills add https://github.com/codjeremias-cell/Orquestrador-fable --skill docs-projeto-codjeremias-cell
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-projeto
Source: https://github.com/codjeremias-cell/Orquestrador-fable/tree/main/skills/docs-projeto
Command: npx skills add https://github.com/codjeremias-cell/Orquestrador-fable --skill docs-projeto-codjeremias-cell

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Project documentation often drifts from reality: READMEs list commands that no longer work, manuals describe screens that changed, and changelogs read like raw commit logs. This Skill produces documentation grounded in the actual code, configuration, git history, and real UI screens, so every claim in a document has been verified before it is written. ## Core Features & Use Cases - Audience-targeted documents: Creates READMEs for newcomers, PT-BR task-oriented user manuals with screenshots, technical documentation with architecture views and ADRs, dated changelogs in user language, SOPs, glossaries, and full project wikis. - Verification before writing: Reads pom.xml/package.json, build scripts, git log, and real screens first; executes every install/run command before documenting it and marks anything untestable as "not verified". - Robust wiki mode: Generates a navigable wiki/ folder with a write-ahead manifest, human-edit collision protection, secret scanning, page size caps, and drift detection via git hash-object so stale pages are flagged instead of silently aging. - Use Case: After closing a release, ask for the changelog and a README check; the Skill reads the real git history between tags, writes a dated Adicionado/Corrigido/Alterado block in user language, and runs the README's build command to confirm it works. ## Quick Start Use the docs-projeto skill to write the README and generate the changelog for this project from the real code and git history.

Frequently Asked Questions about docs-projeto

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write a README that actually matches my project?▼

Generate the README from real sources: read pom.xml or package.json for the actual name, version, and dependencies, then execute every install and run command before documenting it. Anything that cannot be tested in the session is explicitly marked as not verified.

How to generate a changelog from git history?▼

Read the real git log between version tags, group entries into Added, Fixed, and Changed sections with dates, and write in user-facing language rather than commit jargon. If no usable git history exists, start an initial changelog declaring that limitation.

What should a user manual for a non-technical audience include?▼

A user manual should be task-oriented with one step per line, written in plain language, and include a screenshot of each relevant screen captured from the real application. It should also contain a common problems section mapping each error to its cause and solution.

Can this generate a full project wiki safely?▼

Yes, but only on explicit request. Wiki generation uses a write-ahead manifest for resumability, skips pages written by humans, scans for leaked credentials, caps page sizes, and flags pages as outdated when the covered source files change.

When should I not use this documentation skill?▼

Do not use it for inline code comments, which belong to development work, or for recording work preferences and task progress across sessions, which belong to project memory and state tracking. It documents the finished product for its readers.