Skip to main content
ClaudeWave
EN, English
Skill570 repo starsupdated 2mo ago

document

The document skill generates and maintains comprehensive documentation by orchestrating parallel documentation specialists across multiple perspectives such as Code, API, README, and Audit. Use it when code, APIs, or project components need initial documentation created or existing documentation updated to match current implementation and project conventions.

Install in Claude Code
Copy
git clone --depth 1 https://github.com/rsmdt/the-startup /tmp/document && cp -r /tmp/document/plugins/start/skills/document ~/.claude/skills/document
Then start a new Claude Code session; the skill loads automatically.

SKILL.md

## Persona

Act as a documentation orchestrator that coordinates parallel documentation generation across multiple perspectives.

**Documentation Target**: $ARGUMENTS

## Interface

DocChange {
  file: string             // path to documented file
  action: string           // Created | Updated | Added JSDoc
  coverage: string         // what was documented (e.g., "15 functions", "8 endpoints")
}

State {
  target = $ARGUMENTS
  perspectives = []        // from reference/perspectives.md
  mode: Standard | Agent Team
  existingDocs = []
  changes: DocChange[]
}

## Constraints

**Always:**
- Delegate all documentation tasks to specialist agents.
- Launch applicable documentation perspectives simultaneously in a single response.
- Check for existing documentation first — update rather than duplicate.
- Match project documentation style and conventions.
- Link to actual file paths and line numbers.

**Never:**
- Write documentation yourself — always delegate to specialist agents.
- Create duplicate documentation when existing docs can be updated.
- Generate docs without checking existing documentation first.

## Reference Materials

- reference/perspectives.md — documentation perspectives, target mapping, documentation standards
- reference/output-format.md — next-step options, coverage guidelines
- reference/knowledge-capture.md — naming conventions, update-vs-create matrix, cross-referencing
- examples/output-example.md — concrete example of expected output format

Templates in `templates/` for knowledge capture:
- `pattern-template.md` — Technical patterns
- `interface-template.md` — External integrations
- `domain-template.md` — Business rules

## Workflow

### 1. Analyze Scope

Read reference/perspectives.md. Select perspectives based on target:

match (target) {
  file | directory => [Code]
  "api"            => [API, Code]
  "readme"         => [README]
  "audit"          => [Audit]
  "capture"        => [Capture]
  empty | "all"    => all applicable perspectives
}

Scan target for existing documentation. Identify gaps and stale docs.

AskUserQuestion: Generate all | Focus on gaps | Update stale | Show analysis

### 2. Select Mode

AskUserQuestion:
  Standard (default) — parallel fire-and-forget subagents
  Agent Team — persistent teammates with shared task list and coordination

Recommend Agent Team when target is "all" or "audit", perspectives >= 3, or large codebase.

### 3. Launch Documentation

match (mode) {
  Standard => launch parallel subagents per applicable perspectives
  Agent Team => create team, spawn one documenter per perspective, assign tasks
}

For the Capture perspective: use templates/ for consistent formatting and Read reference/knowledge-capture.md for categorization protocol.

### 4. Synthesize Results

Process results:
1. Merge with existing docs — update, don't duplicate.
2. Check consistency for style alignment.
3. Resolve conflicts between perspectives.
4. Apply changes.

### 5. Present Summary

Read reference/output-format.md and format summary accordingly.

AskUserQuestion: Address remaining gaps | Review stale docs | Done
agentic-patternsSkill

Context enrichment for agentic AI application development using LangChain, Vercel AI SDK, and assistant-ui. Use when building AI agents, chat interfaces, tool-calling pipelines, RAG systems, or multi-step AI workflows.

analyzeSkill

Deep-dive codebase analysis that explains how things actually work — business rules, architecture patterns, auth flows, data models, integrations, and performance hotspots. Use whenever the user asks "how does X work", "map the Y flow", "what are the business rules for Z", "trace the auth path", "explore the codebase for patterns", "find all [domain concept]", or needs mechanism-level understanding before making a change. Produces What/How/Why findings with file:line evidence, cross-cutting connections, and clean-solution recommendations first.

api-contract-designSkill

REST and GraphQL API design patterns, OpenAPI/Swagger specifications, versioning strategies, and authentication patterns. Use when designing APIs, reviewing API contracts, evaluating API technologies, or implementing API endpoints.

architecture-selectionSkill

System architecture patterns including monolith, microservices, event-driven, and serverless, with C4 modeling, scalability strategies, and technology selection criteria. Use when designing system architectures, evaluating patterns, or planning scalability.

brainstormSkill

You MUST use this before any creative work — creating features, building components, adding functionality, or modifying behavior. Explores user intent, requirements, and design before implementation.

code-quality-reviewSkill

Unified code review skill for correctness, design, readability, security, performance, testability, accessibility, and error-handling conventions. Use when reviewing changes, enforcing quality standards, or identifying technical debt.

constitutionSkill

Create or update a project constitution with governance rules. Uses discovery-based approach to generate project-specific rules.

debugSkill

Systematically diagnose and resolve bugs through conversational investigation and root cause analysis