- Nx 22.7 monorepo (pnpm 11.1, TypeScript 5.9, Node 24) - apps/api: NestJS 11 (CJS conforme CODING-RULES.md PGD-DB-004) - apps/web: React 19 + Vite 8 (ESM) - libs/shared/api-interface: Zod contract base - Docker Compose dev: Postgres 18, Valkey 8, MinIO, Mailpit - WDS artifacts: - design-artifacts/A-Product-Brief/ (5 docs canônicos + 16 dialogs) - design-artifacts/B-Trigger-Map/ (hub + 4 personas + feature impact) - Stack canon: STACK.md v2.2 + CODING-RULES.md v2.0 + brand.md - AGENTS.md + README.md como entrada para devs/agentes Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2.1 KiB
2.1 KiB
Retrospective Doc Verification
Companion to retrospective-automation.md. Contains doc verification patterns and output parsing guidance.
Doc Verification Patterns
After retrospective generates documents, verify updates against code:
Documents to Check
| Doc Type | Pattern | Verification Method |
|---|---|---|
| Architecture | *architecture*.md |
Compare decisions against implementation |
| API Docs | *api*.md, *openapi*.yaml |
Verify endpoints match code |
| README | README.md |
Check setup/usage instructions |
| Config Docs | *config*.md |
Verify env vars and settings |
Verification Prompt Template
Verify whether this documentation update is needed:
**Document:** {doc_path}
**Proposed Change:** {change_summary}
**Reason:** {reason}
Instructions:
1. Read the current document at {doc_path}
2. Read the relevant implementation code referenced
3. Compare doc against actual implementation
4. Determine if update is genuinely needed
Output JSON:
{
"should_update": true|false,
"confidence": "high"|"medium"|"low",
"reason": "explanation",
"discrepancies": ["list", "of", "specific", "issues"]
}
If discrepancies exist, apply the fix directly.
Confidence Thresholds
- High confidence: Auto-apply update
- Medium confidence: Auto-apply with log note
- Low confidence: Skip update, log for manual review
Output Parsing
Parse Doc Proposals from Retrospective Output
Look for sections in retrospective output:
## Documentation Updates Needed
### {doc_path}
- **Change:** {summary}
- **Reason:** {reason}
- **Impact:** {impact}
Extract into structured format:
{
"proposals": [
{
"path": "{doc_path}",
"summary": "{summary}",
"reason": "{reason}",
"impact": "{impact}"
}
]
}
Retrospective Completion Markers
Successful completion indicators:
- "Retrospective Complete" in output
- "epic-{N}-retro-*.md" file created
- Sprint status updated with retrospective done
Failure indicators:
- Session timeout
- Error messages in output
- No retro file created after 30+ minutes