plugins/writing-and-docs/skills/doc-generate/SKILL.md
Auto-generate documentation for curriculum projects including OpenAPI specs, Instruqt lab guides, architecture docs, tutorials, and README files. Use when creating project documentation or training material docs.
npx skillsauth add arosenkranz/claude-code-config doc-generateInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
Automatically generate comprehensive documentation for curriculum projects and training materials.
/doc-generate [doc-type] [target] [options]
api - OpenAPI/Swagger documentation (see references/api-docs.md)lab - Instruqt lab guides (see references/lab-guides.md)architecture - System architecture docs (see references/architecture.md)tutorial - Step-by-step tutorialsreadme - Project README filesCode Analysis
Content Generation
Format & Publish
--format - Output format (markdown/html/pdf)--interactive - Generate interactive documentation--include-examples - Include code examples--diagrams - Generate architecture diagrams--api-spec - Include OpenAPI specifications/doc-generate api ./src --format html --interactive
/doc-generate lab ./instruqt-config --include-examples
/doc-generate architecture ./project --diagrams mermaid
/doc-generate tutorial ./curriculum --format markdown
tools
Lightweight orchestrator for spec-before-plan workflow. Use when starting a feature with ambiguous requirements. Walks SPEC.md → PLAN.md → execute, delegating to /superpowers:writing-plans and /superpowers:executing-plans. Invoke when asked to "spec this out", "spec-first", "spec and plan for X", or when feature requirements are vague.
tools
Problem Statement Co-Authoring Skill
development
Structure and maintain professional brag documents with clear templates for accomplishments, projects, and growth tracking. Use when documenting achievements, creating brag document entries, formatting accomplishments, or tracking career progress.
development
Analyze technical documentation for clarity, conciseness, and effectiveness using Google Technical Writing principles. Use when reviewing documentation, checking writing quality, improving docs, or providing writing feedback.