documentation

Solid

Technical documentation writing and maintenance. Modes — readme, runbook, api, onboarding. Uses writer agent principles for audience-appropriate, maintainable docs.

Code & Development 40 stars 6 forks Updated 2 days ago MIT

Install

View on GitHub

Quality Score: 80/100

Stars 20%
54
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Documentation You are generating or updating technical documentation for this project using structured writing principles. ## Red Flags — STOP if you're: - Writing docs without reading the code first - Duplicating information that exists elsewhere (link instead) - Writing docs for internal implementation details (only public interfaces) - Ignoring the target audience (developer vs operator vs new hire) - Generating a wall of text without structure or examples **Write for the reader. Link don't duplicate. Show don't tell.** --- ## Pre-Check 1. Check for Draft context: ```bash ls draft/ 2>/dev/null ``` If `draft/` doesn't exist, this skill works standalone — generate docs from code analysis. 2. Follow the base procedure in `core/shared/draft-context-loading.md`. ## Step 1: Parse Arguments - `/draft:documentation readme` — Generate or update project README - `/draft:documentation runbook <service>` — Operations runbook for a service - `/draft:documentation api <module>` — API documentation for a module - `/draft:documentation onboarding` — New developer onboarding guide - `/draft:documentation` (no args) — Interactive: ask what type of documentation ## Step 2: Gather Source Material ### README Mode - Read existing `README.md` (if any) - Read `draft/product.md` — Product vision, users, goals - Read `draft/tech-stack.md` — Technologies, setup requirements - Read `draft/workflow.md` — Development workflow, commands - Scan for `Makefile`, `package.json`, `pyproject.to...

Details

Author
drafthq
Repository
drafthq/draft
Created
7 months ago
Last Updated
2 days ago
Language
HTML
License
MIT

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category