Agent Skillsrsmdt/the-startup › document

document

GitHub

作为文档编排者,协调多个视角的专家代理并行生成、更新和维护代码、API及项目组件的文档。通过检查现有文档避免重复,匹配项目规范,并支持标准或团队模式以高效完成文档任务。

plugins/start/skills/document/SKILL.md rsmdt/the-startup

Trigger Scenarios

需要为代码、API或项目组件生成新文档 需要更新或维护现有文档以确保一致性

Install

npx skills add rsmdt/the-startup --skill document -g -y
More Options

Non-standard path

npx skills add https://github.com/rsmdt/the-startup/tree/main/plugins/start/skills/document -g -y

Use without installing

npx skills use rsmdt/the-startup@document

指定 Agent (Claude Code)

npx skills add rsmdt/the-startup --skill document -a claude-code -g -y

安装 repo 全部 skill

npx skills add rsmdt/the-startup --all -g -y

预览 repo 内 skill

npx skills add rsmdt/the-startup --list

SKILL.md

Frontmatter
{
    "name": "document",
    "description": "Generate and maintain documentation for code, APIs, and project components",
    "argument-hint": "file\/directory path, 'api' for API docs, 'readme' for README, or 'audit' for doc audit",
    "user-invocable": true
}

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

Version History

  • 88d447c Current 2026-08-08 07:57

Same Skill Collection

plugins/start/skills/brainstorm/SKILL.md
plugins/start/skills/constitution/SKILL.md
plugins/start/skills/debug/SKILL.md
plugins/start/skills/implement-direct/SKILL.md
plugins/start/skills/implement-factory/SKILL.md
plugins/start/skills/implement-incremental/SKILL.md
plugins/start/skills/implement/SKILL.md
plugins/start/skills/refactor/SKILL.md
plugins/start/skills/review/SKILL.md
plugins/start/skills/specify-factory/SKILL.md
plugins/start/skills/specify-incremental/SKILL.md
plugins/start/skills/specify-meta/SKILL.md
plugins/start/skills/specify-requirements/SKILL.md
plugins/start/skills/specify-solution/SKILL.md
plugins/start/skills/test/SKILL.md
plugins/start/skills/validate/SKILL.md
plugins/start/skills/writing-skills/SKILL.md
plugins/team/skills/cross-cutting/feature-prioritization/SKILL.md
plugins/team/skills/cross-cutting/pattern-detection/SKILL.md
plugins/team/skills/cross-cutting/project-discovery/SKILL.md
plugins/team/skills/cross-cutting/requirements-elicitation/SKILL.md
plugins/team/skills/design/user-research/SKILL.md
plugins/team/skills/development/agentic-patterns/SKILL.md
plugins/team/skills/development/api-contract-design/SKILL.md
plugins/team/skills/development/architecture-selection/SKILL.md
plugins/team/skills/development/domain-modeling/SKILL.md
plugins/team/skills/development/frontend-patterns/SKILL.md
plugins/team/skills/development/technical-writing/SKILL.md
plugins/team/skills/development/testing/SKILL.md
plugins/team/skills/infrastructure/platform-operations/SKILL.md
plugins/team/skills/quality/code-quality-review/SKILL.md
plugins/team/skills/quality/performance-analysis/SKILL.md
plugins/team/skills/quality/security-assessment/SKILL.md
plugins/start/skills/analyze/SKILL.md

Metadata

Files
0
Version
88d447c
Hash
9237a2e3
Indexed
2026-08-08 07:57

Accueil - Wiki
Copyright © 2011-2026 iteam. Current version is 2.155.2. UTC+08:00, 2026-08-09 00:00
浙ICP备14020137号-1 $Carte des visiteurs$