agentleFS
Sign inStart free
prabhakar349prabhakar349/claude-ddd-redesign/skills/design-doc/SKILL.md

design-doc

Skill1 starsChanged 3 months agoMITView on GitHub

Defines the content and structure of a Slice's detailed design document. Reference when assembling or reviewing slices/<id>/design.md.

25 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use testing, release-notes and 2 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • NVIDIASkill

    testing

    Run Python and Rust tests for physicsnemo-curator using uv + pytest with coverage reporting via pytest-cov, and cargo-nextest for Rust tests. Includes benchmark workflows with pytest-benchmark and criterion.

    Also in 3 projects that use this

  • Microsoft AzureSkill

    release-notes

    Author and update release notes for Azure App Configuration libraries and providers. USE FOR: write release notes, add release note entry, update release notes, draft release notes, new version release notes, format release notes. DO NOT USE FOR: generating changelogs from git history, writing internal engineering notes.

    Also in 3 projects that use this

  • SentrySkill

    commit

    Create commit messages following Sentry conventions. Use when committing code changes, writing commit messages, or formatting git history. Follows conventional commits with Sentry-specific issue references.

    Also in 4 projects that use this

  • GoogleSkill

    grill-me

    A relentless interview to sharpen a plan or design.

    Also in 3 projects that use this

The file

Create a free account to mount
Files
SKILL.md

Design Doc

Defines what design.md must contain, as the human-readable narrative companion to tactical-model.json (Constitution C7 — the JSON is the data of record; this markdown explains it, it does not add undocumented facts of its own).

Schema anchor

There is no dedicated JSON schema for design.md itself — it is generated narrative, not an independently authored data artifact. Its citation obligations mirror schemas/tactical-model.schema.json: every clause in this document must be traceable to the same invariants[].behaviors[] data that grounds the Tactical Model, because the Stage 5 gate (trace-lint.py --stage 5) requires "every design clause cites a Behavior ID."

Required sections

  1. Scope — which Slice, which Context, which Behaviors are in scope (list the Behavior IDs).
  2. Aggregates — one subsection per aggregate: its invariants (restated in prose, each with its Behavior ID citation inline), entities, value objects.
  3. Domain events and commands — named exactly as in tactical-model.json, with the trigger/effect described in prose.
  4. Legacy adapter approach — for every legacy Interface in scope, name the adapter pattern used (Anticorruption Layer by default — knowledge/ddd-reference.md §5) and who owns it.
  5. Open questions — anything spec-critic should specifically attack, or that is still genuinely undecided. Do not hide uncertainty to look more finished than the design actually is.

Behavior-ID citation

Every clause describing a rule, a validation, or a side effect needs an inline citation like (BHV-0042). An uncited clause is either an unevidenced addition the critic should flag, or a citation that was simply forgotten — either way, spec-critic (agents/spec-critic.md) is specifically instructed to hunt for these.

What this skill does not cover

How the design was arrived at, or what evidence was gathered to inform it — that is Stage 1/2 discovery's job, already done by the time this document is written (Constitution C9).

Minimal worked example (excerpt)

## Aggregates

### Order (root: Order)
- Invariant: An Order must contain at least one OrderLine with quantity > 0 (BHV-0042)
- Entities: OrderLine
- Value objects: Quantity, Money

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free