Generate Comprehensive Project Documentation
8-phase documentation workflow bundle orchestrating API, architecture, code, README, wiki, and changelog sub-skills across a project.
Why it matters
Automate the creation of all project documentation, from API references and architecture diagrams to READMEs and wikis, ensuring consistency and completeness across your codebase.
Outcomes
What it gets done
Generate API documentation and OpenAPI specifications.
Create C4 and Mermaid architecture diagrams.
Produce code comments, JSDoc/TSDoc, and usage examples.
Write README files, getting started guides, and tutorials.
Install
Add it to your toolbox
Run in your project directory:
curl -fsSL https://spark.entire.vc/get/ag-documentation | bash Overview
Documentation Workflow Bundle
An 8-phase documentation workflow bundle orchestrating named sub-skills for planning, API docs, C4 architecture diagrams, code comments, README, wiki, changelog, and maintenance. Use when documenting a whole project across multiple types, not for a single isolated documentation artifact.
What it does
An 8-phase orchestration bundle that sequences a large set of named documentation sub-skills into a complete documentation workflow. Phase 1 (Planning) invokes docs-architect and documentation-templates to choose tools and structure. Phase 2 (API Documentation) invokes api-documenter, api-documentation-generator, and openapi-spec-generation to extract endpoints, generate OpenAPI specs, and build a reference with usage examples. Phase 3 (Architecture Documentation) invokes the C4 model skills (c4-architecture, c4-context, c4-container, c4-component, c4-code) plus mermaid-expert to produce context, container, component, and code diagrams, sequence diagrams, and data-flow docs. Phase 4 (Code Documentation) invokes code-documentation-code-explain and doc-generate skills to extract comments and generate JSDoc/TSDoc and type documentation. Phase 5 (README and Getting Started) invokes readme, environment-setup-guide, and tutorial-engineer to produce a README, setup guide, and troubleshooting content. Phase 6 (Wiki and Knowledge Base) invokes wiki-architect, wiki-page-writer, wiki-onboarding, wiki-qa, wiki-researcher, and wiki-vitepress to design and populate a wiki, including a VitePress-based site. Phase 7 (Changelog and Release Notes) invokes changelog-automation and wiki-changelog to turn commit history into categorized changelogs and release notes. Phase 8 (Documentation Maintenance) invokes doc-coauthoring and reference-builder to review, update, and fix outdated or broken documentation. Each phase ships copy-paste @skill-name prompts to trigger the relevant sub-skill directly.
When to use - and when NOT to
Use when standing up or overhauling documentation across an entire project - API reference, architecture diagrams, code comments, README, wiki, and changelog - rather than one document in isolation. If only a single artifact is needed, such as just a README or just an OpenAPI spec, invoke that named sub-skill directly instead of running the full 8-phase bundle. It's paired with sibling workflow bundles - development for the underlying build workflow, testing-qa for documentation testing, and ai-ml for AI-specific documentation - so route there if the actual need is development or testing rather than docs.
Inputs and outputs
Input is a codebase plus a choice of which phases apply to the current documentation gap. Output spans five documentation types: code-level (JSDoc/TSDoc, type definitions, example code), API documentation (endpoint reference, request/response schemas, auth guides, SDK docs), architecture documentation (system overview, component and data-flow diagrams, deployment architecture), user documentation (getting-started guides, manuals, tutorials, FAQs), and process documentation (runbooks, onboarding guides, SOPs, decision records). A six-item quality gate checks that all APIs are documented, architecture diagrams are current, the README is up to date, code comments are helpful, examples work, and links are valid.
Integrations
Orchestrates a large roster of named sub-skills: docs-architect, api-documenter, openapi-spec-generation, the C4 diagram family, mermaid-expert, readme, tutorial-engineer, the wiki-* family (architect, page-writer, onboarding, qa, researcher, vitepress), changelog-automation, and doc-coauthoring.
Who it's for
Teams doing a full documentation pass on a project - onboarding a new codebase, prepping for external API consumers, or standing up a wiki - who want a phased checklist and the exact sub-skill to invoke at each step, rather than assembling documentation tooling from scratch.
FAQ
Common questions
Discussion
Questions & comments ยท 0
Sign In Sign in to leave a comment.