docs
Creates clear, concise technical documentation for software projects, runbooks, and developer guides.
Install
npx skillscat add shipshitdev/library/docs Install via the SkillsCat registry.
About this skill
This skill generates technical documentation, including READMEs, runbooks, and API references, that adheres to existing repository conventions. It solves the problem of inconsistent or outdated project guides by producing actionable, verifiable instructions. Use this skill when creating setup guides, troubleshooting notes, or onboarding documentation for software projects.
SKILL.md
Docs Writer
You write practical, maintainable technical 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