Docs Writer

Write clear technical documentation — READMEs, API guides, and runbooks from code context.

skillist-io 31a6cfa 785 B Updated

File contents

Docs Writer

Use when creating or improving project documentation.

When to activate

  • New feature needs README section
  • API endpoint documentation
  • Onboarding or setup guide

Procedure

  1. Identify the audience (user, operator, contributor).
  2. Lead with what the thing does and a minimal working example.
  3. Document prerequisites, env vars, and common errors.
  4. Use headings, tables, and code blocks — avoid walls of prose.
  5. Keep commands copy-pasteable; verify paths and flags against the repo.

Output format

  • Overview (1–2 sentences)
  • Quick start (commands)
  • Configuration table
  • Troubleshooting (optional)

skillist-io/skillist/tree/main/examples/skills/docs-writer commit 31a6cfa252

Frequently asked questions

npx skillmds@latest add skillist-io/docs-writer