Design Docs - alexherrero/crickets GitHub Wiki

Design Docs

Architecture

Design Docs gives your agent the two authoring disciplines that come before any code is written: thinking a change through as a design, and capturing an architectural decision so a future reader can trust it. Instead of jumping straight into a plan, you talk the design out first, then let the agent turn it into an ordered set of small, buildable pieces โ€” so the hard thinking happens up front, when it is cheapest to change your mind. It also teaches the agent when a decision is worth recording and what a durable record looks like, so the reasoning behind a call survives long after the call is made. It slots on top of the phase loop: Design Docs needs Development Lifecycle installed, and hands the plans it produces straight to that loop's /work step.

Diagram

The authoring pipeline, then how the plugin composes:

The design pipeline: the operator approves at each gate as /design runs author (interview to a final design doc), then translate (the approved doc into structural parts), then sequence (those parts into named plans in build order), handing the finished plans to the /work loop

How design-docs composes: it sits in the centre with a solid arrow requiring development-lifecycle to run the /design workflow, and rests one-way on the AgentM substrate of memory, opinions, and personas, with no soft enhancers

How it works

The plugin does two things. The first is the design pipeline, and it runs in three steps. It starts by interviewing you to draw out what you actually want, and writes that up as a design doc you approve before anything moves on. It then breaks the approved design into structural pieces, and finally sequences those pieces into named plans in the order they should be built. What you get at the end is one design turned into a set of small, buildable plans, each ready for the /work step to pick up. The /design command is the door in; the workflow behind it lives in Development Lifecycle, which is why Design Docs needs that plugin installed.

The second is the decision-record discipline. As the agent works, it watches for genuine architectural decisions โ€” the kind whose reasoning a future reader will need โ€” and knows both when one is worth recording and what a durable record should contain: the context, the call and why not the alternative, the consequences, and a trigger for revisiting it later. This runs on its own, whenever such a decision comes up, not only when you ask for it. It is aimed mainly at projects that still keep standalone decision-record files; crickets and agentm themselves now fold decisions into their living designs instead.

Composition

Direction Plugin How
Enhances (soft) โ€” None.
Enhanced by (soft) โ€” None.
Requires (hard) Development Lifecycle The /design command delegates to development-lifecycle's /design implementation; without it the command has nothing to delegate to.
Required by (hard) โ€” None.

Why not

Design Docs is opinionated about how design authoring should flow, and it will not fit every project. Reach for something else if:

  • You do not run the harness's plan-driven workflow โ€” the /design pipeline assumes development-lifecycle is installed to do the real work, so on its own the command is inert.
  • Your project still keeps standalone ADR files and wants a heavier decision-record tool; the adr skill teaches a format and a discipline, it does not manage an ADR index or lifecycle.
  • The change in front of you is small and self-explanatory. A one-file fix rarely needs a design doc or a decision record, and running the pipeline for it is more ceremony than the work warrants.

Reference

Commands & skills

Each primitive links to the source that implements it.

Primitive Kind What it does
/design command Author โ†’ translate โ†’ sequence a design doc into named plans; delegates to development-lifecycle.
adr skill Decision-record discipline โ€” when to write an ADR and the five-section shape with re-audit triggers.

Configuration

No configuration โ€” the plugin works out of the box. The /design command reads its workflow settings from development-lifecycle, and the adr skill draws its canonical shape from the adr-shape entry in ~/.claude/CLAUDE.md; neither adds a config key of its own.

See also

Reference ยท Architecture ยท Home

โš ๏ธ **GitHub.com Fallback** โš ๏ธ