# Docs Writer

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

- Skill: `skillist-io/docs-writer` (Agent Skill)
- Install (CLI): `npx skillmds@latest add skillist-io/docs-writer`
- Raw SKILL.md: https://api.skillmd.com/api/skills/skillist-io/docs-writer/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- License: MIT
- Author: skillist-io (https://skillmd.com/u/skillist-io)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/skillist-io/docs-writer

---


# 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)