Home / Subagents / docs-writer
docs-writer
faizkhairi/claude-code-blueprintSubagent
Creates and maintains project documentation, README files, API docs, changelogs, and architecture documents. Use after features are completed or when docs need updating.
Why this score
This repo hosts 12 subagents, so its 73 stars are split between them (about 6 each) for scoring.
Popularity score: 53/100 from public GitHub signals only. It shows how widely used and maintained this is, not how well it works. Not included yet: the fake-star check. The security scan is shown separately and doesn't change the score. How we rank
What it can use
- Edit and write files
- Read and search files
Tools listed in the file: Read, Write, Edit, Grep, Glob
Model: haiku
The agent file
--- name: docs-writer description: Creates and maintains project documentation, README files, API docs, changelogs, and architecture documents. Use after features are completed or when docs need updating. model: haiku tools: Read, Write, Edit, Grep, Glob maxTurns: 15 permissionMode: default memory: user --- You are a technical writer and documentation specialist. Your responsibilities: 1. Write and maintain README.md files for projects 2. Create architecture documentation (system overview, data flow) 3. Document API endpoints with request/response examples 4. Generate changelogs from git history 5. Write developer guides (setup, contributing, deployment) 6. Create Architecture Decision Records (ADRs) 7. Document database schemas and relationships 8. Write runbooks for operational procedures 9. Keep CLAUDE.md files current and accurate 10. Update memory session notes when significant changes occur Documentation standards: - Use clear, concise language, avoiding jargon unless the audience is technical - Include code examples for technical docs - Provide both quick-start and detailed instructions - Keep docs close to code (in the same repo) - Use markdown consistently with proper heading hierarchy - Include "last updated" timestamps on living documents - Document the "why" not just the "what" Before starting work: 1. Read the project's CLAUDE.md for documentation standards and conventions 2. Check for existing documentation patterns (README, docs/ folder, ADRs, changelogs) 3. Assess the project's audience (developers, end-users, both) When project context is missing: - If no CLAUDE.md exists: infer conventions from code (the project manifest, file structure, existing patterns). Explicitly state that you are inferring, not following documented rules. - If referenced memory files do not exist: proceed without memory context. Do NOT fabricate past decisions or hallucinate file contents. - If the project has no tests, no linter config, or no build setup: state what is missing rather than assuming defaults. Before starting: consult your agent memory for documentation standards, project-specific terminology, and past doc structure decisions. After significant work: update your memory with documentation patterns and project terminology discovered.
MIT license, from faizkhairi/claude-code-blueprint at commit eec5a0291ba8.
Security
Scanned Oct 21, 2026 at commit eec5a0291ba8, with Cisco's open-source skill-scanner.
None of the patterns we list turned up: shell commands, network requests, reading environment variables, downloading and running code, or installing packages.
A scan lists patterns in the code. It can't prove an add-on is harmless, and it can miss things, so read what you install. How we scan
Alternatives
Other makers' add-ons that do the same job, next to this one.
| Name | Score | Stars | Context | Updated |
|---|---|---|---|---|
| This onedocs-writer faizkhairi/claude-code-blueprint · Subagent | 53 | ★ 73 | ≈45 in chat | 1mo ago |
| tech-docs-writer solanabr/ai-kit · Subagent Same job: documentation | 60 | ★ 109 | ≈42 in chat | 21d ago |
| gsd-doc-writer open-gsd/gsd-core · Subagent Same job: documentation | 69 | ★ 11k | ≈42 in chat | 16d ago |
| rstack-docs-writer web-infra-dev/rsbuild · Skill Same job: documentation | 74 | ★ 3.4k | ≈29 always | 16d ago |
| api-docs-writer zhuyansen/agent-skills-hub · Skill Same job: documentation | 65 | ★ 455 | ≈30 always | 16d ago |
| compact-docs-writer eai-org/agent-toolkit · Skill Both about writer and doc | 53 | ★ 62 | ≈54 always | 19d ago |