document

📁 rsmdt/the-startup 📅 11 days ago
14
总安装量
14
周安装量
#23392
全站排名
安装命令
npx skills add https://github.com/rsmdt/the-startup --skill document

Agent 安装分布

opencode 14
gemini-cli 14
github-copilot 14
codex 14
cursor 14
claude-code 12

Skill 文档

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”) }

fn analyzeScope(target) fn selectMode() fn launchDocumentation(mode) fn synthesize(results) fn presentSummary(changes)

Constraints

Constraints { require { Delegate all documentation tasks to specialist agents via Task tool. 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. } }

State

State { target = $ARGUMENTS perspectives = [] // determined by analyzeScope per reference/perspectives.md mode: Standard | Team // chosen by user in selectMode existingDocs = [] // found during analyzeScope changes: [DocChange] // collected from agents }

Reference Materials

See reference/ directory for detailed methodology:

  • Perspectives — Documentation perspectives, target mapping, documentation standards
  • Output Format — Next-step options, coverage guidelines
  • Output Example — Concrete example of expected output format
  • Knowledge Capture — Naming conventions, update-vs-create matrix, cross-referencing

Templates in templates/ for knowledge capture:

  • pattern-template.md — Technical patterns
  • interface-template.md — External integrations
  • domain-template.md — Business rules

Workflow

fn analyzeScope(target) { // Select perspectives per reference/perspectives.md target mapping 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 }

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

Recommend Team Mode when: target is “all” | “audit” | perspectives >= 3 | large codebase }

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

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

fn synthesize(results) { results |> mergeWithExisting(update, don’t duplicate) |> checkConsistency(style alignment) |> resolveConflicts(between perspectives) |> applyChanges }

fn presentSummary(changes) { Format summary per reference/output-format.md. AskUserQuestion: Address remaining gaps | Review stale docs | Done }

document(target) { analyzeScope(target) |> selectMode |> launchDocumentation |> synthesize |> presentSummary }