Workflow Documentation Audit Report
> Conducted: 2026-02-02 > Scope: Workflow commands, command docs, guides, YAML definitions, and cross-references > Method: Full read of all files in scope, cross-referencing YAML definitions against docs
Overview
Workflow Documentation Audit Report
Conducted: 2026-02-02 Scope: Workflow commands, command docs, guides, YAML definitions, and cross-references Method: Full read of all files in scope, cross-referencing YAML definitions against docs
Executive Summary
The workflow documentation is unusually thorough for a project of this size. The WORKFLOW_COMMANDS.md file is a well-structured 876-line reference with mermaid diagrams, input/output tables, and checkpoint documentation. The docs/workflow/ directory provides a clean separation between phase overviews and per-command descriptions, and the YAML definitions are consistent and well-typed.
However, the documentation has grown organically across three layers (README, WORKFLOW_COMMANDS.md, and docs/workflow/) without clear delineation of audience or purpose. This creates significant redundancy, a confusing entry path for new users, and several structural mismatches between what the YAML definitions declare and what the docs describe.
This report documents all findings, organizes them by area, and proposes a restructuring plan for migration to Astro + Starlight.
1. Per-Area Findings
1.1 docs/WORKFLOW_COMMANDS.md
Strengths:
- Comprehensive: covers all four phases with mermaid diagrams, command signatures, process steps, output sections, and publish locations.
- The Document Flow Summary table (lines 87-97) is an excellent quick-reference artifact.
- Checkpoint documentation (lines 740-812) is thorough and includes realistic examples with response types.
- Workflow Variations section (lines 816-838) clearly communicates the three main paths through the system.
Weaknesses:
- Drift from YAML manifest. The document describes four phases (Discovery, Planning, Execution, Retrospectives) and nine commands. The YAML manifest defines five phases (Intake, Discovery, Planning, Execution, Retrospective) and twelve commands plus one utility. The entire Intake phase (3 commands) is absent from
WORKFLOW_COMMANDS.md. - Naming inconsistencies. The document uses old command names (
create-epic-discovery,synthesize-discovery,approve-synthesis,create-epic-plan,create-implementation-plan) while the YAML manifest uses shorter identifiers (discovery:create,discovery:synthesize,discovery:approve,planning:epic-plan,planning:impl-plan). A reader switching between the two sources will be confused about which name to use. complete-sprintis documented but absent from the manifest.WORKFLOW_COMMANDS.mddescribescomplete-sprintas a command (lines 632-673). The manifest's retrospective phase lists onlyretrospectives:complete-epic. There is acommands/project/retrospectives/complete-sprint.mdimplementation file but no.yamldefinition file for it. This is either a manifest omission or the command was removed without updating the docs.- Common Ground absent. The manifest includes
common-groundas a utility command.WORKFLOW_COMMANDS.mddoes not mention it at all, despite its relevance to the workflow (it can be invoked at any point). - Monolithic structure. At 876 lines, the file tries to be both a conceptual introduction and a complete reference. The mermaid diagrams and process descriptions serve a "getting started" reader, while the checkpoint tables and integration points serve a "deep reference" reader. These audiences need different documents.
Recommendations:
- Add the Intake phase to
WORKFLOW_COMMANDS.mdor explicitly state it is a pre-workflow phase documented elsewhere. - Resolve the command naming inconsistency: pick one canonical form (the YAML
commandidentifier) and use it consistently, with aliases noted parenthetically. - Either add
complete-sprintto the manifest YAML (with a.yamldefinition file) or remove it fromWORKFLOW_COMMANDS.md. - Add a brief mention of
common-groundas a utility command available during any phase. - For the Astro site, split this into a conceptual overview page and individual command reference pages.
1.2 docs/workflow/*.md (Phase Overviews and Command Descriptions)
Strengths:
- Clean, consistent structure across all 18 files. Every phase overview has Purpose, Commands table, Outputs, Prerequisites, and Next Steps. Every command description has Overview, Inputs table, Outputs table, Prerequisites, and Next Steps.
- Inputs and outputs match the YAML definitions exactly in all files reviewed. This is strong evidence of either co-generation or disciplined manual maintenance.
- Next Steps sections create a navigable chain: each doc tells you where to go next, forming a complete user journey.
- Status badges (
**Status:** Planned) on intake commands clearly communicate availability.
Weaknesses:
- No common-ground phase overview. There is a
docs/workflow/common-ground.mdcommand description, but no phase overview that contextualizes it. The manifest lists it underutilities:, not under a phase. The doc structure treats it as though it belongs to a phase. - No
complete-sprintdescription. There is nodocs/workflow/retrospective-complete-sprint.md. The retrospective phase overview mentions onlycomplete-epic. Ifcomplete-sprintis a valid command, it needs a description doc. - Phase names are inconsistent. The manifest uses
retrospective(singular).WORKFLOW_COMMANDS.mdusesRetrospectives(plural). The phase overview file isretrospective-phase.md(singular). The command prefix in the manifest isretrospectives:complete-epic(plural). This inconsistency will cause confusion in code, docs, and URL generation. - Relative links may break in a docs site context. All Next Steps links use relative paths like
[Planning Phase](planning-phase.md). These work within thedocs/workflow/directory but will need transformation for a docs site with different URL structures.
Recommendations:
- Decide whether
complete-sprintexists in the system. If yes, createdocs/workflow/retrospective-complete-sprint.mdand add it to the manifest. If no, remove all references. - Standardize singular vs. plural: the manifest phase name, the YAML command prefix, the docs directory name, and the file naming convention should all agree.
- Treat
common-groundas a standalone utility in the docs structure (not shoehorned into a phase pattern).
1.3 docs/COMMON_GROUND.md
Strengths:
- Exceptionally well-written conceptual documentation. The Background & Motivation section (lines 16-41) provides genuine insight into the design rationale.
- The two-phase flow diagram (lines 69-88) clearly illustrates the interactive process.
- The confidence tiers (ESTABLISHED, WORKING, OPEN) are well-defined with practical examples and behavior descriptions.
- The use cases section (lines 328-372) maps real scenarios to specific command flags.
Weaknesses:
- Typo on line 176. "groundin file" should be "grounding file."
- Overlap with README. The README (lines 182-227) duplicates the confidence tier explanation and the
--graphmermaid example. When this content moves to a docs site, the README version should be a brief pointer. - No link to the workflow docs. The Related Documentation section links to
WORKFLOW_COMMANDS.mdandATLASSIAN_MCP_SETUP.md, but does not link to thedocs/workflow/common-ground.mdcommand description or the YAML definition. A reader in the workflow mindset has no bridge from here to the workflow system. - No link FROM workflow docs.
WORKFLOW_COMMANDS.mddoes not mention or link toCOMMON_GROUND.mdat all. The two documentation trees are disconnected.
Recommendations:
- Fix the "groundin file" typo.
- Add a link to
docs/workflow/common-ground.mdin the Related Documentation section. - Add a link to
docs/COMMON_GROUND.mdfrom withinWORKFLOW_COMMANDS.md(perhaps in a "Utility Commands" section). - For the Astro site, deduplicate the README and
COMMON_GROUND.mdversions of the confidence tier explanation.
1.4 docs/ATLASSIAN_MCP_SETUP.md
Strengths:
- Excellent task-oriented structure. A user can follow from top to bottom and end up with a working setup.
- Covers both Cloud and Server/Data Center configurations.
- The Quick Start Checklist (lines 453-461) is a useful verification artifact.
- Security considerations are thorough: credential protection, read-only mode, space/project filtering, audit trail, and token revocation.
- Environment variable reference tables (lines 421-449) serve as a quick lookup.
Weaknesses:
- Only linked from README and COMMON_GROUND.md.
WORKFLOW_COMMANDS.mddoes not link to this guide despite requiring Atlassian integration for all non-intake commands. A user reading the workflow docs and encountering Jira/Confluence references has no pointer to setup instructions. - Docker-only approach. The guide assumes Docker. If a user cannot or does not want to run Docker, there is no alternative path (e.g.,
npxorpipinstallation of the MCP server). - No version pinning guidance. The guide uses
:latestfor the Docker image. For production workflows, this is risky. A note about pinning to a specific version would be prudent.
Recommendations:
- Add a link to
ATLASSIAN_MCP_SETUP.mdfrom the Integration Points section ofWORKFLOW_COMMANDS.md. - Add a note about version pinning for the Docker image.
- Mention alternatives to Docker if available, or explicitly state Docker is required.
1.5 docs/local_skill_development.md
Strengths:
- Solves a real problem clearly: how to test skill changes without releasing.
- The symlink workflow is well-explained with exact commands.
- Caveats section (lines 96-113) proactively addresses the most likely failure modes.
- Quick Reference section (lines 132-149) provides copy-paste commands.
Weaknesses:
- Orphaned document. No other document in the project links to this file. It is not referenced from README.md, CONTRIBUTING.md, or any guide. A contributor who needs it will not find it through navigation.
- No mention of the workflow system. The guide covers skill development but says nothing about developing or testing workflow commands. Given that commands have a parallel structure (YAML definitions, description docs, implementation
.mdfiles), a contributor working on workflow commands has no equivalent guide. - Placeholder paths. The guide uses
<plugin>,<name>,<version>as placeholders without providing a concrete example of what these look like for the claude-skills project specifically.
Recommendations:
- Link this file from CONTRIBUTING.md and README.md (Documentation section).
- Add a section or separate document for workflow command development.
- Include one concrete example with actual claude-skills paths alongside the generic placeholders.
1.6 commands/workflow-manifest.yaml
Strengths:
- Clean DAG structure with typed dependency strengths (
requiredvs.recommended). optional: trueon discovery phase correctly models the skippable nature of that phase.external_skillsreference tofeature-forgedocuments the cross-cutting dependency.run_once: trueon intake correctly distinguishes project-level from epic-level phases.
Weaknesses:
- Missing
complete-sprint. The retrospective phase lists onlyretrospectives:complete-epic. Thecomplete-sprintcommand exists as an implementation.mdfile but has no YAML definition and no manifest entry. This is the single largest manifest/docs mismatch. - No YAML definition files for intake commands exist as
.mdimplementation files. The YAMLpathfields point tocommands/intake/document-codebase.md,commands/intake/capture-behavior.md, andcommands/intake/create-system-description.md. None of these files exist on disk. The YAMLstatus: plannedfield signals this is expected, but the schema documentation says "Must resolve to an existing file when status: existing" -- so theplannedstatus makes this valid. However, the schema doc does not explicitly state thatplannedstatus exempts the path resolution rule. - Phase name mismatch. The manifest uses
retrospective(singular) but the command identifiers useretrospectives:(plural).
Recommendations:
- Resolve the
complete-sprintquestion: add it to the manifest or remove the orphaned.mdfile. - Make the planned-status path exemption explicit in the schema documentation.
- Align the phase name and command prefix (both singular or both plural).
1.7 Command YAML Definitions (Sample of 6)
Strengths:
- 100% schema compliance across all 12 files reviewed. Every file has
command,phase(where applicable),path,description,inputs,outputs,requires,status,argument-hint, andrepeat. - Input/output types are consistent and match the schema's allowed values.
- The
descriptionfield correctly points to the correspondingdocs/workflow/*.mdfile in every case. requiresfields accurately distinguish commands needing ticketing/documentation backends from those that do not.
Weaknesses:
- Intake commands point to non-existent implementation files.
commands/intake/document-codebase.yamlhaspath: commands/intake/document-codebase.mdbut this file does not exist. Same for the other two intake commands. Thestatus: plannedfield explains this, but a CI validation step should catch it. common-ground.yamlhas nophasefield. This is correct per the schema (utilities omitphase), but is inconsistent with the schema documentation which listsphaseas required. The schema doc should explicitly state thatphaseis omitted for utility commands.
Recommendations:
- Add a CI validation that verifies
pathfiles exist whenstatus: existing. - Clarify in the schema documentation that
phaseis omitted for utility commands.
2. Workflow Documentation Gap Analysis
Commands Documented vs. Commands in YAML
| Command | YAML Def | Manifest | WORKFLOW_COMMANDS.md | docs/workflow/ desc | Implementation .md |
|---|---|---|---|---|---|
intake:document-codebase | Yes | Yes | NO | Yes | NO (planned) |
intake:capture-behavior | Yes | Yes | NO | Yes | NO (planned) |
intake:create-system-description | Yes | Yes | NO | Yes | NO (planned) |
discovery:create | Yes | Yes | Yes | Yes | Yes |
discovery:synthesize | Yes | Yes | Yes | Yes | Yes |
discovery:approve | Yes | Yes | Yes | Yes | Yes |
planning:epic-plan | Yes | Yes | Yes | Yes | Yes |
planning:impl-plan | Yes | Yes | Yes | Yes | Yes |
execution:execute-ticket | Yes | Yes | Yes | Yes | Yes |
execution:complete-ticket | Yes | Yes | Yes | Yes | Yes |
retrospectives:complete-epic | Yes | Yes | Yes | Yes | Yes |
| `retrospectives:complet |