Skip to content

Documentation Skills

The doc-* family produces human-readable documentation from code, architecture decisions, and API contracts. Three free lanes draft in parallel; a strong model edits for consistency.

Skill IDDescriptionModel Class
doc-generatorGenerates inline documentation: JSDoc/TSDoc, module-level comments, type annotationsfree
doc-readmeGenerates or updates a README.md with consistent structure, badges, and examplesfree
doc-apiProduces an API reference in OpenAPI/Markdown format from route handlers and type signaturesfree
doc-runbookWrites an operational runbook for a service: startup, shutdown, alerts, escalation pathscheap
SituationSkill(s)
Library or module missing JSDocdoc-generator
New service needs a READMEdoc-readme
REST/GraphQL API needs reference docsdoc-api
Handing off a service to opsdoc-runbook
Complete documentation passAll four
  • document — primary consumer; all four skills orchestrated
  • implement — uses doc-generator to add inline docs to generated code
  • review — flags absent documentation as a quality issue
SkillOutput
doc-generatorModified source files with JSDoc/TSDoc added
doc-readmeREADME.md with badges, install, usage, API table, contributing
doc-apidocs/api.md or openapi.yaml
doc-runbookdocs/runbook/<service>.md
Request: "Document the payment service"
doc-api → generates OpenAPI spec for /charge, /refund, /webhook endpoints
doc-runbook → documents startup checklist, Stripe webhook secret rotation, alert thresholds
doc-readme → adds Architecture, Config, API summary, and Deployment sections
doc-generator→ adds @param/@returns to PaymentService methods