doc-workflow

Generate and maintain project documentation across PRD, BRD, ADR, Spec, Sys, and Tasks.

Updated Mar 19, 2026
One-click install
npx skills add https://github.com/sunLeee/optimization --skill doc-workflow-sunleee
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-workflow
Source: https://github.com/sunLeee/optimization/tree/main/.claude/skills/scaffolding/docs/doc-workflow
Command: npx skills add https://github.com/sunLeee/optimization --skill doc-workflow-sunleee

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Composite Skill streamlines the creation and ongoing maintenance of a complete, traceable project documentation set, reducing manual coordination across PRD, BRD, ADR, Spec, System Architecture, and Tasks.

Core Features & Use Cases

  • Generates PRD, BRD, ADR, Spec, Architecture, and Tasks documents and links them for traceability.
  • Produces and embeds diagrams (Use Case, Sequence, Component, Class, Activity, State, ER, Flowchart) as part of the documentation.
  • Supports automated index generation, link validation, and incremental updates to keep documentation in sync with the codebase.

Quick Start

Run /doc-workflow all <feature-name> to generate the complete documentation set for that feature.

Frequently Asked Questions about doc-workflow

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

FAQPage Schema
How do I generate a complete project documentation set from PRD to Tasks?

To generate a complete project documentation set, you can run the doc-workflow command with a feature name to automatically create and link PRD, BRD, ADR, Spec, System Architecture, and Tasks documents for end-to-end traceability.

Can I automatically generate architecture diagrams within my PRD and BRD files?

Yes, you can automatically generate and embed architecture diagrams within your PRD and BRD files. The workflow produces Use Case, Sequence, Component, Class, Activity, State, ER, and Flowchart diagrams as part of the documentation output.

What is the best way to maintain traceability across product and engineering docs?

The best way to maintain traceability across product and engineering docs is using a composite workflow orchestration that cross-references links, validates connections, and generates an automatic index to keep PRD, ADR, and Tasks synchronized.

How do I set up YAML frontmatter to automate project documentation workflows?

You set up project documentation workflows by defining a YAML frontmatter-driven entry that triggers composite workflow orchestration, enabling automatic index generation and incremental updates to keep your docs in sync with the codebase.

Does this documentation workflow support incremental updates for existing features?

Yes, this documentation workflow supports incremental updates for existing features. It applies link validation and automatic index generation to ensure your PRD, Spec, and Architecture documents remain synchronized during ongoing maintenance.

When do I need automated link validation in a composite documentation workflow?

You need automated link validation in a composite documentation workflow when maintaining a large set of cross-referenced PRD, ADR, and Tasks documents to prevent broken links and ensure continuous traceability across the project lifecycle.