Documentation Refactor
BeginnerFree2 minupdated 2026-10-21
Details
name | doc-refactor |
|---|---|
description | Restructure project documentation for clarity and accessibility |
Refactor project documentation structure adapted to project type:
- Analyze project: Identify type (library/API/web app/CLI/microservices), architecture, and user personas
- Centralize docs: Move technical documentation to
docs/with proper cross-references - Root README.md: Streamline as entry point with overview, quickstart, modules/components summary, license, contacts
- Component docs: Add module/package/service-level README files with setup and testing instructions
- Organize
docs/by relevant categories:
- Architecture, API Reference, Database, Design, Troubleshooting, Deployment, Contributing (adapt to project needs)
- Create guides (select applicable):
- User Guide: End-user documentation for applications
- API Documentation: Endpoints, authentication, examples for APIs
- Development Guide: Setup, testing, contribution workflow
- Deployment Guide: Production deployment for services/apps
- Use Mermaid for all diagrams (architecture, flows, schemas)
Keep docs concise, scannable, and contextual to project type.
Last Updated: August 4, 2026
Claude Code Version: 2.1.220
Sources:
- https://code.claude.com/docs/en/commands
Compatible Models: Claude Fable 5, Claude Opus 5, Claude Sonnet 5, Claude Sonnet 4.6, Claude Opus 4.8, Claude Haiku 4.5
Components for this task
We hand-picked the agents, skills and commands that handle this kind of work: Agents and skills for technical documentation.
Open-source community guide (MIT) · curated and maintained by Doutor AI.
Need a tailor-made solution?
Not sure where to start with AI in your business? Get a free assessment and a tailored plan - no commitment.
Save hours every week with AI, no hassle
Doutor AI gives you 1,859 ready-to-copy AI prompts, by industry and in plain English - plus a complete technical library for those who want to go further.