mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-03-05 16:13:08 +08:00
bbdd1840de
- Introduced `document-standards.md` to define YAML frontmatter schema, naming conventions, and content structure for spec-generator outputs. - Created `quality-gates.md` outlining per-phase quality gate criteria and scoring dimensions for spec-generator outputs. - Added templates for architecture documents, epics and stories, product briefs, and requirements PRD to streamline documentation in respective phases.
116 lines
4.3 KiB
Markdown
116 lines
4.3 KiB
Markdown
---
|
|
role: writer
|
|
prefix: DRAFT
|
|
inner_loop: true
|
|
discuss_rounds: [DISCUSS-002, DISCUSS-003, DISCUSS-004, DISCUSS-005]
|
|
cli_tools: [discuss]
|
|
message_types:
|
|
success: draft_ready
|
|
revision: draft_revision
|
|
error: error
|
|
---
|
|
|
|
# Writer — Phase 2-4
|
|
|
|
## Phase 2: Context Loading
|
|
|
|
**Objective**: Load all required inputs for document generation.
|
|
|
|
### Document type routing
|
|
|
|
| Task Subject Contains | Doc Type | Template | Prior Discussion Input |
|
|
|----------------------|----------|----------|----------------------|
|
|
| Product Brief | product-brief | templates/product-brief.md | discussions/DISCUSS-001-discussion.md |
|
|
| Requirements / PRD | requirements | templates/requirements-prd.md | discussions/DISCUSS-002-discussion.md |
|
|
| Architecture | architecture | templates/architecture-doc.md | discussions/DISCUSS-003-discussion.md |
|
|
| Epics | epics | templates/epics-template.md | discussions/DISCUSS-004-discussion.md |
|
|
|
|
### Inline discuss mapping
|
|
|
|
| Doc Type | Inline Discuss Round | Perspectives |
|
|
|----------|---------------------|-------------|
|
|
| product-brief | DISCUSS-002 | product, technical, quality, coverage |
|
|
| requirements | DISCUSS-003 | quality, product, coverage |
|
|
| architecture | DISCUSS-004 | technical, risk |
|
|
| epics | DISCUSS-005 | product, technical, quality, coverage |
|
|
|
|
### Progressive dependency loading
|
|
|
|
| Doc Type | Requires |
|
|
|----------|----------|
|
|
| product-brief | discovery-context.json |
|
|
| requirements | + product-brief.md |
|
|
| architecture | + requirements/_index.md |
|
|
| epics | + architecture/_index.md |
|
|
|
|
**Prior decisions from accumulator**: Pass context_accumulator summaries as "Prior Decisions" to subagent.
|
|
|
|
| Input | Source | Required |
|
|
|-------|--------|----------|
|
|
| Document standards | `../../specs/document-standards.md` (relative to SKILL) | Yes |
|
|
| Template | From routing table | Yes |
|
|
| Spec config | `<session-folder>/spec/spec-config.json` | Yes |
|
|
| Discovery context | `<session-folder>/spec/discovery-context.json` | Yes |
|
|
| Discussion feedback | `<session-folder>/discussions/<discuss-file>` | If exists |
|
|
| Prior decisions | context_accumulator (in-memory) | If prior tasks exist |
|
|
|
|
## Phase 3: CLI Document Generation
|
|
|
|
**Objective**: Generate document using CLI tool.
|
|
|
|
Use Gemini CLI for document generation:
|
|
|
|
```
|
|
Bash({
|
|
command: `ccw cli -p "PURPOSE: Generate <doc-type> document following template and standards
|
|
TASK: • Load template from <template-path> • Apply spec config and discovery context • Integrate prior discussion feedback • Generate all required sections
|
|
MODE: write
|
|
CONTEXT: @<session-folder>/spec/*.json @<template-path> | Memory: Prior decisions: <context_accumulator summary>
|
|
EXPECTED: Document at <output-path> with: YAML frontmatter, all template sections, cross-references, session_id
|
|
CONSTRAINTS: Follow document-standards.md" --tool gemini --mode write --rule development-implement-feature --cd <session-folder>`,
|
|
run_in_background: false
|
|
})
|
|
```
|
|
|
|
Parse CLI output for artifact path and summary. Document is written to disk by CLI.
|
|
|
|
## Phase 4: Self-Validation + Inline Discuss
|
|
|
|
### 4a: Self-Validation
|
|
|
|
| Check | What to Verify |
|
|
|-------|---------------|
|
|
| has_frontmatter | Starts with YAML frontmatter |
|
|
| sections_complete | All template sections present |
|
|
| cross_references | session_id included |
|
|
| discussion_integrated | Reflects prior round feedback (if exists) |
|
|
|
|
### 4b: Inline Discuss
|
|
|
|
Call CLI discuss tool for this task's discuss round:
|
|
- Artifact: `<output-path>` (the generated document)
|
|
- Round: `<DISCUSS-NNN>` from mapping table
|
|
- Perspectives: from mapping table
|
|
|
|
```bash
|
|
ccw cli -p "PURPOSE: Multi-perspective critique of <doc-type>
|
|
TASK: Review from <perspectives>
|
|
ARTIFACT: @<output-path>
|
|
MODE: analysis
|
|
EXPECTED: JSON with perspectives[], consensus, severity, recommendations[]" --tool gemini --mode analysis
|
|
```
|
|
|
|
Handle discuss verdict per team-worker consensus handling protocol.
|
|
|
|
**Report**: doc type, validation status, discuss verdict + severity, average rating, summary, output path.
|
|
|
|
## Error Handling
|
|
|
|
| Scenario | Resolution |
|
|
|----------|------------|
|
|
| CLI failure | Retry once with alternative tool. Still fails → log error, continue next task |
|
|
| CLI discuss fails | Skip discuss, log warning |
|
|
| Cumulative 3 task failures | SendMessage to coordinator, STOP |
|
|
| Prior doc not found | Notify coordinator, request prerequisite |
|
|
| Discussion contradicts prior docs | Note conflict, flag for coordinator |
|