feat: add Socratic Code Theory Recovery contract + Cockburn Use Cases anchor#454
Merged
rdmueller merged 4 commits intoMay 2, 2026
Conversation
Recovers a program's "theory" (Naur 1985) from source code through recursive question refinement. Composes: Socratic Method, arc42, ISO 25010, Nygard ADRs, Mental Model (Naur). Two-phase workflow producing a Question Tree with [ANSWERED]/[OPEN] leaves and role-routed handoff document. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Alistair Cockburn's structured textual use case format from "Writing Effective Use Cases" (2001). Core concepts: Fully Dressed template, three Goal Levels (Summary/User Goal/Subfunction), Actor-Goal List discovery technique. Deliberately notation-agnostic — does NOT prescribe Activity Diagrams, Gherkin, or EARS; those are complementary representations layered on top. Category: requirements-engineering. Tier 3. Related: Gherkin, BDD, EARS, arc42, ISO 25010. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
WalkthroughDieses PR fügt ein neues Dokumentations-Anker für „Cockburn Use Cases" (mit englischer und deutscher Version) hinzu und registriert es in der Metadaten-Infrastruktur. Gleichzeitig wird ein neuer „Socratic Code Theory Recovery"-Vertrag in die Vertragssammlung aufgenommen. Beide Einträge werden in der Changelog dokumentiert. ChangesCockburn Use Cases Anker
Socratic Code Theory Recovery Vertrag
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 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. Review rate limit: 0/1 reviews remaining, refill in 50 minutes and 14 seconds.Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@website/public/data/contracts.json`:
- Around line 107-109: The anchors array is missing the key referenced in
template/templateDe ("Cockburn Use Cases"); update the "anchors" value to
include "cockburn-use-cases" (e.g., add "cockburn-use-cases" alongside
"socratic-method", "arc42", "iso-25010", etc.) so the metadata matches the
textual anchors and routing by Anchor-ID works; ensure the string is spelled
exactly "cockburn-use-cases" and appears once.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
Run ID: a7824def-7e20-4bf0-bd26-57e7f13637bb
📒 Files selected for processing (9)
docs/anchors/cockburn-use-cases.adocdocs/anchors/cockburn-use-cases.de.adocdocs/changelog.adocskill/semantic-anchor-translator/references/catalog.mdwebsite/public/data/anchors.jsonwebsite/public/data/categories.jsonwebsite/public/data/contracts.jsonwebsite/public/data/metadata.jsonwebsite/public/data/roles.json
- Anchors: added cockburn-use-cases and ears-requirements - Template: Use Cases now explicitly reference Cockburn's Fully Dressed format at User Goal level; EARS syntax added for individual requirements. Activity Diagrams and Gherkin retained as complementary representations (Cockburn does not prescribe these). - Global CLAUDE.md updated to match. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Step 4 now starts with an Actor-Goal List discovery prompt before writing full use cases. Use case template updated to Cockburn's Fully Dressed format (Primary Actor, Stakeholders & Interests, Trigger, Preconditions, Main Success Scenario, Extensions with step references, Success/Minimal Guarantee, Business Rules). Activity Diagrams and Gherkin explicitly framed as complementary representations layered on top of Cockburn's prose-based format — not part of Cockburn, but retained from our contract. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two additions:
New Semantic Contract: Socratic Code Theory Recovery — Recovers a program's "theory" (Naur 1985) from source code through recursive question refinement. Composes: Socratic Method, arc42, ISO 25010, Nygard ADRs, Mental Model (Naur). Two-phase workflow producing a Question Tree with
[ANSWERED]/[OPEN]leaves and role-routed handoff documents.New Anchor: Cockburn Use Cases — Alistair Cockburn's structured textual use case format from Writing Effective Use Cases (2001). Core: Fully Dressed template, three Goal Levels (Summary / User Goal / Subfunction), Actor-Goal List as discovery technique. The anchor explicitly notes what Cockburn does not prescribe (Activity Diagrams, Gherkin, EARS) — those are complementary representations we layer on via the existing "Specification" contract.
Why a separate anchor for Cockburn
The Theory Recovery contract references "Cockburn Use Cases" as a decomposition guide for specification questions. Having it as a proper anchor means:
Test plan
cockburn-use-cases(136 anchors total)🤖 Generated with Claude Code
Summary by CodeRabbit
Release Notes
Neue Features
Dokumentation