Skip to content
cccskills
FreePublished on GitHub

document

Generate and maintain documentation for code, APIs, and project components

The English summary is being prepared. Showing the original description.

rsmdt/the-startup575 stars(GitHub 575 + cccskills 0)

Run score Not tested

See how to install

Files included (13)

  • SKILL.md4.2 KB
  • evals/evals.json1.6 KB
  • evals/files/services-with-stale-doc/docs/services/payment-service.md445 B
  • evals/files/services-with-stale-doc/src/services/notification-service.ts590 B
  • evals/files/services-with-stale-doc/src/services/payment-service.ts848 B
  • evals/files/services-with-stale-doc/src/services/user-service.ts606 B
  • examples/output-example.md659 B
  • reference/knowledge-capture.md10.7 KB
  • reference/output-format.md263 B
  • reference/perspectives.md1.8 KB
  • templates/domain-template.md6.2 KB
  • templates/interface-template.md4.7 KB
  • templates/pattern-template.md2.7 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

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 | Dynamic Workflow existingDocs = [] changes: DocChange[] }

Constraints

Always:

  • 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.

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.

Ask the user to choose: Generate all | Focus on gaps | Update stale | Show analysis

2. Select Mode

Ask the user to choose: Standard (default) — parallel fire-and-forget subagents Agent Team — persistent teammates with shared task list and coordination Dynamic Workflow — one inline workflow script fans out the documenters and collects their changes

Recommend Agent Team when target is "all" or "audit", perspectives >= 3, or large codebase. Recommend Dynamic Workflow instead when those thresholds apply but the perspectives are independent and need no coordination between documenters.

3. Launch Documentation

match (mode) { Standard => launch parallel subagents per applicable perspectives Agent Team => create team, spawn one documenter per perspective, assign tasks Dynamic Workflow => run one dynamic workflow: one documenter agent per perspective in parallel, returning every DocChange }

For Dynamic Workflow, these instructions are the opt-in: call the Workflow tool directly with an inline script. Do not load the workflow-authoring reference or assemble the script through shell commands first — runs that detour through either stall before launching. Choose model and effort per stage from what the stage does. Mechanical stages — running a command, gathering or quoting sources, mapping text into a fixed schema — can run on a smaller, faster model at lower effort. Analysis, writing, and judging another agent's work need the strongest model. A judging stage never runs on a weaker model than the stage it judges. When unsure, omit model so the stage inherits the session model.

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.

Ask the user to choose: Address remaining gaps | Review stale docs | Done

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

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.

The English summary is being prepared. Showing the original description.

rsmdt/the-startup575Updated Oct 25, 2026

Deep-research analysis of a codebase, a topic, or both. Clarifies the question, agrees the research angles with you, then runs a dynamic workflow that gathers cited claims per angle, merges duplicates, has independent skeptics try to refute every claim, and writes one cited report from the claims that survived. Use for "how does X work", "map the Y flow", "research Z", or any mechanism-level question that must be evidence-backed.

The English summary is being prepared. Showing the original description.

rsmdt/the-startup575Updated Oct 25, 2026

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.

The English summary is being prepared. Showing the original description.

rsmdt/the-startup575Updated Oct 25, 2026

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.

The English summary is being prepared. Showing the original description.

rsmdt/the-startup575Updated Oct 25, 2026

Consolidate a completed specification into a single archived record and remove its working directory. Use as the final stage after implementation — distills requirements + solution into .start/archive/[NNN]-[name].md and deletes the .start/specs/[NNN]-[name]/ directory.

The English summary is being prepared. Showing the original description.

rsmdt/the-startup575Updated Oct 25, 2026

Required first step before any creative work — creating features, building components, adding functionality, or modifying behavior. Explores user intent, requirements, and design before implementation.

The English summary is being prepared. Showing the original description.

rsmdt/the-startup575Updated Oct 25, 2026

See all skills by rsmdt

Report a problem with this skill