fix(contracts): tighten Architecture Documentation diagram and format rules#486
Conversation
… rules Drives explicit choices the previous wording left open, which led an LLM- generated arc42 set to produce '§'-prefixed headings, Mermaid diagrams where PlantUML was implied, generic 'flowchart TB' boxes labelled "C4", and Markdown arc42 sections alongside the Docs-as-Code contract. - Section numbering: arc42 native (`1.`, `1.1`), no `§` prefix in output. - File formats: arc42 / ADRs / PRD / specs in AsciiDoc; use-case files + entity model stay in whatever AIUP-reverse-engineer emits; Question Tree / Open Questions in AsciiDoc. - Diagrams: all PlantUML. §5.x building blocks must use the C4-PlantUML stdlib with proper stereotypes (Person/System/Container/Component/Rel); generic shapes do not satisfy the requirement. - Docs-as-Code contract gains an explicit line about shipping `dtcw` and `docToolchainConfig.groovy` so the implicit infrastructure dependency is visible to anyone selecting the contract. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
WalkthroughDie Semantic-Contracts in ChangesDokumentations-Contract-Spezifikationen
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Summary
Follow-up to #485. The previous wording left enough room that an LLM-generated arc42 set produced four problems we want to prevent:
§-prefixed section headings in the output (## §3 Context …) — the§symbol was meant only as a reference to arc42 sections, not as the prescribed notation.flowchart TB/flowchart LRboxes instead of the C4-PlantUML stdlib withPerson()/System()/Container()/Component()/Rel().Changes
§prefix); explicit file-format rules (AsciiDoc for arc42/ADRs/PRD/specs, Markdown stays only where the AIUP-reverse-engineer skill produces it); all diagrams PlantUML; §5.x must use the C4-PlantUML stdlib with proper stereotypes — generic shapes do not satisfy the requirement.dtcwwrapper anddocToolchainConfig.groovyso the implicit infrastructure dependency is visible to anyone selecting the contract.Test plan
npm run buildsucceeds; both contracts appear indist/contracts/index.htmlllms.txtlists all 14 contracts with the new template/contractspage, the Architecture Documentation card shows the new PlantUML/C4-PlantUML rules🤖 Generated with Claude Code
Summary by CodeRabbit
Versionshinweise