project-documentation-workflow

Generates project documentation via wave-based multi-agent task decomposition and topological scheduling.

2.1k|165|Updated Sep 7, 2025
One-click install
npx skills add https://github.com/catlog22/Claude-Code-Workflow --skill project-documentation-workflow
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: project-documentation-workflow
Source: https://github.com/catlog22/Claude-Code-Workflow/tree/main/.codex/skills/project-documentation-workflow
Command: npx skills add https://github.com/catlog22/Claude-Code-Workflow --skill project-documentation-workflow

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Writing comprehensive documentation for an entire codebase is slow and inconsistent when done manually, and single-pass AI generation often misses architecture, theory, API, and usage details. This Skill analyzes a project, dynamically decomposes documentation work into dependent tasks, and executes them in parallel waves of agents that share discoveries.

Core Features & Use Cases

  • Dynamic Task Decomposition: Scans project type, scale, languages, and modules to generate 5-25 documentation tasks (overview, architecture, implementation, theory, API, usage, synthesis) with dependencies.
  • Wave-Based Parallel Execution: Computes execution waves via topological sort (Kahn's algorithm) and spawns concurrent agents per wave with configurable concurrency limits.
  • Cross-Agent Context Sharing: Propagates findings through wave summaries, a shared discoveries.ndjson board, and per-task prev_context injection so later documents build on earlier results.
  • Use Case: Point it at a scientific computing codebase to produce a full docs suite including LaTeX-formatted theoretical foundations, architecture diagrams, API references, and a navigable index.

Quick Start

Ask the AI to run the project-documentation-workflow skill to generate complete documentation for your project directory, optionally with -y for auto mode and -c to set agent concurrency.

Frequently Asked Questions about project-documentation-workflow

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate documentation for an entire codebase automatically?

Run the workflow with a project path or description, and it analyzes the project structure, generates documentation tasks, and executes them in parallel agent waves. Output lands in .workflow/.csv-wave/{session-id}/docs/ with an index.md navigation page.

How does wave-based parallel documentation generation work?

Tasks declare dependencies, and a topological sort (Kahn's algorithm) groups them into waves. Each wave runs agents concurrently via spawn_agents_on_csv, then a wave summary is synthesized and injected as context into the next wave.

Can I resume an interrupted documentation generation session?

Yes, pass the --continue flag with the session ID to resume an existing session. Task state is tracked in tasks.csv with pending, completed, failed, and skipped statuses, so finished work is not repeated.

Does it support LaTeX formulas for scientific project documentation?

Yes, tasks with formula_support=true generate LaTeX-formatted mathematical content using $$...$$ display math blocks. This is intended for numerical and scientific projects needing theoretical foundations documentation.

How many documentation tasks does it create for a project?

Task count adapts to project scale: 5-8 tasks for small projects under 20 files, 10-15 for medium projects, and 15-25 for large projects over 100 files. Document types are selected based on project type such as library, application, service, or CLI tool.

What happens when a documentation task fails in a wave?

Dependent tasks are automatically marked as skipped with an error message identifying the failed dependency. The workflow continues executing remaining waves and reports completed, failed, and skipped counts in the final summary.