agentleFS
MaicololiverasMaicololiveras/praxisgenai-agent-orchestrator/skills/sdd-design/SKILL.md

sdd-design

Skill1 starsChanged 8 months agoMITView on GitHub

Create technical design document with architecture decisions and approach. Trigger: When the orchestrator launches you to write or update the technical design for a change.

8 other projects use a version of this, 1 of them edited.

Adopted by

Most recently taken up by

Used with

Projects with it also use sdd-requirements.

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.
  • GabrielaStarkSkill

    sdd-requirements

    Use this skill whenever generating, validating, or editing a requirements.md file for Spec-Driven Development. Defines the canonical structure (Kiro-strict format), EARS notation rules in English, mandatory validation checklist, and good/bad examples. Trigger whenever the task involves transforming raw input (interviews, transcripts, legacy code analysis) into a formal requirements.md, or when reviewing an existing requirements.md for compliance.

    Also in 3 projects that use this

The file

Show its rules and text

We split this skill into the rules it gives an agent

20 rules. 0 are common, 11 are distinctive, and 9 are very specific to this project.

  • 0

    Common

    Most of the 5 edited versions we read keep these.

  • 11

    Distinctive

    This author's own choices. Worth a look.

  • 9

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Read and follow skills/_shared/persistence-contract.md for mode resolution rules.

    line 24
  2. Very specific:

    If mode is engram:

    line 26
  3. Very specific:

    If found: mem_get_observation(id: {id from step 3}) → full spec content

    line 32
  4. Very specific:

    If mode is openspec: Read and follow skills/_shared/openspec-convention.md.

    line 47
  5. Very specific:

    If mode is hybrid: Follow BOTH conventions — persist to Engram AND write design.md to filesystem.

    line 48
  6. Very specific:

    If mode is none: Return result only.

    line 49
  7. Very specific:

    If engram not available or not found: read .atl/skill-registry.md from the project root

    line 58
  8. Distinctive:

    If neither exists: proceed without skills (not an error)

    line 59
  9. Distinctive:

    Before designing, read the actual code that will be affected:

    line 65
  10. Distinctive:

    Test infrastructure (if any)

    line 69
  11. Distinctive:

    Create the design document:

    line 73
  12. Very specific:

    If mode is openspec or hybrid: the file was already written in Step 3.

    line 162
  13. Very specific:

    If mode is hybrid: also call mem_save as above (write to BOTH backends).

    line 164
  14. Distinctive:

    If you skip this step, the next phase (sdd-tasks) will NOT be able to find your design and the pipeline BREAKS.

    line 166
  15. Distinctive:

    ALWAYS read the actual codebase before designing — never guess

    line 193
  16. Distinctive:

    Every decision MUST have a rationale (the "why")

    line 194
  17. Distinctive:

    Use the project's ACTUAL patterns and conventions, not generic best practices

    line 196
  18. Distinctive:

    If you find the codebase uses a pattern different from what you'd recommend, note it but FOLLOW the existing pattern unless the change …

    line 197
  19. Distinctive:

    Keep ASCII diagrams simple — clarity over beauty

    line 198
  20. Distinctive:

    If you have open questions that BLOCK the design, say so clearly — don't guess

    line 200

“Common” is measured: kept by at least 6 in 10 of the 5 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Purpose

You are a sub-agent responsible for TECHNICAL DESIGN. You take the proposal and specs, then produce a design.md that captures HOW the change will be implemented — architecture decisions, data flow, file changes, and technical rationale.

What You Receive

From the orchestrator:

  • Change name
  • Artifact store mode (engram | openspec | hybrid | none)

Execution and Persistence Contract

Read and follow skills/_shared/persistence-contract.md for mode resolution rules.

  • If mode is engram:

    Read dependencies (two-step — search returns truncated previews):

    1. mem_search(query: "sdd/{change-name}/proposal", project: "{project}") → get observation ID
    2. mem_get_observation(id: {id from step 1}) → full proposal content (REQUIRED)
    3. mem_search(query: "sdd/{change-name}/spec", project: "{project}") → get observation ID (optional — may not exist if running in parallel with sdd-spec)
    4. If found: mem_get_observation(id: {id from step 3}) → full spec content

    Save your artifact:

    mem_save(
      title: "sdd/{change-name}/design",
      topic_key: "sdd/{change-name}/design",
      type: "architecture",
      project: "{project}",
      content: "{your full design markdown}"
    )

    topic_key enables upserts — saving again updates, not duplicates.

    (See skills/_shared/engram-convention.md for full naming conventions.)

  • If mode is openspec: Read and follow skills/_shared/openspec-convention.md.
  • If mode is hybrid: Follow BOTH conventions — persist to Engram AND write design.md to filesystem. Retrieve dependencies from Engram (primary) with filesystem fallback.
  • If mode is none: Return result only. Never create or modify project files.

What to Do

Step 1: Load Skill Registry

Do this FIRST, before any other work.

  1. Try engram first: mem_search(query: "skill-registry", project: "{project}") → if found, mem_get_observation(id) for the full registry
  2. If engram not available or not found: read .atl/skill-registry.md from the project root
  3. If neither exists: proceed without skills (not an error)

From the registry, identify and read any skills whose triggers match your task. Also read any project convention files listed in the registry.

Step 2: Read the Codebase

Before designing, read the actual code that will be affected:

  • Entry points and module structure
  • Existing patterns and conventions
  • Dependencies and interfaces
  • Test infrastructure (if any)

Step 3: Write design.md

Create the design document:

openspec/changes/{change-name}/
├── proposal.md
├── specs/
└── design.md              ← You create this

Design Document Format

# Design: {Change Title}

## Technical Approach

{Concise description of the overall technical strategy.
How does this map to the proposal's approach? Reference specs.}

## Architecture Decisions

### Decision: {Decision Title}

**Choice**: {What we chose}
**Alternatives considered**: {What we rejected}
**Rationale**: {Why this choice over alternatives}

### Decision: {Decision Title}

**Choice**: {What we chose}
**Alternatives considered**: {What we rejected}
**Rationale**: {Why this choice over alternatives}

## Data Flow

{Describe how data moves through the system for this change.
Use ASCII diagrams when helpful.}

    Component A ──→ Component B ──→ Component C
         │                              │
         └──────── Store ───────────────┘

## File Changes

| File | Action | Description |
|------|--------|-------------|
| `path/to/new-file.ext` | Create | {What this file does} |
| `path/to/existing.ext` | Modify | {What changes and why} |
| `path/to/old-file.ext` | Delete | {Why it's being removed} |

## Interfaces / Contracts

{Define any new interfaces, API contracts, type definitions, or data structures.
Use code blocks with the project's language.}

## Testing Strategy

| Layer | What to Test | Approach |
|-------|-------------|----------|
| Unit | {What} | {How} |
| Integration | {What} | {How} |
| E2E | {What} | {How} |

## Migration / Rollout

{If this change requires data migration, feature flags, or phased rollout, describe the plan.
If not applicable, state "No migration required."}

## Open Questions

- [ ] {Any unresolved technical question}
- [ ] {Any decision that needs team input}

Step 4: Persist Artifact

This step is MANDATORY — do NOT skip it.

If mode is engram:

mem_save(
  title: "sdd/{change-name}/design",
  topic_key: "sdd/{change-name}/design",
  type: "architecture",
  project: "{project}",
  content: "{your full design markdown from Step 3}"
)

If mode is openspec or hybrid: the file was already written in Step 3.

If mode is hybrid: also call mem_save as above (write to BOTH backends).

If you skip this step, the next phase (sdd-tasks) will NOT be able to find your design and the pipeline BREAKS.

Step 5: Return Summary

Return to the orchestrator:

## Design Created

**Change**: {change-name}
**Location**: openspec/changes/{change-name}/design.md

### Summary
- **Approach**: {one-line technical approach}
- **Key Decisions**: {N decisions documented}
- **Files Affected**: {N new, M modified, K deleted}
- **Testing Strategy**: {unit/integration/e2e coverage planned}

### Open Questions
{List any unresolved questions, or "None"}

### Next Step
Ready for tasks (sdd-tasks).

Rules

  • ALWAYS read the actual codebase before designing — never guess
  • Every decision MUST have a rationale (the "why")
  • Include concrete file paths, not abstract descriptions
  • Use the project's ACTUAL patterns and conventions, not generic best practices
  • If you find the codebase uses a pattern different from what you'd recommend, note it but FOLLOW the existing pattern unless the change specifically addresses it
  • Keep ASCII diagrams simple — clarity over beauty
  • Apply any rules.design from openspec/config.yaml
  • If you have open questions that BLOCK the design, say so clearly — don't guess
  • Return a structured envelope with: status, executive_summary, detailed_report (optional), artifacts, next_recommended, and risks

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.