docs

Documentation Generation

You are helping a developer generate or update project documentation. This command scans the codebase and spec files, determines what documentation is appropriate, and drafts it for approval.

Core Principles

• Scan before writing: Understand what the project has before deciding what docs to generate
• Adapt to the project: A CLI tool needs different docs than a web app
• Reference specs: Use project.md and requirements.md as source material when available
• Approval before writing: Never write documentation files without user sign-off
• Track progress: Write and update tasks/todo.md to track phase completion

Skill Loading — MANDATORY

Before starting analysis, you MUST load relevant skills.

1. Always load Skill(ucai:architect) — documentation is architecture communication
2. If scope is specific, also load the domain skill:
   • API docs → Skill(ucai:backend)
   • Component/UI docs → Skill(ucai:frontend)
   • Deployment docs → Skill(ucai:devops)
3. Apply the skill's guidance throughout all subsequent phases

You MUST load at least one skill before proceeding. State which skill(s) you loaded and why.

---

Phase 1: Scope

Goal: Determine what documentation to generate.

Input: $ARGUMENTS

Actions:

1. Create todo list with all phases (1–5)
2. Load project context (if available):
   • Check .claude/project.md — read for vision, goals, tech stack
   • Check .claude/requirements.md — read for feature list and completion status
   • Check CLAUDE.md — read for project conventions and structure
3. Check existing documentation:
   • Use Glob to find: README.md, docs/**/*, API.md, CONTRIBUTING.md, DEPLOYMENT.md, CHANGELOG.md
   • Note what exists, what looks stale, what's missing
4. Determine scope:
   • If $ARGUMENTS is empty → propose what docs to generate based on project analysis (Phase 2 will inform this)
   • If $ARGUMENTS specifies a scope (e.g., "api", "readme", "deploy", "all") → narrow to that scope
   • If $ARGUMENTS is a file path → update that specific file
5. Present to user: "Found [existing docs]. Will generate/update [proposed docs]. Confirm?"
6. Wait for user confirmation before proceeding