Files
claude-howto/01-slash-commands/doc-refactor.md
T
Luong NGUYEN b9a973bf32 docs: accuracy pass against Claude Code v2.1.220 (#155)
Internal accuracy pass against v2.1.220 — no missing upstream features, but broken example code, disagreeing counts, and metadata drift.

Functional fixes: pre-commit.sh now exits 2 so it actually blocks; dependency-check.sh reads file_path from stdin JSON instead of $1; database-mcp.json uses ${DATABASE_URL}; broken fences repaired; three command templates had invalid skill names.

Factual corrections: /fork and /subtask unswapped and /subtask added; /fewer-permission-prompts; permissions.defaultMode; dontAsk/auto unreversed; 31 hook events verified name-by-name; subagent depth 3; skill precedence enterprise > project > personal; /output-style removed not deprecated; permissionDecision gained defer.

Follow-up review fixed defects the pass left behind: zh/vi headers claiming 31 events above 25-name lists, a surviving hardcoded DB credential in the MCP README examples, an unbalanced fence swallowing a metadata footer, and non-canonical tool names. All four translated CATALOG summary tables were recounted so their arithmetic holds.

Full detail in CHANGELOG.md under v2.1.220-r2.
2026-08-04 15:41:12 +07:00

1.4 KiB

name, description
name description
doc-refactor Restructure project documentation for clarity and accessibility

Documentation Refactor

Refactor project documentation structure adapted to project type:

  1. Analyze project: Identify type (library/API/web app/CLI/microservices), architecture, and user personas
  2. Centralize docs: Move technical documentation to docs/ with proper cross-references
  3. Root README.md: Streamline as entry point with overview, quickstart, modules/components summary, license, contacts
  4. Component docs: Add module/package/service-level README files with setup and testing instructions
  5. Organize docs/ by relevant categories:
    • Architecture, API Reference, Database, Design, Troubleshooting, Deployment, Contributing (adapt to project needs)
  6. 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
  7. 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: