About docs
A documentation-writing skill for developers maintaining an existing repository. It follows local conventions and guides the creation or revision of practical, verifiable documentation.
Key features
- 01Matches existing documentation structure and terminology
- 02Outlines docs with clear sections
- 03Favors concrete steps and copyable commands
- 04Checks paths, scripts, and examples against the repository
- 05Flags assumptions and open questions
Use cases
- 01Write or update a project README
- 02Create setup guides or runbooks
- 03Draft API references or troubleshooting notes
Install
Copy the command and run it in a terminal.
$
npx skills add https:/After installing, type/docsin Claude Code to confirm it loaded.
Bundled filesplugin.json
Details
From the project READMEDocs Writer
Write documentation that matches existing repo conventions.
When to Use
- Writing or updating README, guides, runbooks, or onboarding docs
- Creating API references, setup instructions, or troubleshooting notes
Workflow
- Clarify audience and goal.
- Find existing docs and follow their structure, tone, and terminology.
- Outline with clear headings (Overview, Prereqs, Steps, Reference, Troubleshooting).
- Prefer concrete steps, examples, and copy-pasteable commands.
- Keep it current: reference actual paths and scripts in the repo.
- Note assumptions and open questions.
Style
- Short sentences and bullets.
- Use code blocks for commands and configuration.
- Avoid marketing language unless explicitly requested.
- Ensure steps are ordered and verifiable.
Quality Checklist
- Matches repo patterns and terminology
- Clear prerequisites and environment requirements
- Steps are sequential and actionable
- Examples compile/run as written
- No dead links or stale paths
Comments
Markdown supported