@shipshitdev/docs
Creates clear, concise technical documentation for software projects, runbooks, and developer guides.
No skills found in this collection.
SKILL.md
| name | docs |
| description | Creates clear, concise technical documentation for software projects, runbooks, and developer guides. Use when writing or updating a README, guide, runbook, API reference, setup instructions, or troubleshooting notes. |
Docs 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
Loading...
Select a file to preview
Analyzing security...
Checking scan reports and verification data.
Bill of Materials
Everything this skill can do — files, network, commands, and more.
No demos yet. To add one, ask your AI agent: "Submit a demo for @shipshitdev/docs" — or upload via the API.
To add a demo, ask your AI agent: "Submit a demo for @shipshitdev/docs"
No eval data yet. Eval results are published via the SkillSafe API.