Skip to content

feat: add System Use Cases and Supplementary Specs to workflow#456

Merged
rdmueller merged 2 commits into
LLM-Coding:mainfrom
raifdmueller:feat/system-use-cases-in-workflow
May 3, 2026
Merged

feat: add System Use Cases and Supplementary Specs to workflow#456
rdmueller merged 2 commits into
LLM-Coding:mainfrom
raifdmueller:feat/system-use-cases-in-workflow

Conversation

@raifdmueller
Copy link
Copy Markdown
Contributor

@raifdmueller raifdmueller commented May 3, 2026

Summary

  • Restructures Step 4 (Specification) into layered substeps: 4a Actor-Goal List, 4b Persona Use Cases, 4c System Use Cases, 4d Supplementary Specs
  • System Use Cases describe technical behavior at system boundaries (API endpoints, CLI commands, events, file formats) — bridging the gap between stakeholder-facing Persona Use Cases and implementation
  • Supplementary Specs cover Entity Models, State Machines, Interface Contracts, and Validation Rules as needed
  • Aligned with Martinelli's AIUP distinction between Business and System Use Case Specifications
  • Updated: EN + DE workflow pages, Cheat Sheet, Specification contract

Test plan

  • Verify spec-driven-development page renders correctly (EN + DE)
  • Check all internal anchor links work
  • Verify Specification contract on /contracts page reflects new template

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Strukturierter Workflow für Spezifikationserstellung: Schritt 4 wurde in vier Unterschritte (Persona Use Cases, System Use Cases, Supplementary Specifications, Actor-Goal List) aufgeteilt für bessere Klarheit.
    • Erweiterte Checklisten und detaillierte Prompt-Vorlagen für jede Spezifikationsschicht.
    • Deutsche Dokumentation aktualisiert.

raifdmueller and others added 2 commits May 3, 2026 09:57
Step 4 now builds the specification in layers:
- 4a: Actor-Goal List (scope discovery, unchanged)
- 4b: Persona Use Cases (Cockburn Fully Dressed, User Goal level)
- 4c: System Use Cases (technical interfaces: API, CLI, events)
- 4d: Supplementary Specs (Entity Model, State Machines, DTOs)

Updated: EN + DE workflow pages, Cheat Sheet, Specification contract.
Aligned with Martinelli's AIUP distinction between Business and System
Use Case Specifications.

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

coderabbitai Bot commented May 3, 2026

Caution

Review failed

Pull request was closed or merged during review

Walkthrough

Die Dokumentation für das Spec-Driven Workflow wurde überarbeitet, um Step 4 („Detaillierte Spezifikation erstellen") in explizite, aufeinanderfolgende Schichten zu strukturieren: Persona Use Cases, System Use Cases und Supplementary Specifications. Die Änderungen umfassen englische und deutsche Dokumentation sowie aktualisierte JSON-Vertragsvorlagen.

Changes

Spec-Driven Workflow Schichtenstruktur

Layer / File(s) Zusammenfassung
Dokumentstruktur & Schichtenaufbau
docs/spec-driven-workflow.adoc (Zeilen 205–231), docs/spec-driven-workflow.de.adoc (Zeilen 215–242)
Step 4 wird in explizite Sub-Steps (4a: Actor-Goal-Liste, 4b: Persona Use Cases, 4c: System Use Cases, 4d: Supplementary Specs) aufgeteilt. Neue Abschnitte definieren Trigger, Eingaben, Validierung, Verarbeitung, Ausgaben, Fehlerbehandlung und nicht-funktionale Anforderungen mit EARS-Syntax.
Detaillierte Spezifikationsinhalte
docs/spec-driven-workflow.adoc (Zeilen 267–310), docs/spec-driven-workflow.de.adoc (Zeilen 277–320)
System Use Cases werden pro technische Schnittstelle (API/CLI/Events/Dateiformate) detailliert beschrieben; Supplementary Specifications definieren Entity Models, State Machines, Interface Contracts/DTOs und Validierungsregeln.
Prompt Cheat Sheet
docs/spec-driven-workflow.adoc (Zeilen 531–545), docs/spec-driven-workflow.de.adoc (Zeilen 548–562)
Die einzelne „Specification"-Prompt-Zeile wird durch drei granularere Zeilen ersetzt: „Persona Use Cases", „System Use Cases" und „Supplementary Specs" mit aktualisierten Prompts und Anker-Referenzen.
Vertragsvorlage & Changelog
website/public/data/contracts.json (Zeilen 9–10), docs/changelog.adoc (Zeilen 5–10)
JSON-Vorlagen für specification werden erweitert, um die neue Schichtenstruktur widerzuspiegeln. Neuer Changelog-Eintrag dokumentiert die Workflow-Verbesserungen.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed Der Titel beschreibt die Hauptänderung präzise: Ergänzung von System Use Cases und Supplementary Specs zum Workflow mit strukturierter Schichtung in Schritt 4.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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
Review rate limit: 0/1 reviews remaining, refill in 60 minutes.

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

@rdmueller rdmueller merged commit f85efce into LLM-Coding:main May 3, 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