@heihei0299/matt-skills 2.1.13 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -2
- package/bin/cli.js +40 -92
- package/package.json +1 -1
- package/template/.opencode/CONTEXT.md +7 -7
- package/template/.pi/CONTEXT.md +7 -7
- package/template/.agents/skills/ask-matt/PHASE-BOUNDARIES.md +0 -55
- package/template/.agents/skills/ask-matt/SKILL.md +0 -90
- package/template/.agents/skills/ask-matt/agents/openai.yaml +0 -5
- package/template/.agents/skills/code-review/SKILL.md +0 -87
- package/template/.agents/skills/code-review/agents/openai.yaml +0 -3
- package/template/.agents/skills/codebase-design/DEEPENING.md +0 -37
- package/template/.agents/skills/codebase-design/DESIGN-IT-TWICE.md +0 -44
- package/template/.agents/skills/codebase-design/SKILL.md +0 -114
- package/template/.agents/skills/codebase-design/agents/openai.yaml +0 -3
- package/template/.agents/skills/diagnose-fix/SKILL.md +0 -43
- package/template/.agents/skills/diagnose-fix/agents/openai.yaml +0 -5
- package/template/.agents/skills/diagnose-fix/references/anti-patterns.md +0 -21
- package/template/.agents/skills/diagnosing-bugs/SKILL.md +0 -138
- package/template/.agents/skills/diagnosing-bugs/agents/openai.yaml +0 -3
- package/template/.agents/skills/diagnosing-bugs/scripts/hitl-loop.template.sh +0 -44
- package/template/.agents/skills/domain-modeling/ADR-FORMAT.md +0 -47
- package/template/.agents/skills/domain-modeling/CONTEXT-FORMAT.md +0 -60
- package/template/.agents/skills/domain-modeling/SKILL.md +0 -74
- package/template/.agents/skills/domain-modeling/agents/openai.yaml +0 -3
- package/template/.agents/skills/grill-me/SKILL.md +0 -7
- package/template/.agents/skills/grill-me/agents/openai.yaml +0 -5
- package/template/.agents/skills/grill-to-spec/SKILL.md +0 -55
- package/template/.agents/skills/grill-to-spec/agents/openai.yaml +0 -5
- package/template/.agents/skills/grill-to-spec/references/rules.md +0 -47
- package/template/.agents/skills/grill-with-docs/SKILL.md +0 -7
- package/template/.agents/skills/grill-with-docs/agents/openai.yaml +0 -5
- package/template/.agents/skills/grilling/SKILL.md +0 -28
- package/template/.agents/skills/grilling/agents/openai.yaml +0 -3
- package/template/.agents/skills/handoff/SKILL.md +0 -16
- package/template/.agents/skills/handoff/agents/openai.yaml +0 -5
- package/template/.agents/skills/implement/SKILL.md +0 -15
- package/template/.agents/skills/implement/agents/openai.yaml +0 -5
- package/template/.agents/skills/implement-review-loop/SKILL.md +0 -34
- package/template/.agents/skills/implement-review-loop/agents/openai.yaml +0 -5
- package/template/.agents/skills/improve-codebase-architecture/HTML-REPORT.md +0 -123
- package/template/.agents/skills/improve-codebase-architecture/SKILL.md +0 -71
- package/template/.agents/skills/improve-codebase-architecture/agents/openai.yaml +0 -5
- package/template/.agents/skills/instance-test/SKILL.md +0 -70
- package/template/.agents/skills/instance-test/agents/openai.yaml +0 -5
- package/template/.agents/skills/instance-test/references/instances.md +0 -75
- package/template/.agents/skills/prototype/LOGIC.md +0 -67
- package/template/.agents/skills/prototype/SKILL.md +0 -26
- package/template/.agents/skills/prototype/UI.md +0 -112
- package/template/.agents/skills/prototype/agents/openai.yaml +0 -3
- package/template/.agents/skills/research/SKILL.md +0 -12
- package/template/.agents/skills/research/agents/openai.yaml +0 -3
- package/template/.agents/skills/resolving-merge-conflicts/SKILL.md +0 -14
- package/template/.agents/skills/resolving-merge-conflicts/agents/openai.yaml +0 -3
- package/template/.agents/skills/scaffold-functional-test/SKILL.md +0 -64
- package/template/.agents/skills/scaffold-functional-test/agents/openai.yaml +0 -5
- package/template/.agents/skills/scaffold-functional-test/references/schema.md +0 -80
- package/template/.agents/skills/setup-matt-pocock-skills/SKILL.md +0 -116
- package/template/.agents/skills/setup-matt-pocock-skills/agents/openai.yaml +0 -5
- package/template/.agents/skills/setup-matt-pocock-skills/domain.md +0 -51
- package/template/.agents/skills/setup-matt-pocock-skills/issue-tracker-github.md +0 -45
- package/template/.agents/skills/setup-matt-pocock-skills/issue-tracker-gitlab.md +0 -46
- package/template/.agents/skills/setup-matt-pocock-skills/issue-tracker-local.md +0 -30
- package/template/.agents/skills/setup-matt-pocock-skills/triage-labels.md +0 -15
- package/template/.agents/skills/show-me/SKILL.md +0 -28
- package/template/.agents/skills/tdd/SKILL.md +0 -38
- package/template/.agents/skills/tdd/agents/openai.yaml +0 -3
- package/template/.agents/skills/tdd/mocking.md +0 -59
- package/template/.agents/skills/tdd/tests.md +0 -77
- package/template/.agents/skills/tdd-implement/SKILL.md +0 -81
- package/template/.agents/skills/tdd-implement/agents/openai.yaml +0 -5
- package/template/.agents/skills/tdd-implement/references/finalize.md +0 -16
- package/template/.agents/skills/tdd-implement/references/orchestration.md +0 -54
- package/template/.agents/skills/tdd-implement/references/verify.md +0 -15
- package/template/.agents/skills/teach/GLOSSARY-FORMAT.md +0 -35
- package/template/.agents/skills/teach/LEARNING-RECORD-FORMAT.md +0 -46
- package/template/.agents/skills/teach/MISSION-FORMAT.md +0 -31
- package/template/.agents/skills/teach/RESOURCES-FORMAT.md +0 -32
- package/template/.agents/skills/teach/SKILL.md +0 -140
- package/template/.agents/skills/teach/agents/openai.yaml +0 -5
- package/template/.agents/skills/to-questionnaire/SKILL.md +0 -54
- package/template/.agents/skills/to-questionnaire/agents/openai.yaml +0 -5
- package/template/.agents/skills/to-spec/SKILL.md +0 -75
- package/template/.agents/skills/to-spec/agents/openai.yaml +0 -5
- package/template/.agents/skills/to-tickets/SKILL.md +0 -105
- package/template/.agents/skills/to-tickets/agents/openai.yaml +0 -5
- package/template/.agents/skills/triage/AGENT-BRIEF.md +0 -207
- package/template/.agents/skills/triage/OUT-OF-SCOPE.md +0 -105
- package/template/.agents/skills/triage/SKILL.md +0 -112
- package/template/.agents/skills/triage/agents/openai.yaml +0 -5
- package/template/.agents/skills/wait-what/SKILL.md +0 -7
- package/template/.agents/skills/wait-what/agents/openai.yaml +0 -5
- package/template/.agents/skills/wayfinder/SKILL.md +0 -128
- package/template/.agents/skills/wayfinder/agents/openai.yaml +0 -5
- package/template/.agents/skills/wizard/SKILL.md +0 -44
- package/template/.agents/skills/wizard/agents/openai.yaml +0 -3
- package/template/.agents/skills/wizard/template.sh +0 -204
- package/template/.agents/skills/writing-for-agents/SKILL-MECHANICS.md +0 -22
- package/template/.agents/skills/writing-for-agents/SKILL.md +0 -81
- package/template/.agents/skills/writing-for-agents/agents/openai.yaml +0 -3
|
@@ -1,37 +0,0 @@
|
|
|
1
|
-
# Deepening
|
|
2
|
-
|
|
3
|
-
How to deepen a cluster of shallow modules safely, given its dependencies. Assumes the vocabulary in [SKILL.md](SKILL.md): **module**, **interface**, **seam**, **adapter**.
|
|
4
|
-
|
|
5
|
-
## Dependency categories
|
|
6
|
-
|
|
7
|
-
When assessing a candidate for deepening, classify its dependencies. The category determines how the deepened module is tested across its seam.
|
|
8
|
-
|
|
9
|
-
### 1. In-process
|
|
10
|
-
|
|
11
|
-
Pure computation, in-memory state, no I/O. Always deepenable: merge the modules and test through the new interface directly. No adapter needed.
|
|
12
|
-
|
|
13
|
-
### 2. Local-substitutable
|
|
14
|
-
|
|
15
|
-
Dependencies that have local test stand-ins (PGLite for Postgres, in-memory filesystem). Deepenable if the stand-in exists. The deepened module is tested with the stand-in running in the test suite. The seam is internal; no port at the module's external interface.
|
|
16
|
-
|
|
17
|
-
### 3. Remote but owned (Ports & Adapters)
|
|
18
|
-
|
|
19
|
-
Your own services across a network boundary (microservices, internal APIs). Define a **port** (interface) at the seam. The deep module owns the logic; the transport is injected as an **adapter**. Tests use an in-memory adapter. Production uses an HTTP/gRPC/queue adapter.
|
|
20
|
-
|
|
21
|
-
Recommendation shape: *"Define a port at the seam, implement an HTTP adapter for production and an in-memory adapter for testing, so the logic sits in one deep module even though it's deployed across a network."*
|
|
22
|
-
|
|
23
|
-
### 4. True external (Mock)
|
|
24
|
-
|
|
25
|
-
Third-party services (Stripe, Twilio, etc.) you don't control. The deepened module takes the external dependency as an injected port; tests provide a mock adapter.
|
|
26
|
-
|
|
27
|
-
## Seam discipline
|
|
28
|
-
|
|
29
|
-
- **One adapter means a hypothetical seam. Two adapters means a real one.** Don't introduce a port unless at least two adapters are justified (typically production + test). A single-adapter seam is just indirection.
|
|
30
|
-
- **Internal seams vs external seams.** A deep module can have internal seams (private to its implementation, used by its own tests) as well as the external seam at its interface. Don't expose internal seams through the interface just because tests use them.
|
|
31
|
-
|
|
32
|
-
## Testing strategy: replace, don't layer
|
|
33
|
-
|
|
34
|
-
- Old unit tests on shallow modules become waste once tests at the deepened module's interface exist; delete them.
|
|
35
|
-
- Write new tests at the deepened module's interface. The **interface is the test surface**.
|
|
36
|
-
- Tests assert on observable outcomes through the interface, not internal state.
|
|
37
|
-
- Tests should survive internal refactors, since they describe behaviour, not implementation. If a test has to change when the implementation changes, it's testing past the interface.
|
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
# Design It Twice
|
|
2
|
-
|
|
3
|
-
When the user wants to explore alternative interfaces for a chosen deepening candidate, use this parallel sub-agent pattern. Based on "Design It Twice" (Ousterhout): your first idea is unlikely to be the best.
|
|
4
|
-
|
|
5
|
-
Uses the vocabulary in [SKILL.md](SKILL.md): **module**, **interface**, **seam**, **adapter**, **leverage**.
|
|
6
|
-
|
|
7
|
-
## Process
|
|
8
|
-
|
|
9
|
-
### 1. Frame the problem space
|
|
10
|
-
|
|
11
|
-
Before spawning sub-agents, write a user-facing explanation of the problem space for the chosen candidate:
|
|
12
|
-
|
|
13
|
-
- The constraints any new interface would need to satisfy
|
|
14
|
-
- The dependencies it would rely on, and which category they fall into (see [DEEPENING.md](DEEPENING.md))
|
|
15
|
-
- A rough illustrative code sketch to ground the constraints, not a proposal, just a way to make the constraints concrete
|
|
16
|
-
|
|
17
|
-
Show this to the user, then immediately proceed to Step 2. The user reads and thinks while the sub-agents work in parallel.
|
|
18
|
-
|
|
19
|
-
### 2. Spawn sub-agents
|
|
20
|
-
|
|
21
|
-
Spawn 3+ sub-agents in parallel. Each must produce a **radically different** interface for the deepened module.
|
|
22
|
-
|
|
23
|
-
Prompt each sub-agent with a separate technical brief (file paths, coupling details, dependency category from [DEEPENING.md](DEEPENING.md), what sits behind the seam). The brief is independent of the user-facing problem-space explanation in Step 1. Give each agent a different design constraint:
|
|
24
|
-
|
|
25
|
-
- Agent 1: "Minimize the interface: aim for 1–3 entry points max. Maximise leverage per entry point."
|
|
26
|
-
- Agent 2: "Maximise flexibility: support many use cases and extension."
|
|
27
|
-
- Agent 3: "Optimise for the most common caller: make the default case trivial."
|
|
28
|
-
- Agent 4 (if applicable): "Design around ports & adapters for cross-seam dependencies."
|
|
29
|
-
|
|
30
|
-
Include both [SKILL.md](SKILL.md) vocabulary and CONTEXT.md vocabulary in the brief so each sub-agent names things consistently with the architecture language and the project's domain language.
|
|
31
|
-
|
|
32
|
-
Each sub-agent outputs:
|
|
33
|
-
|
|
34
|
-
1. Interface (types, methods, params, plus invariants, ordering, error modes)
|
|
35
|
-
2. Usage example showing how callers use it
|
|
36
|
-
3. What the implementation hides behind the seam
|
|
37
|
-
4. Dependency strategy and adapters (see [DEEPENING.md](DEEPENING.md))
|
|
38
|
-
5. Trade-offs: where leverage is high, where it's thin
|
|
39
|
-
|
|
40
|
-
### 3. Present and compare
|
|
41
|
-
|
|
42
|
-
Present designs sequentially so the user can absorb each one, then compare them in prose. Contrast by **depth** (leverage at the interface), **locality** (where change concentrates), and **seam placement**.
|
|
43
|
-
|
|
44
|
-
After comparing, give your own recommendation: which design you think is strongest and why. If elements from different designs would combine well, propose a hybrid. Be opinionated: the user wants a strong read, not a menu.
|
|
@@ -1,114 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: codebase-design
|
|
3
|
-
description: Shared vocabulary for designing deep modules. Use when the user wants to design or improve a module's interface, find deepening opportunities, decide where a seam goes, make code more testable or AI-navigable, or when another skill needs the deep-module vocabulary.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Codebase Design
|
|
7
|
-
|
|
8
|
-
Design **deep modules**: a lot of behaviour behind a small interface, placed at a clean seam, testable through that interface. Use this language and these principles wherever code is being designed or restructured. The aim is leverage for callers, locality for maintainers, and testability for everyone.
|
|
9
|
-
|
|
10
|
-
## Glossary
|
|
11
|
-
|
|
12
|
-
Use these terms exactly: don't substitute "component," "service," "API," or "boundary." Consistent language is the whole point.
|
|
13
|
-
|
|
14
|
-
**Module**: anything with an interface and an implementation. Deliberately scale-agnostic: a function, class, package, or tier-spanning slice. _Avoid_: unit, component, service.
|
|
15
|
-
|
|
16
|
-
**Interface**: everything a caller must know to use the module correctly: the type signature, but also invariants, ordering constraints, error modes, required configuration, and performance characteristics. _Avoid_: API, signature (too narrow, they refer only to the type-level surface).
|
|
17
|
-
|
|
18
|
-
**Implementation**: what's inside a module, its body of code. Distinct from **Adapter**: a thing can be a small adapter with a large implementation (a Postgres repo) or a large adapter with a small implementation (an in-memory fake). Reach for "adapter" when the seam is the topic; "implementation" otherwise.
|
|
19
|
-
|
|
20
|
-
**Depth**: leverage at the interface. The amount of behaviour a caller (or test) can exercise per unit of interface they have to learn. A module is **deep** when a large amount of behaviour sits behind a small interface, **shallow** when the interface is nearly as complex as the implementation.
|
|
21
|
-
|
|
22
|
-
**Seam** _(Michael Feathers)_: a place where you can alter behaviour without editing in that place; the *location* at which a module's interface lives. Where to put the seam is its own design decision, distinct from what goes behind it. _Avoid_: boundary (overloaded with DDD's bounded context).
|
|
23
|
-
|
|
24
|
-
**Adapter**: a concrete thing that satisfies an interface at a seam. Describes *role* (what slot it fills), not substance (what's inside).
|
|
25
|
-
|
|
26
|
-
**Leverage**: what callers get from depth. More capability per unit of interface they learn. One implementation pays back across N call sites and M tests.
|
|
27
|
-
|
|
28
|
-
**Locality**: what maintainers get from depth. Change, bugs, knowledge, and verification concentrate in one place rather than spreading across callers. Fix once, fixed everywhere.
|
|
29
|
-
|
|
30
|
-
## Deep vs shallow
|
|
31
|
-
|
|
32
|
-
**Deep module** = small interface + lots of implementation:
|
|
33
|
-
|
|
34
|
-
```
|
|
35
|
-
┌─────────────────────┐
|
|
36
|
-
│ Small Interface │ ← Few methods, simple params
|
|
37
|
-
├─────────────────────┤
|
|
38
|
-
│ │
|
|
39
|
-
│ Deep Implementation│ ← Complex logic hidden
|
|
40
|
-
│ │
|
|
41
|
-
└─────────────────────┘
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
**Shallow module** = large interface + little implementation (avoid):
|
|
45
|
-
|
|
46
|
-
```
|
|
47
|
-
┌─────────────────────────────────┐
|
|
48
|
-
│ Large Interface │ ← Many methods, complex params
|
|
49
|
-
├─────────────────────────────────┤
|
|
50
|
-
│ Thin Implementation │ ← Just passes through
|
|
51
|
-
└─────────────────────────────────┘
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
When designing an interface, ask:
|
|
55
|
-
|
|
56
|
-
- Can I reduce the number of methods?
|
|
57
|
-
- Can I simplify the parameters?
|
|
58
|
-
- Can I hide more complexity inside?
|
|
59
|
-
|
|
60
|
-
## Principles
|
|
61
|
-
|
|
62
|
-
- **Depth is a property of the interface, not the implementation.** A deep module can be internally composed of small, mockable, swappable parts; they just aren't part of the interface. A module can have **internal seams** (private to its implementation, used by its own tests) as well as the **external seam** at its interface.
|
|
63
|
-
- **The deletion test.** Imagine deleting the module. If complexity vanishes, it was a pass-through. If complexity reappears across N callers, it was earning its keep.
|
|
64
|
-
- **The interface is the test surface.** Callers and tests cross the same seam. If you want to test *past* the interface, the module is probably the wrong shape.
|
|
65
|
-
- **One adapter means a hypothetical seam. Two adapters means a real one.** Don't introduce a seam unless something actually varies across it.
|
|
66
|
-
|
|
67
|
-
## Designing for testability
|
|
68
|
-
|
|
69
|
-
Good interfaces make testing natural:
|
|
70
|
-
|
|
71
|
-
1. **Accept dependencies, don't create them.**
|
|
72
|
-
|
|
73
|
-
```typescript
|
|
74
|
-
// Testable
|
|
75
|
-
function processOrder(order, paymentGateway) {}
|
|
76
|
-
|
|
77
|
-
// Hard to test
|
|
78
|
-
function processOrder(order) {
|
|
79
|
-
const gateway = new StripeGateway();
|
|
80
|
-
}
|
|
81
|
-
```
|
|
82
|
-
|
|
83
|
-
2. **Return results, don't produce side effects.**
|
|
84
|
-
|
|
85
|
-
```typescript
|
|
86
|
-
// Testable
|
|
87
|
-
function calculateDiscount(cart): Discount {}
|
|
88
|
-
|
|
89
|
-
// Hard to test
|
|
90
|
-
function applyDiscount(cart): void {
|
|
91
|
-
cart.total -= discount;
|
|
92
|
-
}
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
3. **Small surface area.** Fewer methods = fewer tests needed. Fewer params = simpler test setup.
|
|
96
|
-
|
|
97
|
-
## Relationships
|
|
98
|
-
|
|
99
|
-
- A **Module** has exactly one **Interface** (the surface it presents to callers and tests).
|
|
100
|
-
- **Depth** is a property of a **Module**, measured against its **Interface**.
|
|
101
|
-
- A **Seam** is where a **Module**'s **Interface** lives.
|
|
102
|
-
- An **Adapter** sits at a **Seam** and satisfies the **Interface**.
|
|
103
|
-
- **Depth** produces **Leverage** for callers and **Locality** for maintainers.
|
|
104
|
-
|
|
105
|
-
## Rejected framings
|
|
106
|
-
|
|
107
|
-
- **Depth as ratio of implementation-lines to interface-lines** (Ousterhout): rewards padding the implementation. We use depth-as-leverage instead.
|
|
108
|
-
- **"Interface" as the TypeScript `interface` keyword or a class's public methods**: too narrow: interface here includes every fact a caller must know.
|
|
109
|
-
- **"Boundary"**: overloaded with DDD's bounded context. Say **seam** or **interface**.
|
|
110
|
-
|
|
111
|
-
## Going deeper
|
|
112
|
-
|
|
113
|
-
- **Deepening a cluster given its dependencies**, see [DEEPENING.md](DEEPENING.md): dependency categories, seam discipline, and replace-don't-layer testing.
|
|
114
|
-
- **Exploring alternative interfaces**, see [DESIGN-IT-TWICE.md](DESIGN-IT-TWICE.md): spin up parallel sub-agents to design the interface several radically different ways, then compare on depth, locality, and seam placement.
|
|
@@ -1,43 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: diagnose-fix
|
|
3
|
-
description: "Complete diagnosis→fix→regression channel for bugs and performance regressions: diagnose, then fix behind observed red regression evidence. Functional bugs require a failing regression test; performance regressions may use a benchmark/perf harness with an explicit failing threshold. Use when the user says diagnose/debug/fix this, or reports something broken/throwing/failing/slow — prefer this over diagnosing-bugs when a fix is wanted, not just a diagnosis."
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Diagnose Fix
|
|
7
|
-
|
|
8
|
-
本 skill 只连接诊断、受保护的最小修复和回归三个阶段。诊断细节以 [`diagnosing-bugs`](.agents/skills/diagnosing-bugs/SKILL.md) 为事实源,普通功能 bug 的红绿语义以 [`tdd`](.agents/skills/tdd/SKILL.md) 为事实源;不复制两个上游的完整步骤。
|
|
9
|
-
|
|
10
|
-
## 流程
|
|
11
|
-
|
|
12
|
-
### ① 诊断
|
|
13
|
-
|
|
14
|
-
委托 `diagnosing-bugs` 完成修复前的诊断活动:建立能捕捉用户症状的 tight feedback loop,实际复现并最小化,再形成可证伪的假设并按单变量探针验证。不要依赖固定 Phase 编号;以上游当前“进入修复前必须完成的诊断出口”为事实源。
|
|
15
|
-
|
|
16
|
-
出口:反馈回路已实际变红,最小复现已确认,且导致症状的假设已有证据;此阶段不写修复代码。
|
|
17
|
-
|
|
18
|
-
### ② 受保护的最小修复
|
|
19
|
-
|
|
20
|
-
先判断 Red 证据类型:
|
|
21
|
-
|
|
22
|
-
- **功能 bug**:在正确的公共 seam 上提出回归测试边界,遵循 `tdd` 要求获得用户确认;把最小复现转成失败回归测试并实际看到 Red,再写最小修复直到 Green。
|
|
23
|
-
- **性能回归**:复用 `diagnosing-bugs` 的 performance branch,建立可重复的 benchmark、timing harness、query-count 或 profiler-derived threshold;必须先实际观察到该阈值失败,再做最小修复,并用同一测量方式确认转绿。不为满足形式强造一个无法代表真实性能症状的普通单元测试。
|
|
24
|
-
|
|
25
|
-
**硬门槛:**不存在已实际观察到的 **red-capable regression evidence** 时,不得写修复代码。功能 bug 的证据必须是正确 seam 上的失败回归测试;性能回归可使用带明确阈值且可重复的 benchmark/perf harness。不存在正确 seam 或可靠性能测量边界时,本身就是 finding;记录阻塞,不绕过证据直接修改。
|
|
26
|
-
|
|
27
|
-
出口:功能 bug 为 regression test Red → 最小修复 → Green;性能回归为 benchmark/perf threshold Red → 最小修复 → Green。两者都不进入 `tdd-implement` 的长流程。
|
|
28
|
-
|
|
29
|
-
### ③ 回归收尾
|
|
30
|
-
|
|
31
|
-
按 `diagnosing-bugs` 的收尾要求重跑阶段 ① 的原始、未最小化反馈回路,确认用户症状消失;功能 bug 重跑回归测试,性能回归重跑原始基准/测量;清理 `[DEBUG-...]` 探针和一次性 harness,并记录最终验证的假设。
|
|
32
|
-
|
|
33
|
-
出口:原始症状消失、对应 regression evidence 为 Green、临时诊断产物已清理。
|
|
34
|
-
|
|
35
|
-
## 回合连续性
|
|
36
|
-
|
|
37
|
-
诊断 → Red 证据 → 修复 → Green → 原始回路 → 清理在一个回合内连续推进。只有功能 bug 的 seam 确认、发现无正确 seam/测量边界、外部环境阻塞或整个阶段出口可以暂停;预告下一步后立即执行。
|
|
38
|
-
|
|
39
|
-
## 引用
|
|
40
|
-
|
|
41
|
-
- 诊断与性能分支:[`diagnosing-bugs`](.agents/skills/diagnosing-bugs/SKILL.md)
|
|
42
|
-
- 功能 bug 修复:[`tdd`](.agents/skills/tdd/SKILL.md)
|
|
43
|
-
- 负向边界:[`references/anti-patterns.md`](references/anti-patterns.md)
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
# 反模式清单(Diagnose-Fix)
|
|
2
|
-
|
|
3
|
-
SKILL.md 正文各阶段规则是正面约束;本文件是负向边界(不做什么),为细节唯一出处。SKILL.md 只引用本文件,不重复内容。
|
|
4
|
-
|
|
5
|
-
## 诊断阶段
|
|
6
|
-
|
|
7
|
-
- 不跳过反馈回路直接猜根因:回路未红之前不进入假设、不写修复代码
|
|
8
|
-
- 功能 bug 不把最小复现永久留在 harness 里:必须转写为正确 seam 上的回归测试;性能回归可保留最小、可重复且有明确阈值的 benchmark/perf harness 作为回归证据
|
|
9
|
-
- 不一次改多个变量:探针一次只改一个,`[DEBUG-...]` 前缀标记
|
|
10
|
-
|
|
11
|
-
## 修复阶段
|
|
12
|
-
|
|
13
|
-
- 不绕过 red-capable regression evidence 直接改代码——功能 bug 没有正确 seam 是 finding;性能回归没有可靠测量边界同样是 finding,不是豁免
|
|
14
|
-
- 不为性能问题强造一个不能代表真实慢路径的普通单元测试;优先复用 diagnosis 中已经验证过的 benchmark、timing、query-count 或 profiler-derived threshold
|
|
15
|
-
- 不套用 tdd-implement 重流程:单个 bug/perf regression 的修复保持轻量,不引入完整 delivery orchestration
|
|
16
|
-
- 不重写 tdd 技能的红-绿语义:功能 bug 的 seam 定义、好测试标准、mocking 边界一律查上游技能
|
|
17
|
-
|
|
18
|
-
## 回归阶段
|
|
19
|
-
|
|
20
|
-
- 不遗留探针:`[DEBUG-...]` 前缀的临时改动在回归验证后全部清理
|
|
21
|
-
- 不跳过原始反馈回路的重跑:最小化场景绿 ≠ 原始症状消失
|
|
@@ -1,138 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: diagnosing-bugs
|
|
3
|
-
description: Diagnosis loop for hard bugs and performance regressions. Use when the user says "diagnose"/"debug this", or reports something broken/throwing/failing/slow.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Diagnosing Bugs
|
|
7
|
-
|
|
8
|
-
A discipline for hard bugs. Skip phases only when explicitly justified.
|
|
9
|
-
|
|
10
|
-
When exploring the codebase, read `CONTEXT.md` (if it exists) to get a clear mental model of the relevant modules, and check ADRs in the area you're touching.
|
|
11
|
-
|
|
12
|
-
## Redact
|
|
13
|
-
|
|
14
|
-
This skill has you show commands, outputs and captured artifacts. **Redact every secret first**: write `<REDACTED>` in its place. Build loops against env vars, so the credential stays in the environment rather than in what you show. Captured artifacts carry auth headers: quote only the lines that carry the signal.
|
|
15
|
-
|
|
16
|
-
If the redacted output is not enough to diagnose the bug, say so and ask the user.
|
|
17
|
-
|
|
18
|
-
## Phase 1: Build a feedback loop
|
|
19
|
-
|
|
20
|
-
**This is the skill.** Everything else is mechanical. If you have a **tight** pass/fail signal for the bug (one that goes red on _this_ bug), you will find the cause; bisection, hypothesis-testing, and instrumentation all just consume it. If you don't have one, no amount of staring at code will save you.
|
|
21
|
-
|
|
22
|
-
Spend disproportionate effort here. **Be aggressive. Be creative. Refuse to give up.**
|
|
23
|
-
|
|
24
|
-
### Ways to construct one, in roughly this order
|
|
25
|
-
|
|
26
|
-
1. **Failing test** at whatever seam reaches the bug: unit, integration, e2e.
|
|
27
|
-
2. **Curl / HTTP script** against a running dev server.
|
|
28
|
-
3. **CLI invocation** with a fixture input, diffing stdout against a known-good snapshot.
|
|
29
|
-
4. **Headless browser script** (Playwright / Puppeteer) that drives the UI and asserts on DOM/console/network.
|
|
30
|
-
5. **Replay a captured trace.** Save a real network request / payload / event log to disk; replay it through the code path in isolation.
|
|
31
|
-
6. **Throwaway harness.** Spin up a minimal subset of the system (one service, mocked deps) that exercises the bug code path with a single function call.
|
|
32
|
-
7. **Property / fuzz loop.** If the bug is "sometimes wrong output", run 1000 random inputs and look for the failure mode.
|
|
33
|
-
8. **Bisection harness.** If the bug appeared between two known states (commit, dataset, version), automate "boot at state X, check, repeat" so you can `git bisect run` it.
|
|
34
|
-
9. **Differential loop.** Run the same input through old-version vs new-version (or two configs) and diff outputs.
|
|
35
|
-
10. **HITL bash script.** Last resort. If a human must click, drive _them_ with `scripts/hitl-loop.template.sh` so the loop is still structured. Captured output feeds back to you.
|
|
36
|
-
|
|
37
|
-
Build the right feedback loop, and the bug is 90% fixed.
|
|
38
|
-
|
|
39
|
-
### Tighten the loop
|
|
40
|
-
|
|
41
|
-
Treat the loop as a product. Once you have _a_ loop, **tighten** it:
|
|
42
|
-
|
|
43
|
-
- Can I make it faster? (Cache setup, skip unrelated init, narrow the test scope.)
|
|
44
|
-
- Can I make the signal sharper? (Assert on the specific symptom, not "didn't crash".)
|
|
45
|
-
- Can I make it more deterministic? (Pin time, seed RNG, isolate filesystem, freeze network.)
|
|
46
|
-
|
|
47
|
-
A 30-second flaky loop is barely better than no loop; a 2-second deterministic one is tight, a debugging superpower.
|
|
48
|
-
|
|
49
|
-
### Non-deterministic bugs
|
|
50
|
-
|
|
51
|
-
The goal is not a clean repro but a **higher reproduction rate**. Loop the trigger 100×, parallelise, add stress, narrow timing windows, inject sleeps. A 50%-flake bug is debuggable; 1% is not, so keep raising the rate until it's debuggable.
|
|
52
|
-
|
|
53
|
-
### When you genuinely cannot build a loop
|
|
54
|
-
|
|
55
|
-
Stop and say so explicitly. List what you tried. Ask the user for: (a) access to whatever environment reproduces it, (b) a redacted captured artifact (HAR file, log dump, core dump, screen recording with timestamps), or (c) permission to add temporary production instrumentation. Do **not** proceed to hypothesise without a loop.
|
|
56
|
-
|
|
57
|
-
### Completion criterion: a tight loop that goes red
|
|
58
|
-
|
|
59
|
-
Phase 1 is done when the loop is **tight** and **red-capable**: you can name **one command** (a script path, a test invocation, a curl) that you have **already run at least once** (show the invocation and its output, redacted), and that is:
|
|
60
|
-
|
|
61
|
-
- [ ] **Red-capable**: it drives the actual bug code path and asserts the **user's exact symptom**, so it can go red on this bug and green once fixed. Not "runs without erroring"; it must be able to _catch this specific bug_.
|
|
62
|
-
- [ ] **Deterministic**: same verdict every run (flaky bugs: a pinned, high reproduction rate, per above).
|
|
63
|
-
- [ ] **Fast**: seconds, not minutes.
|
|
64
|
-
- [ ] **Agent-runnable**: you can run it unattended; a human in the loop only via `scripts/hitl-loop.template.sh`.
|
|
65
|
-
|
|
66
|
-
If you catch yourself reading code to build a theory before this command exists, **stop: jumping straight to a hypothesis is the exact failure this skill prevents.** No red-capable command, no Phase 2.
|
|
67
|
-
|
|
68
|
-
## Phase 2: Reproduce + minimise
|
|
69
|
-
|
|
70
|
-
Run the loop. Watch it go red as the bug appears.
|
|
71
|
-
|
|
72
|
-
Confirm:
|
|
73
|
-
|
|
74
|
-
- [ ] The loop produces the failure mode the **user** described, not a different failure that happens to be nearby. Wrong bug = wrong fix.
|
|
75
|
-
- [ ] The failure is reproducible across multiple runs (or, for non-deterministic bugs, reproducible at a high enough rate to debug against).
|
|
76
|
-
- [ ] You have captured the exact symptom (error message, wrong output, slow timing) so later phases can verify the fix actually addresses it.
|
|
77
|
-
|
|
78
|
-
### Minimise
|
|
79
|
-
|
|
80
|
-
Once it's red, shrink the repro to the **smallest scenario that still goes red**. Cut inputs, callers, config, data, and steps **one at a time**, re-running the loop after each cut, and keep only what's load-bearing for the failure.
|
|
81
|
-
|
|
82
|
-
Why bother: a minimal repro shrinks the hypothesis space in Phase 3 (fewer moving parts left to suspect) and becomes the clean regression test in Phase 5.
|
|
83
|
-
|
|
84
|
-
Done when **every remaining element is load-bearing**: removing any one of them makes the loop go green.
|
|
85
|
-
|
|
86
|
-
Do not proceed until you have reproduced **and** minimised.
|
|
87
|
-
|
|
88
|
-
## Phase 3: Hypothesise
|
|
89
|
-
|
|
90
|
-
Generate **3–5 ranked hypotheses** before testing any of them. Single-hypothesis generation anchors on the first plausible idea.
|
|
91
|
-
|
|
92
|
-
Each hypothesis must be **falsifiable**: state the prediction it makes.
|
|
93
|
-
|
|
94
|
-
> Format: "If <X> is the cause, then <changing Y> will make the bug disappear / <changing Z> will make it worse."
|
|
95
|
-
|
|
96
|
-
If you cannot state the prediction, the hypothesis is a vibe: discard or sharpen it.
|
|
97
|
-
|
|
98
|
-
**Show the ranked list to the user before testing.** They often have domain knowledge that re-ranks instantly ("we just deployed a change to #3"), or know hypotheses they've already ruled out. Cheap checkpoint, big time saver. Don't block on it; proceed with your ranking if the user is AFK.
|
|
99
|
-
|
|
100
|
-
## Phase 4: Instrument
|
|
101
|
-
|
|
102
|
-
Each probe must map to a specific prediction from Phase 3. **Change one variable at a time.**
|
|
103
|
-
|
|
104
|
-
Tool preference:
|
|
105
|
-
|
|
106
|
-
1. **Debugger / REPL inspection** if the env supports it. One breakpoint beats ten logs.
|
|
107
|
-
2. **Targeted logs** at the boundaries that distinguish hypotheses.
|
|
108
|
-
3. Never "log everything and grep".
|
|
109
|
-
|
|
110
|
-
**Tag every debug log** with a unique prefix, e.g. `[DEBUG-a4f2]`. Cleanup at the end becomes a single grep. Untagged logs survive; tagged logs die.
|
|
111
|
-
|
|
112
|
-
**Perf branch.** For performance regressions, logs are usually wrong. Instead: establish a baseline measurement (timing harness, `performance.now()`, profiler, query plan), then bisect. Measure first, fix second.
|
|
113
|
-
|
|
114
|
-
## Phase 5: Fix + regression test
|
|
115
|
-
|
|
116
|
-
Write the regression test **before the fix**, but only if there is a **correct seam** for it.
|
|
117
|
-
|
|
118
|
-
A correct seam is one where the test exercises the **real bug pattern** as it occurs at the call site. If the only available seam is too shallow (single-caller test when the bug needs multiple callers, unit test that can't replicate the chain that triggered the bug), a regression test there gives false confidence.
|
|
119
|
-
|
|
120
|
-
**If no correct seam exists, that itself is the finding.** Note it. The codebase architecture is preventing the bug from being locked down. Flag this for the next phase.
|
|
121
|
-
|
|
122
|
-
If a correct seam exists:
|
|
123
|
-
|
|
124
|
-
1. Turn the minimised repro into a failing test at that seam.
|
|
125
|
-
2. Watch it fail.
|
|
126
|
-
3. Apply the fix.
|
|
127
|
-
4. Watch it pass.
|
|
128
|
-
5. Re-run the Phase 1 feedback loop against the original (un-minimised) scenario.
|
|
129
|
-
|
|
130
|
-
## Phase 6: Cleanup
|
|
131
|
-
|
|
132
|
-
Required before declaring done:
|
|
133
|
-
|
|
134
|
-
- [ ] Original repro no longer reproduces (re-run the Phase 1 loop)
|
|
135
|
-
- [ ] Regression test passes (or absence of seam is documented)
|
|
136
|
-
- [ ] All `[DEBUG-...]` instrumentation removed (`grep` the prefix)
|
|
137
|
-
- [ ] Throwaway prototypes deleted (or moved to a clearly-marked debug location)
|
|
138
|
-
- [ ] The hypothesis that turned out correct is stated in the commit / PR message, so the next debugger learns
|
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
#!/usr/bin/env bash
|
|
2
|
-
# Human-in-the-loop reproduction loop.
|
|
3
|
-
# Copy this file, edit the steps below, and run it.
|
|
4
|
-
# The agent runs the script; the user follows prompts in their terminal.
|
|
5
|
-
#
|
|
6
|
-
# Usage:
|
|
7
|
-
# bash hitl-loop.template.sh
|
|
8
|
-
#
|
|
9
|
-
# Two helpers:
|
|
10
|
-
# step "<instruction>" → show instruction, wait for Enter
|
|
11
|
-
# capture VAR "<question>" → show question, read response into VAR
|
|
12
|
-
#
|
|
13
|
-
# At the end, captured values are printed as KEY=VALUE for the agent to parse.
|
|
14
|
-
#
|
|
15
|
-
# `capture` prints its value back to the terminal, where the agent reads it,
|
|
16
|
-
# so capture observations, and leave signing in to the user as a `step`.
|
|
17
|
-
|
|
18
|
-
set -euo pipefail
|
|
19
|
-
|
|
20
|
-
step() {
|
|
21
|
-
printf '\n>>> %s\n' "$1"
|
|
22
|
-
read -r -p " [Enter when done] " _
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
capture() {
|
|
26
|
-
local var="$1" question="$2" answer
|
|
27
|
-
printf '\n>>> %s\n' "$question"
|
|
28
|
-
read -r -p " > " answer
|
|
29
|
-
printf -v "$var" '%s' "$answer"
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
# --- edit below ---------------------------------------------------------
|
|
33
|
-
|
|
34
|
-
step "Open the app at http://localhost:3000 and sign in."
|
|
35
|
-
|
|
36
|
-
capture ERRORED "Click the 'Export' button. Did it throw an error? (y/n)"
|
|
37
|
-
|
|
38
|
-
capture ERROR_MSG "Paste the error message (or 'none'):"
|
|
39
|
-
|
|
40
|
-
# --- edit above ---------------------------------------------------------
|
|
41
|
-
|
|
42
|
-
printf '\n--- Captured ---\n'
|
|
43
|
-
printf 'ERRORED=%s\n' "$ERRORED"
|
|
44
|
-
printf 'ERROR_MSG=%s\n' "$ERROR_MSG"
|
|
@@ -1,47 +0,0 @@
|
|
|
1
|
-
# ADR Format
|
|
2
|
-
|
|
3
|
-
ADRs live in `docs/adr/` and use sequential numbering: `0001-slug.md`, `0002-slug.md`, etc.
|
|
4
|
-
|
|
5
|
-
Create the `docs/adr/` directory lazily: only when the first ADR is needed.
|
|
6
|
-
|
|
7
|
-
## Template
|
|
8
|
-
|
|
9
|
-
```md
|
|
10
|
-
# {Short title of the decision}
|
|
11
|
-
|
|
12
|
-
{1-3 sentences: what's the context, what did we decide, and why.}
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
That's it. An ADR can be a single paragraph. The value is in recording *that* a decision was made and *why*, not in filling out sections.
|
|
16
|
-
|
|
17
|
-
## Optional sections
|
|
18
|
-
|
|
19
|
-
Only include these when they add genuine value. Most ADRs won't need them.
|
|
20
|
-
|
|
21
|
-
- **Status** frontmatter (`proposed | accepted | deprecated | superseded by ADR-NNNN`): useful when decisions are revisited
|
|
22
|
-
- **Considered Options**: only when the rejected alternatives are worth remembering
|
|
23
|
-
- **Consequences**: only when non-obvious downstream effects need to be called out
|
|
24
|
-
|
|
25
|
-
## Numbering
|
|
26
|
-
|
|
27
|
-
Scan `docs/adr/` for the highest existing number and increment by one.
|
|
28
|
-
|
|
29
|
-
## When to offer an ADR
|
|
30
|
-
|
|
31
|
-
All three of these must be true:
|
|
32
|
-
|
|
33
|
-
1. **Hard to reverse**: the cost of changing your mind later is meaningful
|
|
34
|
-
2. **Surprising without context**: a future reader will look at the code and wonder "why on earth did they do it this way?"
|
|
35
|
-
3. **The result of a real trade-off**: there were genuine alternatives and you picked one for specific reasons
|
|
36
|
-
|
|
37
|
-
If a decision is easy to reverse, skip it: you'll just reverse it. If it's not surprising, nobody will wonder why. If there was no real alternative, there's nothing to record beyond "we did the obvious thing."
|
|
38
|
-
|
|
39
|
-
### What qualifies
|
|
40
|
-
|
|
41
|
-
- **Architectural shape.** "We're using a monorepo." "The write model is event-sourced, the read model is projected into Postgres."
|
|
42
|
-
- **Integration patterns between contexts.** "Ordering and Billing communicate via domain events, not synchronous HTTP."
|
|
43
|
-
- **Technology choices that carry lock-in.** Database, message bus, auth provider, deployment target. Not every library: just the ones that would take a quarter to swap out.
|
|
44
|
-
- **Boundary and scope decisions.** "Customer data is owned by the Customer context; other contexts reference it by ID only." The explicit no-s are as valuable as the yes-s.
|
|
45
|
-
- **Deliberate deviations from the obvious path.** "We're using manual SQL instead of an ORM because X." Anything where a reasonable reader would assume the opposite. These stop the next engineer from "fixing" something that was deliberate.
|
|
46
|
-
- **Constraints not visible in the code.** "We can't use AWS because of compliance requirements." "Response times must be under 200ms because of the partner API contract."
|
|
47
|
-
- **Rejected alternatives when the rejection is non-obvious.** If you considered GraphQL and picked REST for subtle reasons, record it; otherwise someone will suggest GraphQL again in six months.
|
|
@@ -1,60 +0,0 @@
|
|
|
1
|
-
# CONTEXT.md Format
|
|
2
|
-
|
|
3
|
-
## Structure
|
|
4
|
-
|
|
5
|
-
```md
|
|
6
|
-
# {Context Name}
|
|
7
|
-
|
|
8
|
-
{One or two sentence description of what this context is and why it exists.}
|
|
9
|
-
|
|
10
|
-
## Language
|
|
11
|
-
|
|
12
|
-
**Order**:
|
|
13
|
-
{A one or two sentence description of the term}
|
|
14
|
-
_Avoid_: Purchase, transaction
|
|
15
|
-
|
|
16
|
-
**Invoice**:
|
|
17
|
-
A request for payment sent to a customer after delivery.
|
|
18
|
-
_Avoid_: Bill, payment request
|
|
19
|
-
|
|
20
|
-
**Customer**:
|
|
21
|
-
A person or organization that places orders.
|
|
22
|
-
_Avoid_: Client, buyer, account
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
## Rules
|
|
26
|
-
|
|
27
|
-
- **Be opinionated.** When multiple words exist for the same concept, pick the best one and list the others under `_Avoid_`.
|
|
28
|
-
- **Keep definitions tight.** One or two sentences max. Define what it IS, not what it does.
|
|
29
|
-
- **Only include terms specific to this project's context.** General programming concepts (timeouts, error types, utility patterns) don't belong even if the project uses them extensively. Before adding a term, ask: is this a concept unique to this context, or a general programming concept? Only the former belongs.
|
|
30
|
-
- **Group terms under subheadings** when natural clusters emerge. If all terms belong to a single cohesive area, a flat list is fine.
|
|
31
|
-
|
|
32
|
-
## Single vs multi-context repos
|
|
33
|
-
|
|
34
|
-
**Single context (most repos):** One `CONTEXT.md` at the repo root.
|
|
35
|
-
|
|
36
|
-
**Multiple contexts:** A `CONTEXT-MAP.md` at the repo root lists the contexts, where they live, and how they relate to each other:
|
|
37
|
-
|
|
38
|
-
```md
|
|
39
|
-
# Context Map
|
|
40
|
-
|
|
41
|
-
## Contexts
|
|
42
|
-
|
|
43
|
-
- [Ordering](./src/ordering/CONTEXT.md): receives and tracks customer orders
|
|
44
|
-
- [Billing](./src/billing/CONTEXT.md): generates invoices and processes payments
|
|
45
|
-
- [Fulfillment](./src/fulfillment/CONTEXT.md): manages warehouse picking and shipping
|
|
46
|
-
|
|
47
|
-
## Relationships
|
|
48
|
-
|
|
49
|
-
- **Ordering → Fulfillment**: Ordering emits `OrderPlaced` events; Fulfillment consumes them to start picking
|
|
50
|
-
- **Fulfillment → Billing**: Fulfillment emits `ShipmentDispatched` events; Billing consumes them to generate invoices
|
|
51
|
-
- **Ordering ↔ Billing**: Shared types for `CustomerId` and `Money`
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
The skill infers which structure applies:
|
|
55
|
-
|
|
56
|
-
- If `CONTEXT-MAP.md` exists, read it to find contexts
|
|
57
|
-
- If only a root `CONTEXT.md` exists, single context
|
|
58
|
-
- If neither exists, create a root `CONTEXT.md` lazily when the first term is resolved
|
|
59
|
-
|
|
60
|
-
When multiple contexts exist, infer which one the current topic relates to. If unclear, ask.
|
|
@@ -1,74 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: domain-modeling
|
|
3
|
-
description: Build and sharpen a project's domain model. Use when discussing codebase terminology, writing or editing a CONTEXT.md, or recording or editing an ADR.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Domain Modeling
|
|
7
|
-
|
|
8
|
-
Actively build and sharpen the project's domain model as you design. This is the *active* discipline: challenging terms, inventing edge-case scenarios, and writing the glossary and decisions down the moment they crystallise. (Merely *reading* `CONTEXT.md` for vocabulary is not this skill: that's a one-line habit any skill can do. This skill is for when you're changing the model, not just consuming it.)
|
|
9
|
-
|
|
10
|
-
## File structure
|
|
11
|
-
|
|
12
|
-
Most repos have a single context:
|
|
13
|
-
|
|
14
|
-
```
|
|
15
|
-
/
|
|
16
|
-
├── CONTEXT.md
|
|
17
|
-
├── docs/
|
|
18
|
-
│ └── adr/
|
|
19
|
-
│ ├── 0001-event-sourced-orders.md
|
|
20
|
-
│ └── 0002-postgres-for-write-model.md
|
|
21
|
-
└── src/
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
If a `CONTEXT-MAP.md` exists at the root, the repo has multiple contexts. The map points to where each one lives:
|
|
25
|
-
|
|
26
|
-
```
|
|
27
|
-
/
|
|
28
|
-
├── CONTEXT-MAP.md
|
|
29
|
-
├── docs/
|
|
30
|
-
│ └── adr/ ← system-wide decisions
|
|
31
|
-
├── src/
|
|
32
|
-
│ ├── ordering/
|
|
33
|
-
│ │ ├── CONTEXT.md
|
|
34
|
-
│ │ └── docs/adr/ ← context-specific decisions
|
|
35
|
-
│ └── billing/
|
|
36
|
-
│ ├── CONTEXT.md
|
|
37
|
-
│ └── docs/adr/
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
Create files lazily: only when you have something to write. If no `CONTEXT.md` exists, create one when the first term is resolved. If no `docs/adr/` exists, create it when the first ADR is needed.
|
|
41
|
-
|
|
42
|
-
## During the session
|
|
43
|
-
|
|
44
|
-
### Challenge against the glossary
|
|
45
|
-
|
|
46
|
-
When the user uses a term that conflicts with the existing language in `CONTEXT.md`, call it out immediately. "Your glossary defines 'cancellation' as X, but you seem to mean Y. Which is it?"
|
|
47
|
-
|
|
48
|
-
### Sharpen fuzzy language
|
|
49
|
-
|
|
50
|
-
When the user uses vague or overloaded terms, propose a precise canonical term. "You're saying 'account': do you mean the Customer or the User? Those are different things."
|
|
51
|
-
|
|
52
|
-
### Discuss concrete scenarios
|
|
53
|
-
|
|
54
|
-
When domain relationships are being discussed, stress-test them with specific scenarios. Invent scenarios that probe edge cases and force the user to be precise about the boundaries between concepts.
|
|
55
|
-
|
|
56
|
-
### Cross-reference with code
|
|
57
|
-
|
|
58
|
-
When the user states how something works, check whether the code agrees. If you find a contradiction, surface it: "Your code cancels entire Orders, but you just said partial cancellation is possible. Which is right?"
|
|
59
|
-
|
|
60
|
-
### Update CONTEXT.md inline
|
|
61
|
-
|
|
62
|
-
When a term is resolved, update `CONTEXT.md` right there. Don't batch these up: capture them as they happen. Use the format in [CONTEXT-FORMAT.md](./CONTEXT-FORMAT.md).
|
|
63
|
-
|
|
64
|
-
`CONTEXT.md` should be totally devoid of implementation details. Do not treat `CONTEXT.md` as a spec, a scratch pad, or a repository for implementation decisions. It is a glossary and nothing else.
|
|
65
|
-
|
|
66
|
-
### Offer ADRs sparingly
|
|
67
|
-
|
|
68
|
-
Only offer to create an ADR when all three are true:
|
|
69
|
-
|
|
70
|
-
1. **Hard to reverse**: the cost of changing your mind later is meaningful
|
|
71
|
-
2. **Surprising without context**: a future reader will wonder "why did they do it this way?"
|
|
72
|
-
3. **The result of a real trade-off**: there were genuine alternatives and you picked one for specific reasons
|
|
73
|
-
|
|
74
|
-
If any of the three is missing, skip the ADR. Use the format in [ADR-FORMAT.md](./ADR-FORMAT.md).
|