docs-writer

# Documentation Writer Skill Create clear, useful documentation for developers. ## MANDATORY: Pre-Documentation Checks **BEFORE writing any documentation, you MUST:** ### 1. Read Existing Documentation ``` README.md (project root) docs/ (existing docs) src/[domain]/@_[domain]-README.md (feature-specific READMEs) ``` ### 2. Check Documentation Patterns Use `Glob` to find existing README files: ``` Glob: "**/*README.md" to find all READMEs Glob: "**/*.md" in docs/ to find documentation patterns ``` ### 3. Verify Code Matches Documentation Read the actual code being documented to ensure accuracy: - Check function signatures match documentation - Verify example code actually works - Confirm database schema matches any data documentation ### 4. Verification Statement (REQUIRED) Before writing docs, state: ``` "Pre-documentation check: - Existing docs read: [list] - Documentation pattern identified: [pattern from existing READMEs] - Code verified: [files read to ensure accuracy]" ``` --- ## README Template ```markdown # Project Name Brief description of what this project does. ## Features - Feature 1 - Feature 2 - Feature 3 ## Quick Start \`\`\`bash # Install npm install # Run npm start \`\`\` ## Installation ### Prerequisites - Node.js >= 18 - npm or pnpm ### Setup \`\`\`bash # Clone repository git clone https://github.com/user/project.git cd project # Install dependencies npm install # Set up environment cp .env.example .env # Edit .env with your values # ...