@heihei0299/matt-skills 1.3.0 → 1.3.2
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/.agents/skills/ask-matt/PHASE-BOUNDARIES.md +55 -0
- package/.agents/skills/ask-matt/SKILL.md +37 -25
- package/.agents/skills/code-review/SKILL.md +28 -35
- package/.agents/skills/codebase-design/DEEPENING.md +4 -4
- package/.agents/skills/codebase-design/DESIGN-IT-TWICE.md +10 -10
- package/.agents/skills/codebase-design/SKILL.md +13 -13
- package/.agents/skills/diagnosing-bugs/SKILL.md +34 -30
- package/.agents/skills/diagnosing-bugs/scripts/hitl-loop.template.sh +3 -0
- package/.agents/skills/domain-modeling/ADR-FORMAT.md +11 -11
- package/.agents/skills/domain-modeling/CONTEXT-FORMAT.md +3 -3
- package/.agents/skills/domain-modeling/SKILL.md +10 -10
- package/.agents/skills/grill-me/SKILL.md +1 -1
- package/.agents/skills/grill-with-docs/SKILL.md +1 -1
- package/.agents/skills/grilling/SKILL.md +20 -4
- package/.agents/skills/grilling/agents/openai.yaml +1 -1
- package/.agents/skills/handoff/SKILL.md +1 -1
- package/.agents/skills/improve-codebase-architecture/HTML-REPORT.md +19 -19
- package/.agents/skills/improve-codebase-architecture/SKILL.md +21 -21
- package/.agents/skills/prototype/LOGIC.md +30 -42
- package/.agents/skills/prototype/SKILL.md +7 -7
- package/.agents/skills/prototype/UI.md +23 -23
- package/.agents/skills/research/SKILL.md +1 -1
- package/.agents/skills/resolving-merge-conflicts/SKILL.md +1 -1
- package/.agents/skills/setup-matt-pocock-skills/SKILL.md +30 -30
- package/.agents/skills/setup-matt-pocock-skills/domain.md +4 -4
- package/.agents/skills/setup-matt-pocock-skills/issue-tracker-github.md +5 -5
- package/.agents/skills/setup-matt-pocock-skills/issue-tracker-gitlab.md +6 -6
- package/.agents/skills/setup-matt-pocock-skills/issue-tracker-local.md +3 -3
- package/.agents/skills/tdd/SKILL.md +9 -7
- package/.agents/skills/teach/GLOSSARY-FORMAT.md +3 -3
- package/.agents/skills/teach/LEARNING-RECORD-FORMAT.md +10 -10
- package/.agents/skills/teach/MISSION-FORMAT.md +4 -4
- package/.agents/skills/teach/RESOURCES-FORMAT.md +2 -2
- package/.agents/skills/teach/SKILL.md +4 -4
- package/.agents/skills/to-questionnaire/SKILL.md +54 -0
- package/.agents/skills/to-questionnaire/agents/openai.yaml +5 -0
- package/.agents/skills/to-spec/SKILL.md +4 -4
- package/.agents/skills/to-tickets/SKILL.md +16 -16
- package/.agents/skills/triage/AGENT-BRIEF.md +9 -9
- package/.agents/skills/triage/OUT-OF-SCOPE.md +15 -15
- package/.agents/skills/triage/SKILL.md +29 -29
- package/.agents/skills/wait-what/SKILL.md +7 -0
- package/.agents/skills/wait-what/agents/openai.yaml +5 -0
- package/.agents/skills/wayfinder/SKILL.md +37 -37
- package/.agents/skills/wizard/SKILL.md +44 -0
- package/.agents/skills/wizard/agents/openai.yaml +3 -0
- package/.agents/skills/wizard/template.sh +204 -0
- package/.agents/skills/writing-for-agents/SKILL-MECHANICS.md +22 -0
- package/.agents/skills/writing-for-agents/SKILL.md +81 -0
- package/.agents/skills/writing-for-agents/agents/openai.yaml +3 -0
- package/README.md +20 -16
- package/bin/cli.js +90 -58
- package/package.json +1 -1
- package/template/.opencode/CONTEXT.md +4 -0
- package/template/.opencode/commands/{writing-great-skills.md → writing-for-agents.md} +1 -1
- package/template/.opencode/docs/agents/skill-design.md +3 -3
- package/template/.pi/CONTEXT.md +55 -0
- package/template/.pi/docs/agents/runtime-discipline.md +3 -2
- package/template/.pi/docs/agents/skill-design.md +10 -5
- package/template/AGENTS.md +2 -2
- package/.agents/skills/writing-great-skills/GLOSSARY.md +0 -201
- package/.agents/skills/writing-great-skills/SKILL.md +0 -83
- package/.agents/skills/writing-great-skills/agents/openai.yaml +0 -5
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Generate **several radically different UI variations** on a single route, switchable from a floating bottom bar. The user flips between variants in the browser, picks one (or steals bits from each), then throws the rest away.
|
|
4
4
|
|
|
5
|
-
If the question is about logic/state rather than what something looks like
|
|
5
|
+
If the question is about logic/state rather than what something looks like, this is the wrong branch. Use [LOGIC.md](LOGIC.md).
|
|
6
6
|
|
|
7
7
|
## When this is the right shape
|
|
8
8
|
|
|
@@ -11,21 +11,21 @@ If the question is about logic/state rather than what something looks like — w
|
|
|
11
11
|
- "Try a different layout for the settings screen."
|
|
12
12
|
- Any time the user would otherwise spend a day picking between three vague mockups in their head.
|
|
13
13
|
|
|
14
|
-
## Two sub-shapes
|
|
14
|
+
## Two sub-shapes: strongly prefer sub-shape A
|
|
15
15
|
|
|
16
|
-
A UI prototype is much easier to judge when it's **butting up against the rest of the app
|
|
16
|
+
A UI prototype is much easier to judge when it's **butting up against the rest of the app**: real header, real sidebar, real data, real density. A throwaway route on its own is a vacuum: every variant looks fine in isolation. Default to sub-shape A whenever there's a plausible existing page to host the variants. Only reach for sub-shape B if the prototype genuinely has no nearby home.
|
|
17
17
|
|
|
18
|
-
### Sub-shape A
|
|
18
|
+
### Sub-shape A: adjustment to an existing page (preferred)
|
|
19
19
|
|
|
20
|
-
The route already exists. Variants are rendered **on the same route**, gated by a `?variant=` URL search param. The existing data fetching, params, and auth all stay
|
|
20
|
+
The route already exists. Variants are rendered **on the same route**, gated by a `?variant=` URL search param. The existing data fetching, params, and auth all stay. Only the rendering swaps. This is the default; pick it unless there's a specific reason not to.
|
|
21
21
|
|
|
22
|
-
If the prototype is for something that doesn't yet have a page but *would naturally live inside one* (a new section of the dashboard, a new card on the settings screen, a new step in an existing flow)
|
|
22
|
+
If the prototype is for something that doesn't yet have a page but *would naturally live inside one* (a new section of the dashboard, a new card on the settings screen, a new step in an existing flow), it's still sub-shape A. Mount the variants inside the host page.
|
|
23
23
|
|
|
24
|
-
### Sub-shape B
|
|
24
|
+
### Sub-shape B: a new page (last resort)
|
|
25
25
|
|
|
26
|
-
Only use this when the thing being prototyped genuinely has no existing page to live inside
|
|
26
|
+
Only use this when the thing being prototyped genuinely has no existing page to live inside (e.g. an entirely new top-level surface, or a flow that can't be embedded anywhere sensible).
|
|
27
27
|
|
|
28
|
-
Create a **throwaway route** following whatever routing convention the project already uses
|
|
28
|
+
Create a **throwaway route** following whatever routing convention the project already uses. Don't invent a new top-level structure. Name it so it's obviously a prototype (e.g. include the word `prototype` in the path or filename). Same `?variant=` pattern.
|
|
29
29
|
|
|
30
30
|
Before committing to sub-shape B, sanity-check: is there really no existing page this could be embedded in? An empty route hides design problems that a populated one would expose.
|
|
31
31
|
|
|
@@ -35,7 +35,7 @@ In both sub-shapes the floating bottom bar is identical.
|
|
|
35
35
|
|
|
36
36
|
### 1. State the question and pick N
|
|
37
37
|
|
|
38
|
-
Default to **3 variants**. More than 5 stops being radically different and starts being noise
|
|
38
|
+
Default to **3 variants**. More than 5 stops being radically different and starts being noise, so cap there.
|
|
39
39
|
|
|
40
40
|
Write down the plan in one line, in the prototype's location or a top-of-file comment:
|
|
41
41
|
|
|
@@ -51,14 +51,14 @@ Draft each variant. Hold each one to:
|
|
|
51
51
|
- The project's component library / styling system (TailwindCSS, shadcn, MUI, plain CSS, whatever).
|
|
52
52
|
- A clear exported component name, e.g. `VariantA`, `VariantB`, `VariantC`.
|
|
53
53
|
|
|
54
|
-
Variants must be **structurally different
|
|
54
|
+
Variants must be **structurally different**: different layout, different information hierarchy, different primary affordance, not just different colours. Three slightly-tweaked card grids isn't a UI prototype, it's wallpaper. If two drafts come out too similar, redo one with explicit "do not use a card grid" guidance.
|
|
55
55
|
|
|
56
56
|
### 3. Wire them together
|
|
57
57
|
|
|
58
58
|
Create a single switcher component on the route:
|
|
59
59
|
|
|
60
60
|
```tsx
|
|
61
|
-
// pseudo-code
|
|
61
|
+
// pseudo-code, adapt to the project's framework
|
|
62
62
|
const variant = searchParams.get('variant') ?? 'A';
|
|
63
63
|
return (
|
|
64
64
|
<>
|
|
@@ -78,35 +78,35 @@ For sub-shape B (new page): the throwaway route under `/prototype/<name>` mounts
|
|
|
78
78
|
|
|
79
79
|
A small fixed-position bar at the bottom-centre of the screen with three pieces:
|
|
80
80
|
|
|
81
|
-
- **Left arrow
|
|
82
|
-
- **Variant label
|
|
83
|
-
- **Right arrow
|
|
81
|
+
- **Left arrow**: cycles to the previous variant (wraps around).
|
|
82
|
+
- **Variant label**: shows the current variant key and, if the variant exports a name, that name too. e.g. `B (Sidebar layout)`.
|
|
83
|
+
- **Right arrow**: cycles forward (wraps around).
|
|
84
84
|
|
|
85
85
|
Behaviour:
|
|
86
86
|
|
|
87
|
-
- Clicking an arrow updates the URL search param (use the framework's router
|
|
87
|
+
- Clicking an arrow updates the URL search param (use the framework's router, e.g. `router.replace` on Next, `navigate` on React Router, etc) so the variant is shareable and reload-stable.
|
|
88
88
|
- Keyboard: `←` and `→` arrow keys also cycle. Don't intercept arrow keys when an `<input>`, `<textarea>`, or `[contenteditable]` is focused.
|
|
89
89
|
- Visually distinct from the page (e.g. high-contrast pill, subtle shadow) so it's obviously not part of the design being evaluated.
|
|
90
|
-
- Hidden in production builds
|
|
90
|
+
- Hidden in production builds: gate on `process.env.NODE_ENV !== 'production'` or an equivalent check, so a stray prototype merge can't ship the bar to users.
|
|
91
91
|
|
|
92
92
|
Put the switcher in a single shared component so both sub-shapes can reuse it. Locate it wherever shared UI lives in the project.
|
|
93
93
|
|
|
94
94
|
### 5. Hand it over
|
|
95
95
|
|
|
96
|
-
Surface the URL (and the `?variant=` keys). The user will flip through whenever they get to it. The interesting feedback is usually **"I want the header from B with the sidebar from C"
|
|
96
|
+
Surface the URL (and the `?variant=` keys). The user will flip through whenever they get to it. The interesting feedback is usually **"I want the header from B with the sidebar from C"**, which is the actual design they want.
|
|
97
97
|
|
|
98
98
|
### 6. Capture the answer and clean up
|
|
99
99
|
|
|
100
|
-
Once a variant has won, capture the answer
|
|
100
|
+
Once a variant has won, capture the answer (which variant and why), then capture the prototype the way the [SKILL](SKILL.md) describes. Fold the winner into the real code and move the rest onto the throwaway branch, not into main:
|
|
101
101
|
|
|
102
|
-
- **Sub-shape A
|
|
103
|
-
- **Sub-shape B
|
|
102
|
+
- **Sub-shape A**: fold the winner into the existing page; drop the losing variants and the switcher from main.
|
|
103
|
+
- **Sub-shape B**: promote the winning variant to a real route; drop the throwaway route and the switcher from main.
|
|
104
104
|
|
|
105
|
-
The full set of variants is the primary source, so it lands on the throwaway branch, not the bin
|
|
105
|
+
The full set of variants is the primary source, so it lands on the throwaway branch, not the bin, since variant components and the switcher left in the main branch rot fast and confuse the next reader.
|
|
106
106
|
|
|
107
107
|
## Anti-patterns
|
|
108
108
|
|
|
109
109
|
- **Variants that differ only in colour or copy.** That's a tweak, not a prototype. Real variants disagree about structure.
|
|
110
110
|
- **Sharing too much code between variants.** A shared `<Header>` is fine; a shared `<Layout>` defeats the point. Each variant should be free to throw out the layout.
|
|
111
|
-
- **Wiring variants to real mutations.** Read-only prototypes are fine. If a variant needs to mutate, point it at a stub
|
|
111
|
+
- **Wiring variants to real mutations.** Read-only prototypes are fine. If a variant needs to mutate, point it at a stub: the question is "what should this look like", not "does the backend work".
|
|
112
112
|
- **Promoting the prototype directly to production.** The variant code was written under prototype constraints (no tests, minimal error handling). Rewrite it properly when you fold it in.
|
|
@@ -7,6 +7,6 @@ Spin up a **background agent** to do the research, so you keep working while it
|
|
|
7
7
|
|
|
8
8
|
Its job:
|
|
9
9
|
|
|
10
|
-
1. Investigate the question against **primary sources**
|
|
10
|
+
1. Investigate the question against **primary sources** (official docs, source code, specs, first-party APIs), not a secondary write-up of them. Follow every claim back to the source that owns it.
|
|
11
11
|
2. Write the findings to a single Markdown file, citing each claim's source.
|
|
12
12
|
3. Save it where the repo already keeps such notes; match the existing convention, and if there is none, put it somewhere sensible and say where.
|
|
@@ -9,6 +9,6 @@ description: "Use when you need to resolve an in-progress git merge/rebase confl
|
|
|
9
9
|
|
|
10
10
|
3. **Resolve each hunk.** Preserve both intents where possible. Where incompatible, pick the one matching the merge's stated goal and note the trade-off. Do **not** invent new behaviour. Always resolve; never `--abort`.
|
|
11
11
|
|
|
12
|
-
4. Discover the project's **automated checks** and run them
|
|
12
|
+
4. Discover the project's **automated checks** and run them, typically typecheck, then tests, then format. Fix anything the merge broke.
|
|
13
13
|
|
|
14
14
|
5. **Finish the merge/rebase.** Stage everything and commit. If rebasing, continue the rebase process until all commits are rebased.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: setup-matt-pocock-skills
|
|
3
|
-
description: Configure this repo for the engineering skills
|
|
3
|
+
description: "Configure this repo for the engineering skills: set up its issue tracker, triage label vocabulary, and domain doc layout. Run once before first use of the other engineering skills."
|
|
4
4
|
disable-model-invocation: true
|
|
5
5
|
---
|
|
6
6
|
|
|
@@ -8,9 +8,9 @@ disable-model-invocation: true
|
|
|
8
8
|
|
|
9
9
|
Scaffold the per-repo configuration that the engineering skills assume:
|
|
10
10
|
|
|
11
|
-
- **Issue tracker
|
|
12
|
-
- **Triage labels
|
|
13
|
-
- **Domain docs
|
|
11
|
+
- **Issue tracker**: where issues live (GitHub by default; local markdown is also supported out of the box)
|
|
12
|
+
- **Triage labels**: the strings used for the five canonical triage roles
|
|
13
|
+
- **Domain docs**: where `CONTEXT.md` and ADRs live, and the consumer rules for reading them
|
|
14
14
|
|
|
15
15
|
This is a prompt-driven skill, not a deterministic script. Explore, present what you found, confirm with the user, then write.
|
|
16
16
|
|
|
@@ -20,45 +20,45 @@ This is a prompt-driven skill, not a deterministic script. Explore, present what
|
|
|
20
20
|
|
|
21
21
|
Look at the current repo to understand its starting state. Read whatever exists; don't assume:
|
|
22
22
|
|
|
23
|
-
- `git remote -v` and `.git/config
|
|
24
|
-
- `AGENTS.md` and `CLAUDE.md` at the repo root
|
|
23
|
+
- `git remote -v` and `.git/config`: is this a GitHub repo? Which one?
|
|
24
|
+
- `AGENTS.md` and `CLAUDE.md` at the repo root: does either exist? Is there already an `## Agent skills` section in either?
|
|
25
25
|
- `CONTEXT.md` and `CONTEXT-MAP.md` at the repo root
|
|
26
26
|
- `docs/adr/` and any `src/*/docs/adr/` directories
|
|
27
|
-
- `docs/agents
|
|
28
|
-
- `.scratch
|
|
27
|
+
- `docs/agents/`: does this skill's prior output already exist?
|
|
28
|
+
- `.scratch/`: a sign that a local-markdown issue tracker convention is already in use
|
|
29
29
|
- Is the `triage` skill installed? (a `triage` skill folder alongside this one, or `triage` in your available skills.) This decides whether Section B runs at all.
|
|
30
|
-
- Monorepo signals
|
|
30
|
+
- Monorepo signals: a `pnpm-workspace.yaml`, a `workspaces` field in `package.json`, or a populated `packages/*` with its own `src/`. These are present only in a genuinely large multi-package repo; their absence means single-context, which is almost every repo.
|
|
31
31
|
|
|
32
32
|
### 2. Present findings and ask
|
|
33
33
|
|
|
34
|
-
Summarise what's present and what's missing. Then take the sections in order
|
|
34
|
+
Summarise what's present and what's missing. Then take the sections in order. One section, one answer, then the next.
|
|
35
35
|
|
|
36
36
|
Lead each section with the recommended answer so the user can accept it in a word. Give a one-line explainer only when the choice genuinely branches; skip the section entirely when exploration already settled it (Section B when `triage` isn't installed, Section C when there's no monorepo).
|
|
37
37
|
|
|
38
|
-
**Section A
|
|
38
|
+
**Section A: Issue tracker.**
|
|
39
39
|
|
|
40
|
-
> Explainer: The "issue tracker" is where issues live for this repo. Skills like `to-tickets`, `triage`, `to-spec
|
|
40
|
+
> Explainer: The "issue tracker" is where issues live for this repo. Skills like `to-tickets`, `triage`, and `to-spec` read from and write to it. They need to know whether to call `gh issue create`, write a markdown file under `.scratch/`, or follow some other workflow you describe. Pick the place you actually track work for this repo.
|
|
41
41
|
|
|
42
42
|
Default posture: these skills were designed for GitHub. If a `git remote` points at GitHub, propose that. If a `git remote` points at GitLab (`gitlab.com` or a self-hosted host), propose GitLab. Otherwise (or if the user prefers), offer:
|
|
43
43
|
|
|
44
|
-
- **GitHub
|
|
45
|
-
- **GitLab
|
|
46
|
-
- **Local markdown
|
|
47
|
-
- **Other** (Jira, Linear, etc.)
|
|
44
|
+
- **GitHub**: issues live in the repo's GitHub Issues (uses the `gh` CLI)
|
|
45
|
+
- **GitLab**: issues live in the repo's GitLab Issues (uses the [`glab`](https://gitlab.com/gitlab-org/cli) CLI)
|
|
46
|
+
- **Local markdown**: issues live as files under `.scratch/<feature>/` in this repo (good for solo projects or repos without a remote)
|
|
47
|
+
- **Other** (Jira, Linear, etc.): ask the user to describe the workflow in one paragraph; the skill will record it as freeform prose
|
|
48
48
|
|
|
49
|
-
Record the choice in `docs/agents/issue-tracker.md`. The GitHub and GitLab templates carry a "PRs as a request surface" flag, defaulted **off
|
|
49
|
+
Record the choice in `docs/agents/issue-tracker.md`. The GitHub and GitLab templates carry a "PRs as a request surface" flag, defaulted **off**. Leave it off and don't raise it: a user who wants external PRs in the triage queue can flip the flag in the file later.
|
|
50
50
|
|
|
51
|
-
**Section B
|
|
51
|
+
**Section B: Triage label vocabulary.** Skip this section entirely if the `triage` skill isn't installed (exploration told you), since an uninstalled skill needs no labels.
|
|
52
52
|
|
|
53
53
|
If it is installed, ask exactly one question:
|
|
54
54
|
|
|
55
55
|
> Do you want to keep the default triage labels? (recommended: **yes**)
|
|
56
56
|
|
|
57
|
-
The defaults are the five canonical roles, each label string equal to its name: `needs-triage`, `needs-info`, `ready-for-agent`, `ready-for-human`, `wontfix`. On **yes**, write them as-is. Only if the user says no
|
|
57
|
+
The defaults are the five canonical roles, each label string equal to its name: `needs-triage`, `needs-info`, `ready-for-agent`, `ready-for-human`, `wontfix`. On **yes**, write them as-is. Only if the user says no, usually because their tracker already uses other names (e.g. `bug:triage` for `needs-triage`), collect the overrides so `triage` applies existing labels instead of creating duplicates.
|
|
58
58
|
|
|
59
|
-
**Section C
|
|
59
|
+
**Section C: Domain docs.** Default to **single-context** (one `CONTEXT.md` + `docs/adr/` at the repo root). This fits almost every repo; write it without asking.
|
|
60
60
|
|
|
61
|
-
Offer **multi-context**
|
|
61
|
+
Offer **multi-context** (a root `CONTEXT-MAP.md` pointing to per-context `CONTEXT.md` files) only when exploration found monorepo signals. Then confirm which layout they want.
|
|
62
62
|
|
|
63
63
|
### 3. Confirm and edit
|
|
64
64
|
|
|
@@ -75,9 +75,9 @@ Let them edit before writing.
|
|
|
75
75
|
|
|
76
76
|
- If `CLAUDE.md` exists, edit it.
|
|
77
77
|
- Else if `AGENTS.md` exists, edit it.
|
|
78
|
-
- If neither exists, ask the user which one to create
|
|
78
|
+
- If neither exists, ask the user which one to create; don't pick for them.
|
|
79
79
|
|
|
80
|
-
Never create `AGENTS.md` when `CLAUDE.md` already exists (or vice versa)
|
|
80
|
+
Never create `AGENTS.md` when `CLAUDE.md` already exists (or vice versa); always edit the one that's already there.
|
|
81
81
|
|
|
82
82
|
If an `## Agent skills` block already exists in the chosen file, update its contents in-place rather than appending a duplicate. Don't overwrite user edits to the surrounding sections.
|
|
83
83
|
|
|
@@ -96,21 +96,21 @@ The block:
|
|
|
96
96
|
|
|
97
97
|
### Domain docs
|
|
98
98
|
|
|
99
|
-
[one-line summary of layout
|
|
99
|
+
[one-line summary of layout: "single-context" or "multi-context"]. See `docs/agents/domain.md`.
|
|
100
100
|
```
|
|
101
101
|
|
|
102
102
|
Include the `### Triage labels` sub-block, and write `docs/agents/triage-labels.md`, only when `triage` is installed and Section B ran. When it isn't, both are omitted.
|
|
103
103
|
|
|
104
104
|
Then write the docs files using the seed templates in this skill folder as a starting point:
|
|
105
105
|
|
|
106
|
-
- [issue-tracker-github.md](./issue-tracker-github.md)
|
|
107
|
-
- [issue-tracker-gitlab.md](./issue-tracker-gitlab.md)
|
|
108
|
-
- [issue-tracker-local.md](./issue-tracker-local.md)
|
|
109
|
-
- [triage-labels.md](./triage-labels.md)
|
|
110
|
-
- [domain.md](./domain.md)
|
|
106
|
+
- [issue-tracker-github.md](./issue-tracker-github.md): GitHub issue tracker
|
|
107
|
+
- [issue-tracker-gitlab.md](./issue-tracker-gitlab.md): GitLab issue tracker
|
|
108
|
+
- [issue-tracker-local.md](./issue-tracker-local.md): local-markdown issue tracker
|
|
109
|
+
- [triage-labels.md](./triage-labels.md): label mapping (only if `triage` is installed)
|
|
110
|
+
- [domain.md](./domain.md): domain doc consumer rules + layout
|
|
111
111
|
|
|
112
112
|
For "other" issue trackers, write `docs/agents/issue-tracker.md` from scratch using the user's description.
|
|
113
113
|
|
|
114
114
|
### 5. Done
|
|
115
115
|
|
|
116
|
-
Tell the user the setup is complete and which engineering skills will now read from these files. Mention they can edit `docs/agents/*.md` directly later
|
|
116
|
+
Tell the user the setup is complete and which engineering skills will now read from these files. Mention they can edit `docs/agents/*.md` directly later; re-running this skill is only necessary if they want to switch issue trackers or restart from scratch.
|
|
@@ -5,8 +5,8 @@ How the engineering skills should consume this repo's domain documentation when
|
|
|
5
5
|
## Before exploring, read these
|
|
6
6
|
|
|
7
7
|
- **`CONTEXT.md`** at the repo root, or
|
|
8
|
-
- **`CONTEXT-MAP.md`** at the repo root if it exists
|
|
9
|
-
- **`docs/adr
|
|
8
|
+
- **`CONTEXT-MAP.md`** at the repo root if it exists: it points at one `CONTEXT.md` per context. Read each one relevant to the topic.
|
|
9
|
+
- **`docs/adr/`**: read ADRs that touch the area you're about to work in. In multi-context repos, also check `src/<context>/docs/adr/` for context-scoped decisions.
|
|
10
10
|
|
|
11
11
|
If any of these files don't exist, **proceed silently**. Don't flag their absence; don't suggest creating them upfront. The `/domain-modeling` skill (reached via `/grill-with-docs` and `/improve-codebase-architecture`) creates them lazily when terms or decisions actually get resolved.
|
|
12
12
|
|
|
@@ -42,10 +42,10 @@ Multi-context repo (presence of `CONTEXT-MAP.md` at the root):
|
|
|
42
42
|
|
|
43
43
|
When your output names a domain concept (in an issue title, a refactor proposal, a hypothesis, a test name), use the term as defined in `CONTEXT.md`. Don't drift to synonyms the glossary explicitly avoids.
|
|
44
44
|
|
|
45
|
-
If the concept you need isn't in the glossary yet, that's a signal
|
|
45
|
+
If the concept you need isn't in the glossary yet, that's a signal: either you're inventing language the project doesn't use (reconsider) or there's a real gap (note it for `/domain-modeling`).
|
|
46
46
|
|
|
47
47
|
## Flag ADR conflicts
|
|
48
48
|
|
|
49
49
|
If your output contradicts an existing ADR, surface it explicitly rather than silently overriding:
|
|
50
50
|
|
|
51
|
-
> _Contradicts ADR-0007 (event-sourced orders)
|
|
51
|
+
> _Contradicts ADR-0007 (event-sourced orders), but worth reopening because…_
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Issue tracker: GitHub
|
|
2
2
|
|
|
3
|
-
Issues and
|
|
3
|
+
Issues and specs for this repo live as GitHub issues. Use the `gh` CLI for all operations.
|
|
4
4
|
|
|
5
5
|
## Conventions
|
|
6
6
|
|
|
@@ -11,7 +11,7 @@ Issues and PRDs for this repo live as GitHub issues. Use the `gh` CLI for all op
|
|
|
11
11
|
- **Apply / remove labels**: `gh issue edit <number> --add-label "..."` / `--remove-label "..."`
|
|
12
12
|
- **Close**: `gh issue close <number> --comment "..."`
|
|
13
13
|
|
|
14
|
-
Infer the repo from `git remote -v
|
|
14
|
+
Infer the repo from `git remote -v`; `gh` does this automatically when run inside a clone.
|
|
15
15
|
|
|
16
16
|
## Pull requests as a triage surface
|
|
17
17
|
|
|
@@ -23,7 +23,7 @@ When set to `yes`, PRs run through the same labels and states as issues, using t
|
|
|
23
23
|
- **List external PRs for triage**: `gh pr list --state open --json number,title,body,labels,author,authorAssociation,comments` then keep only `authorAssociation` of `CONTRIBUTOR`, `FIRST_TIME_CONTRIBUTOR`, or `NONE` (drop `OWNER`/`MEMBER`/`COLLABORATOR`).
|
|
24
24
|
- **Comment / label / close**: `gh pr comment`, `gh pr edit --add-label`/`--remove-label`, `gh pr close`.
|
|
25
25
|
|
|
26
|
-
GitHub shares one number space across issues and PRs, so a bare `#42` may be either
|
|
26
|
+
GitHub shares one number space across issues and PRs, so a bare `#42` may be either: resolve with `gh pr view 42` and fall back to `gh issue view 42`.
|
|
27
27
|
|
|
28
28
|
## When a skill says "publish to the issue tracker"
|
|
29
29
|
|
|
@@ -39,7 +39,7 @@ Used by `/wayfinder`. The **map** is a single issue with **child** issues as tic
|
|
|
39
39
|
|
|
40
40
|
- **Map**: a single issue labelled `wayfinder:map`, holding the Notes / Decisions-so-far / Fog body. `gh issue create --label wayfinder:map`.
|
|
41
41
|
- **Child ticket**: an issue linked to the map as a GitHub sub-issue (`gh api` on the sub-issues endpoint). Where sub-issues aren't enabled, add the child to a task list in the map body and put `Part of #<map>` at the top of the child body. Labels: `wayfinder:<type>` (`research`/`prototype`/`grilling`/`task`). Once claimed, the ticket is assigned to the driving dev.
|
|
42
|
-
- **Blocking**: GitHub's **native issue dependencies
|
|
42
|
+
- **Blocking**: GitHub's **native issue dependencies**, the canonical, UI-visible representation. Add an edge with `gh api --method POST repos/<owner>/<repo>/issues/<child>/dependencies/blocked_by -F issue_id=<blocker-db-id>`, where `<blocker-db-id>` is the blocker's numeric **database id** (`gh api repos/<owner>/<repo>/issues/<n> --jq .id`, _not_ the `#number` or `node_id`). GitHub reports `issue_dependencies_summary.blocked_by` (open blockers only, the live gate). Where dependencies aren't available, fall back to a `Blocked by: #<n>, #<n>` line at the top of the child body. A ticket is unblocked when every blocker is closed.
|
|
43
43
|
- **Frontier query**: list the map's open children (`gh issue list --state open`, scoped to the map's sub-issues / task list), drop any with an open blocker (`issue_dependencies_summary.blocked_by > 0`, or an open issue in the `Blocked by` line) or an assignee; first in map order wins.
|
|
44
|
-
- **Claim**: `gh issue edit <n> --add-assignee @me
|
|
44
|
+
- **Claim**: `gh issue edit <n> --add-assignee @me`, the session's first write.
|
|
45
45
|
- **Resolve**: `gh issue comment <n> --body "<answer>"`, then `gh issue close <n>`, then append a context pointer (gist + link) to the map's Decisions-so-far.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Issue tracker: GitLab
|
|
2
2
|
|
|
3
|
-
Issues and
|
|
3
|
+
Issues and specs for this repo live as GitLab issues. Use the [`glab`](https://gitlab.com/gitlab-org/cli) CLI for all operations.
|
|
4
4
|
|
|
5
5
|
## Conventions
|
|
6
6
|
|
|
@@ -10,9 +10,9 @@ Issues and PRDs for this repo live as GitLab issues. Use the [`glab`](https://gi
|
|
|
10
10
|
- **Comment on an issue**: `glab issue note <number> --message "..."`. GitLab calls comments "notes".
|
|
11
11
|
- **Apply / remove labels**: `glab issue update <number> --label "..."` / `--unlabel "..."`. Multiple labels can be comma-separated or by repeating the flag.
|
|
12
12
|
- **Close**: `glab issue close <number>`. `glab issue close` does not accept a closing comment, so post the explanation first with `glab issue note <number> --message "..."`, then close.
|
|
13
|
-
- **Merge requests**: GitLab calls PRs "merge requests". Use `glab mr create`, `glab mr view`, `glab mr note`, etc
|
|
13
|
+
- **Merge requests**: GitLab calls PRs "merge requests". Use `glab mr create`, `glab mr view`, `glab mr note`, etc., the same shape as `gh pr ...` with `mr` in place of `pr` and `note`/`--message` in place of `comment`/`--body`.
|
|
14
14
|
|
|
15
|
-
Infer the repo from `git remote -v
|
|
15
|
+
Infer the repo from `git remote -v`; `glab` does this automatically when run inside a clone.
|
|
16
16
|
|
|
17
17
|
## Merge requests as a triage surface
|
|
18
18
|
|
|
@@ -40,7 +40,7 @@ Used by `/wayfinder`. The **map** is a single issue with **child** issues as tic
|
|
|
40
40
|
|
|
41
41
|
- **Map**: a single issue labelled `wayfinder:map`, holding the Notes / Decisions-so-far / Fog body. `glab issue create --label wayfinder:map`. (On GitLab tiers with native epics, an epic may hold the map instead; a labelled issue works everywhere.)
|
|
42
42
|
- **Child ticket**: an issue carrying `Part of #<map>` at the top of its description and labels `wayfinder:<type>` (`research`/`prototype`/`grilling`/`task`). Once claimed, the ticket is assigned to the driving dev.
|
|
43
|
-
- **Blocking**: GitLab's **native blocking link
|
|
44
|
-
- **Frontier query**: `glab issue list -F json` scoped to the map's children, drop any with an open blocker
|
|
45
|
-
- **Claim**: `glab issue update <n> --assignee @me
|
|
43
|
+
- **Blocking**: GitLab's **native blocking link**, the canonical, UI-visible representation. Add it with the `/blocked_by #<n>` quick action, posted as a note (`glab issue note <child> --message "/blocked_by #<blocker>"`). Native blocking links are a Premium/Ultimate feature; on the free tier (or where unavailable) fall back to a `Blocked by: #<n>, #<n>` line at the top of the description. A ticket is unblocked when every blocker is closed.
|
|
44
|
+
- **Frontier query**: `glab issue list -F json` scoped to the map's children, drop any with an open blocker: a native `blocked_by` link to an open issue (`glab api projects/:id/issues/:iid/links`), or an open issue in the `Blocked by` line, or an assignee; first in map order wins.
|
|
45
|
+
- **Claim**: `glab issue update <n> --assignee @me`, the session's first write.
|
|
46
46
|
- **Resolve**: `glab issue note <n> --message "<answer>"`, then `glab issue close <n>`, then append a context pointer (gist + link) to the map's Decisions-so-far.
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# Issue tracker: Local Markdown
|
|
2
2
|
|
|
3
|
-
Issues and specs
|
|
3
|
+
Issues and specs for this repo live as markdown files in `.scratch/`.
|
|
4
4
|
|
|
5
5
|
## Conventions
|
|
6
6
|
|
|
7
7
|
- One feature per directory: `.scratch/<feature-slug>/`
|
|
8
8
|
- The spec is `.scratch/<feature-slug>/spec.md`
|
|
9
|
-
- Implementation issues are one file per ticket at `.scratch/<feature-slug>/issues/<NN>-<slug>.md`, numbered from `01
|
|
9
|
+
- Implementation issues are one file per ticket at `.scratch/<feature-slug>/issues/<NN>-<slug>.md`, numbered from `01`, never a single combined tickets file
|
|
10
10
|
- Triage state is recorded as a `Status:` line near the top of each issue file (see `triage-labels.md` for the role strings)
|
|
11
11
|
- Comments and conversation history append to the bottom of the file under a `## Comments` heading
|
|
12
12
|
|
|
@@ -22,7 +22,7 @@ Read the file at the referenced path. The user will normally pass the path or th
|
|
|
22
22
|
|
|
23
23
|
Used by `/wayfinder`. The **map** is a file with one **child** file per ticket.
|
|
24
24
|
|
|
25
|
-
- **Map**: `.scratch/<effort>/map.md`
|
|
25
|
+
- **Map**: `.scratch/<effort>/map.md` (the Notes / Decisions-so-far / Fog body).
|
|
26
26
|
- **Child ticket**: `.scratch/<effort>/issues/NN-<slug>.md`, numbered from `01`, with the question in the body. A `Type:` line records the ticket type (`research`/`prototype`/`grilling`/`task`); a `Status:` line records `claimed`/`resolved`.
|
|
27
27
|
- **Blocking**: a `Blocked by: NN, NN` line near the top. A ticket is unblocked when every file it lists is `resolved`.
|
|
28
28
|
- **Frontier**: scan `.scratch/<effort>/issues/` for files that are open, unblocked, and unclaimed; first by number wins.
|
|
@@ -5,29 +5,31 @@ description: Test-driven development. Use when the user wants to build features
|
|
|
5
5
|
|
|
6
6
|
# Test-Driven Development
|
|
7
7
|
|
|
8
|
-
TDD is the red → green loop. This skill is the reference that makes that loop produce tests worth keeping: what a good test is, where tests go, the anti-patterns, and the rules of the loop. Every section applies on every cycle
|
|
8
|
+
TDD is the red → green loop. This skill is the reference that makes that loop produce tests worth keeping: what a good test is, where tests go, the anti-patterns, and the rules of the loop. Every section applies on every cycle: consult them before and during the loop, not after.
|
|
9
9
|
|
|
10
10
|
When exploring the codebase, read `CONTEXT.md` (if it exists) so test names and interface vocabulary match the project's domain language, and respect ADRs in the area you're touching.
|
|
11
11
|
|
|
12
12
|
## What a good test is
|
|
13
13
|
|
|
14
|
-
Tests verify behavior through public interfaces, not implementation details. Code can change entirely; tests shouldn't. A good test reads like a specification
|
|
14
|
+
Tests verify behavior through public interfaces, not implementation details. Code can change entirely; tests shouldn't. A good test reads like a specification: "user can checkout with valid cart" tells you exactly what capability exists, and it survives refactors because it doesn't care about internal structure.
|
|
15
15
|
|
|
16
16
|
See [tests.md](tests.md) for examples and [mocking.md](mocking.md) for mocking guidelines.
|
|
17
17
|
|
|
18
|
-
## Seams
|
|
18
|
+
## Seams: where tests go
|
|
19
19
|
|
|
20
20
|
A **seam** is the public boundary you test at: the interface where you observe behavior without reaching inside. Tests live at seams, never against internals.
|
|
21
21
|
|
|
22
|
-
**Test only at pre-agreed seams.** Before writing any test, write down the seams under test and confirm them with the user. No test is written at an unconfirmed seam. You can't test everything
|
|
22
|
+
**Test only at pre-agreed seams.** Before writing any test, write down the seams under test and confirm them with the user. No test is written at an unconfirmed seam. You can't test everything, so agreeing the seams up front is how testing effort lands on the critical paths and complex logic instead of every edge case.
|
|
23
23
|
|
|
24
24
|
Ask: "What's the public interface, and which seams should we test?"
|
|
25
25
|
|
|
26
|
+
When the shape of that interface is itself in question (how deep the module is, where the seam belongs, what the interface should expose), call the Skill tool with "codebase-design" for the vocabulary. It is the shared source of the module, interface, depth, seam, adapter, leverage and locality terms, and it is a reference to consult, not a session to run.
|
|
27
|
+
|
|
26
28
|
## Anti-patterns
|
|
27
29
|
|
|
28
|
-
- **Implementation-coupled
|
|
29
|
-
- **Tautological
|
|
30
|
-
- **Horizontal slicing
|
|
30
|
+
- **Implementation-coupled**: mocks internal collaborators, tests private methods, or verifies through a side channel (querying the database instead of using the interface). The tell: the test breaks when you refactor but behavior hasn't changed.
|
|
31
|
+
- **Tautological**: the assertion recomputes the expected value the way the code does (`expect(add(a, b)).toBe(a + b)`, a snapshot derived by hand the same way, a constant asserted equal to itself), so it passes by construction and can never disagree with the code. Expected values must come from an independent source of truth: a known-good literal, a worked example, the spec.
|
|
32
|
+
- **Horizontal slicing**: writing all tests first, then all implementation. Bulk tests verify _imagined_ behavior: you test the _shape_ of things rather than user-facing behavior, the tests go insensitive to real changes, and you commit to test structure before understanding the implementation. Work in **vertical slices** instead: one test → one implementation → repeat, each test a **tracer bullet** that responds to what the last cycle taught you.
|
|
31
33
|
|
|
32
34
|
## Rules of the loop
|
|
33
35
|
|
|
@@ -16,7 +16,7 @@ Muscle growth driven by mechanical tension and metabolic stress over repeated tr
|
|
|
16
16
|
_Avoid_: Bulking, getting big
|
|
17
17
|
|
|
18
18
|
**Progressive overload**:
|
|
19
|
-
Systematically increasing the demand on a muscle over time
|
|
19
|
+
Systematically increasing the demand on a muscle over time, via load, volume, or intensity.
|
|
20
20
|
_Avoid_: Pushing harder, levelling up
|
|
21
21
|
|
|
22
22
|
**RPE (Rate of Perceived Exertion)**:
|
|
@@ -29,7 +29,7 @@ _Avoid_: Effort score, intensity rating
|
|
|
29
29
|
- **Add a term only when the user understands it.** The glossary is a record of compressed knowledge, not a dictionary the user reads to learn. If the user has just been introduced to a concept, wait until they can use it correctly before promoting it here.
|
|
30
30
|
- **Be opinionated.** When several words exist for the same concept, pick the best one and list the rest as aliases to avoid. This is how language compresses.
|
|
31
31
|
- **Keep definitions tight.** One or two sentences. Define what the term IS, not what it does or how to do it.
|
|
32
|
-
- **Use the glossary's own terms inside definitions.** Once a term is in the glossary, prefer it everywhere
|
|
32
|
+
- **Use the glossary's own terms inside definitions.** Once a term is in the glossary, prefer it everywhere, including inside other definitions. This is what makes complex terms easier to grasp later.
|
|
33
33
|
- **Group under subheadings** when natural clusters emerge (e.g. `## Anatomy`, `## Programming`). A flat list is fine when terms cohere.
|
|
34
|
-
- **Flag ambiguities explicitly.** If a term is used loosely in the wider field, note the resolution: "In this workspace, 'set' always means a working set
|
|
34
|
+
- **Flag ambiguities explicitly.** If a term is used loosely in the wider field, note the resolution: "In this workspace, 'set' always means a working set; warm-ups are tracked separately."
|
|
35
35
|
- **Revise as understanding deepens.** A definition the user wrote in week one may be wrong by week six. Update in place; do not leave stale entries.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Learning Record Format
|
|
2
2
|
|
|
3
|
-
Learning records live in `./learning-records/` and use sequential numbering: `0001-slug.md`, `0002-slug.md`, etc. Create the directory lazily
|
|
3
|
+
Learning records live in `./learning-records/` and use sequential numbering: `0001-slug.md`, `0002-slug.md`, etc. Create the directory lazily: only when the first record is written.
|
|
4
4
|
|
|
5
5
|
They are the teaching equivalent of ADRs: they capture non-obvious lessons, key insights, and stated prior knowledge that will steer future sessions. They are used to calculate the zone of proximal development.
|
|
6
6
|
|
|
@@ -12,15 +12,15 @@ They are the teaching equivalent of ADRs: they capture non-obvious lessons, key
|
|
|
12
12
|
{1-3 sentences: what was learned (or what prior knowledge was established), and why it matters for future sessions.}
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
That is the whole format. A learning record can be a single paragraph. The value is recording _that_ this is now known and _why_ it changes what to teach next
|
|
15
|
+
That is the whole format. A learning record can be a single paragraph. The value is recording _that_ this is now known and _why_ it changes what to teach next, not in filling out sections.
|
|
16
16
|
|
|
17
17
|
## Optional sections
|
|
18
18
|
|
|
19
19
|
Only include these when they add genuine value. Most records won't need them.
|
|
20
20
|
|
|
21
|
-
- **Status** frontmatter (`active | superseded by LR-NNNN`)
|
|
22
|
-
- **Evidence
|
|
23
|
-
- **Implications
|
|
21
|
+
- **Status** frontmatter (`active | superseded by LR-NNNN`): useful when an earlier understanding turns out to be wrong and is replaced.
|
|
22
|
+
- **Evidence**: how the user demonstrated the understanding (a question answered, an exercise completed, prior experience cited). Useful when the claim might be revisited.
|
|
23
|
+
- **Implications**: what this unlocks or rules out for future sessions. Worth recording when non-obvious.
|
|
24
24
|
|
|
25
25
|
## Numbering
|
|
26
26
|
|
|
@@ -30,16 +30,16 @@ Scan `./learning-records/` for the highest existing number and increment by one.
|
|
|
30
30
|
|
|
31
31
|
Write one when any of these is true:
|
|
32
32
|
|
|
33
|
-
1. **The user demonstrated genuine understanding of something non-trivial
|
|
34
|
-
2. **The user disclosed prior knowledge
|
|
35
|
-
3. **A misconception was corrected
|
|
36
|
-
4. **The mission shifted in response to learning
|
|
33
|
+
1. **The user demonstrated genuine understanding of something non-trivial**: not just exposure, but evidence they can use the concept correctly. This sets a new floor for what to teach next.
|
|
34
|
+
2. **The user disclosed prior knowledge**: "I already know X." Record it so future sessions don't re-teach it. Also record the _depth_ claimed.
|
|
35
|
+
3. **A misconception was corrected**: the user previously believed something wrong and now sees why. These are high-value: they predict future stumbling blocks for related topics.
|
|
36
|
+
4. **The mission shifted in response to learning**: the user discovered they cared about something different than they thought. Cross-link to [[MISSION.md]] and update it.
|
|
37
37
|
|
|
38
38
|
### What does _not_ qualify
|
|
39
39
|
|
|
40
40
|
- Material that was merely covered. Coverage is not learning. Wait for evidence.
|
|
41
41
|
- Anything already captured tersely in [[GLOSSARY.md]] as a term definition. Don't duplicate.
|
|
42
|
-
- Session-by-session activity logs. Learning records are not a journal
|
|
42
|
+
- Session-by-session activity logs. Learning records are not a journal: they are decision-grade insights.
|
|
43
43
|
|
|
44
44
|
## Supersession
|
|
45
45
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# MISSION.md Format
|
|
2
2
|
|
|
3
|
-
`MISSION.md` lives at the workspace root. It captures the _reason_ the user is learning this topic. Every teaching decision
|
|
3
|
+
`MISSION.md` lives at the workspace root. It captures the _reason_ the user is learning this topic. Every teaching decision (what to teach next, which resources to surface, which exercises to design) should trace back to this document.
|
|
4
4
|
|
|
5
5
|
## Template
|
|
6
6
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
# Mission: {Topic}
|
|
9
9
|
|
|
10
10
|
## Why
|
|
11
|
-
{1-3 sentences. The concrete real-world goal the user is chasing. What changes in their life or work when they have this skill? Avoid abstract framings like "to understand X"
|
|
11
|
+
{1-3 sentences. The concrete real-world goal the user is chasing. What changes in their life or work when they have this skill? Avoid abstract framings like "to understand X"; push for the underlying outcome.}
|
|
12
12
|
|
|
13
13
|
## Success looks like
|
|
14
14
|
- {A specific, observable thing the user will be able to do}
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
- {Time, budget, prior commitments, learning preferences, anything that bounds the approach}
|
|
20
20
|
|
|
21
21
|
## Out of scope
|
|
22
|
-
- {Adjacent topics the user explicitly does not want to chase right now
|
|
22
|
+
- {Adjacent topics the user explicitly does not want to chase right now, protecting the zone of proximal development}
|
|
23
23
|
```
|
|
24
24
|
|
|
25
25
|
## Rules
|
|
@@ -27,5 +27,5 @@
|
|
|
27
27
|
- **One mission per workspace.** If the user wants to learn two unrelated things, that is two workspaces.
|
|
28
28
|
- **Concrete over abstract.** "Run a half marathon by October" beats "get fitter." "Ship a Rust CLI to my team" beats "learn Rust."
|
|
29
29
|
- **Push back on vagueness.** If the user cannot articulate why, interview them before writing anything. A bad mission is worse than no mission.
|
|
30
|
-
- **Revise when reality shifts.** Missions change. When the user's goal moves, update this file
|
|
30
|
+
- **Revise when reality shifts.** Missions change. When the user's goal moves, update this file: don't leave a stale mission steering future sessions.
|
|
31
31
|
- **Keep it short.** If `MISSION.md` runs past a screen, it has stopped being a compass and started being a plan.
|
|
@@ -9,9 +9,9 @@
|
|
|
9
9
|
|
|
10
10
|
## Knowledge
|
|
11
11
|
|
|
12
|
-
- [Book: _The Science and Practice of Strength Training_
|
|
12
|
+
- [Book: _The Science and Practice of Strength Training_ by Zatsiorsky & Kraemer](https://example.com)
|
|
13
13
|
Foundational text on programming and adaptation. Use for: anything to do with periodisation, recovery, intensity zones.
|
|
14
|
-
- [Article: "How Much Should I Train?"
|
|
14
|
+
- [Article: "How Much Should I Train?" by Greg Nuckols (Stronger By Science)](https://example.com)
|
|
15
15
|
Evidence-based review of volume landmarks. Use for: weekly set targets per muscle group.
|
|
16
16
|
|
|
17
17
|
## Wisdom (Communities)
|
|
@@ -46,9 +46,9 @@ Fluency can give the user an illusory sense of mastery, but storage strength is
|
|
|
46
46
|
|
|
47
47
|
## Lessons
|
|
48
48
|
|
|
49
|
-
A lesson is the main thing you produce
|
|
49
|
+
A lesson is the main thing you produce: the unit in which knowledge and skills reach the user. Each lesson is one self-contained HTML file, saved to `./lessons/` and titled `0001-<dash-case-name>.html` where the number increments each time.
|
|
50
50
|
|
|
51
|
-
A lesson should be **beautiful
|
|
51
|
+
A lesson should be **beautiful**, with clean, readable typography and layout, since the user will return to these later to review. Think Tufte.
|
|
52
52
|
|
|
53
53
|
The lesson should be short, and completable very quickly. Learners' working memory is very small, and we need to stay within it. But each lesson should give the user a single tangible win that they can build on. It should be directly tied to the mission, and should be in the user's zone of proximal development.
|
|
54
54
|
|
|
@@ -62,9 +62,9 @@ Each lesson should contain a reminder to ask followup questions to the agent. Th
|
|
|
62
62
|
|
|
63
63
|
## Assets
|
|
64
64
|
|
|
65
|
-
Lessons are built from reusable **components**, stored in `./assets/`: stylesheets, quiz widgets, simulators, diagram helpers
|
|
65
|
+
Lessons are built from reusable **components**, stored in `./assets/`: stylesheets, quiz widgets, simulators, diagram helpers, and anything else a second lesson could reuse.
|
|
66
66
|
|
|
67
|
-
Reuse is the default, not the exception. Before authoring a lesson, read `./assets/` and build from the components already there. When a lesson needs something new and reusable, write it as a component in `./assets/` and link to it
|
|
67
|
+
Reuse is the default, not the exception. Before authoring a lesson, read `./assets/` and build from the components already there. When a lesson needs something new and reusable, write it as a component in `./assets/` and link to it; never inline code a future lesson would duplicate.
|
|
68
68
|
|
|
69
69
|
A shared stylesheet is the first component every workspace earns: every lesson links it, so the lessons look like one consistent course rather than a pile of one-offs. As the workspace grows, so should the component library.
|
|
70
70
|
|