Skip to content

docs: rework spec-driven workflow content#325

Merged
rdmueller merged 1 commit intoLLM-Coding:mainfrom
raifdmueller:docs/workflow-content-rework
Mar 18, 2026
Merged

docs: rework spec-driven workflow content#325
rdmueller merged 1 commit intoLLM-Coding:mainfrom
raifdmueller:docs/workflow-content-rework

Conversation

@raifdmueller
Copy link
Contributor

@raifdmueller raifdmueller commented Mar 18, 2026

Summary

  • Introduce Eichhorst's Principle (Shannon's noisy channel theorem applied to LLM coding) with open-loop vs closed-loop explanation and error correction layers
  • Link previously unlinked anchors: TDD London School, arc42, Definition of Done, PRD, INVEST
  • Use "TDD, London School" instead of bare "TDD" as anchor example (TDD alone is not a good anchor)
  • Move DRY/SOLID/KISS/Ubiquitous Language to AGENTS.md conventions instead of per-step checklist
  • Add prerequisites: GitHub/GitLab CLI access for AI agent, Vibe Coding Risk Radar for quality gates
  • Replace manual git merge with AI-created Pull Requests
  • Replace "new session per EPIC" with context compaction guidance (manual /compact at natural breakpoints)
  • Let AI agent maintain AGENTS.md itself (remove manual Current State section)
  • Soften review language to reflect trust-based workflow
  • Explain AsciiDoc advantage for native PlantUML/text-to-diagram support
  • Reference arc42 Section 10 for full quality requirements (not just Section 1.2)

All changes applied to both EN and DE versions.

Test plan

  • Verify rendered HTML on workflow page (EN + DE)
  • Check all anchor links resolve correctly
  • Verify no broken formatting in AsciiDoc rendering

🤖 Generated with Claude Code

Summary by CodeRabbit

Dokumentation

  • Dokumentation
    • Umfangreiche Überarbeitung der Workflow-Dokumentation mit verbesserten Erklärungen und strukturierten Verweisen
    • Klarere Gliederung von Best Practices und Methodologien (TDD, arc42)
    • Erweiterte Guidance zu Anforderungsermittlung und iterativen Prozessen
    • Bessere Navigation durch interne Querverweise und Ankerlinks

- Introduce Eichhorst's Principle (Shannon's theorem applied to LLM coding)
  with open-loop vs closed-loop explanation and error correction layers
- Link anchors: TDD London School, arc42, Definition of Done, PRD, INVEST
- Use "TDD, London School" instead of bare "TDD" as anchor examples
- Move DRY/SOLID/KISS/DDD to AGENTS.md conventions (not per-step checklist)
- Add prerequisites: GitHub/GitLab CLI access, Vibe Coding Risk Radar
- Replace manual merging with AI-created Pull Requests
- Replace "new session per EPIC" with context compaction guidance
- Let AI agent maintain AGENTS.md (remove manual Current State section)
- Soften review language ("if you see the need" vs "before moving on")
- Bold golden rule, link arc42 template to prerequisites
- Explain AsciiDoc advantage for PlantUML/text-to-diagram tools
- Reference arc42 Section 10 for full quality requirements

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link

coderabbitai bot commented Mar 18, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: da088641-e7d6-489a-9d16-4da3e3503ad1

📥 Commits

Reviewing files that changed from the base of the PR and between 867fee5 and a24e1ca.

📒 Files selected for processing (2)
  • docs/spec-driven-workflow.adoc
  • docs/spec-driven-workflow.de.adoc

Walkthrough

Die Änderungen aktualisieren zwei AsciiDoc-Dokumentationsdateien für den Spec-Driven-Workflow mit textlichen Verfeinerungen, Anker- und Link-Substitutionen sowie Formatierungsanpassungen. Die funktionalen Arbeitsabläufe bleiben unverändert, während Wording, Ankerbezüge und Erklärungen erweitert werden.

Changes

Cohort / File(s) Summary
Workflow-Dokumentation
docs/spec-driven-workflow.adoc, docs/spec-driven-workflow.de.adoc
Textliche Verfeinerungen, Ankerbezüge zu TDD und arc42, Neuformulierungen von Prozessbeschreibungen, Umwandlung von Verfahrensschritten in ankergekoppelte Referenzen, erweiterte Erklärungen zu Werkzeugen und Best Practices (INVEST, Pugh Matrix, ATAM), sowie Formatierungsanpassungen (Fettdruck, Inline-Ankern) ohne funktionale Änderungen des Workflows.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
📝 Coding Plan
  • Generate coding plan for human review comments

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@rdmueller rdmueller merged commit 376c387 into LLM-Coding:main Mar 18, 2026
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants