code-anchored-context 0.1.1 → 0.2.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/.agents/skills/README.md +1 -1
- package/.agents/skills/{development-initiative-context → code-anchored-context}/SKILL.md +38 -38
- package/AGENTS.md +13 -13
- package/README.md +14 -14
- package/bin/code-anchored-context.js +34 -34
- package/{Development → context}/AGENTS.md +13 -13
- package/{Development → context}/README.md +29 -29
- package/{Development → context}/_templates/backlog-item.md +2 -2
- package/{Development → context}/_templates/initiative/README.md +2 -2
- package/{Development → context}/_templates/initiative/backlog.md +2 -2
- package/{Development → context}/_templates/initiative/plan.md +2 -2
- package/{Development → context}/_templates/initiative/release-doc-notes.md +6 -6
- package/{Development → context}/_templates/planned-initiative/README.md +3 -3
- package/{Development → context}/_templates/planned-initiative/release-doc-notes.md +5 -5
- package/{Development → context}/_templates/program/README.md +1 -1
- package/{Development → context}/_templates/program/backlog.md +1 -1
- package/{Development → context}/_templates/program/releases/v0_1_0.md +1 -1
- package/{Development → context}/_templates/release-context/README.md +6 -6
- package/{Development → context}/_templates/release-context/backlog.md +1 -2
- package/{Development → context}/_templates/release-transition.md +7 -7
- package/{Development → context}/backlog/README.md +3 -3
- package/{Development → context}/code-anchored-context-structure.md +12 -12
- package/{Development → context}/code-anchored-context-why.md +8 -8
- package/{Development → context}/code-anchored-context.html +20 -20
- package/{Development → context}/current.md +3 -3
- package/{Development → context}/giving-ai-agents-context-around-code.md +27 -27
- package/{Development → context}/programs/README.md +2 -2
- package/{Development → context}/releases/v0_1_0/README.md +6 -6
- package/{Development → context}/releases/v0_1_0/backlog.md +1 -1
- package/{Development → context}/terminology.md +22 -22
- package/{Documentation → docs}/Welcome.md +6 -6
- package/{Documentation → docs}/_authoring/README.md +4 -4
- package/{Documentation → docs}/_authoring/areas/README.md +1 -1
- package/{Documentation → docs}/_authoring/areas/_template.md +4 -4
- package/{Documentation → docs}/_authoring/terminology.md +1 -1
- package/{Documentation → docs}/_authoring/workflow.md +22 -22
- package/{Documentation → docs}/releases/index.md +1 -1
- package/package.json +19 -18
- /package/{Development → context}/_templates/initiative/architecture.md +0 -0
- /package/{Development → context}/_templates/initiative/brief.html +0 -0
- /package/{Development → context}/_templates/initiative/decisions/ADR-0000-template.md +0 -0
- /package/{Development → context}/_templates/initiative/delivery.md +0 -0
- /package/{Development → context}/_templates/initiative/infrastructure.md +0 -0
- /package/{Development → context}/_templates/initiative/interface.md +0 -0
- /package/{Development → context}/_templates/initiative/operations.md +0 -0
- /package/{Development → context}/_templates/initiative/spec.md +0 -0
- /package/{Development → context}/_templates/initiative/testing.md +0 -0
- /package/{Development → context}/_templates/planned-initiative/architecture.md +0 -0
- /package/{Development → context}/_templates/planned-initiative/backlog.md +0 -0
- /package/{Development → context}/_templates/planned-initiative/decisions/ADR-0000-template.md +0 -0
- /package/{Development → context}/_templates/planned-initiative/delivery.md +0 -0
- /package/{Development → context}/_templates/planned-initiative/infrastructure.md +0 -0
- /package/{Development → context}/_templates/planned-initiative/interface.md +0 -0
- /package/{Development → context}/_templates/planned-initiative/operations.md +0 -0
- /package/{Development → context}/_templates/planned-initiative/plan.md +0 -0
- /package/{Development → context}/_templates/planned-initiative/spec.md +0 -0
- /package/{Development → context}/_templates/planned-initiative/testing.md +0 -0
- /package/{Development → context}/_templates/program/context.md +0 -0
- /package/{Development → context}/_templates/program/decisions/ADR-0000-template.md +0 -0
- /package/{Development → context}/_templates/program/planned-initiatives/.gitkeep +0 -0
- /package/{Development → context}/_templates/program/roadmap.md +0 -0
- /package/{Development → context}/_templates/release-context/initiatives/.gitkeep +0 -0
- /package/{Development → context}/backlog/items/.gitkeep +0 -0
- /package/{Development → context}/releases/v0_1_0/initiatives/.gitkeep +0 -0
- /package/{Documentation → docs}/.order +0 -0
- /package/{Documentation → docs}/_templates/area/README.md +0 -0
- /package/{Documentation → docs}/_templates/area/features/feature-template.md +0 -0
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
#
|
|
1
|
+
# context/
|
|
2
2
|
|
|
3
|
-
This folder is the working memory for active and historical
|
|
4
|
-
|
|
3
|
+
This folder is the working memory for active and historical context in this
|
|
4
|
+
repository.
|
|
5
5
|
|
|
6
6
|
Use it for specs, interface notes, architecture notes, testing notes, delivery
|
|
7
7
|
notes, infrastructure notes, actionable operations notes, ADRs, backlog items,
|
|
8
8
|
implementation plans, and release-documentation notes. Do not use
|
|
9
|
-
`
|
|
9
|
+
`docs/` for in-progress development planning.
|
|
10
10
|
|
|
11
11
|
## Start Here
|
|
12
12
|
|
|
@@ -16,24 +16,24 @@ implementation plans, and release-documentation notes. Do not use
|
|
|
16
16
|
Code-Anchored Context for human-agent collaboration.
|
|
17
17
|
- `terminology.md` defines the shared vocabulary.
|
|
18
18
|
- `current.md` points to the active release context.
|
|
19
|
-
- `programs/` contains durable multi-release
|
|
19
|
+
- `programs/` contains durable multi-release working context.
|
|
20
20
|
- `backlog/` contains deferred isolated work cut from initiatives.
|
|
21
|
-
- `releases/` contains release-scoped
|
|
21
|
+
- `releases/` contains release-scoped working context.
|
|
22
22
|
- `_templates/initiative/` contains the standard initiative shape.
|
|
23
23
|
- `_templates/planned-initiative/` contains the standard future initiative
|
|
24
24
|
shape for scoped program work outside the current release.
|
|
25
25
|
- `_templates/release-context/` contains the standard release folder shell.
|
|
26
26
|
|
|
27
|
-
## Relationship To
|
|
27
|
+
## Relationship To docs/
|
|
28
28
|
|
|
29
|
-
`
|
|
29
|
+
`context/` and `docs/` serve different jobs:
|
|
30
30
|
|
|
31
31
|
| Folder | Meaning | Updated when |
|
|
32
32
|
| --- | --- | --- |
|
|
33
|
-
| `
|
|
34
|
-
| `
|
|
33
|
+
| `context/` | What we are planning, building, deciding, or validating. | During normal development. |
|
|
34
|
+
| `docs/` | What the product does as of a release or tag. | Only during explicit documentation refresh work. |
|
|
35
35
|
|
|
36
|
-
|
|
36
|
+
Working context can feed release documentation, but it is not product
|
|
37
37
|
documentation. Capture that bridge in each initiative's
|
|
38
38
|
`release-doc-notes.md`.
|
|
39
39
|
|
|
@@ -50,16 +50,16 @@ Some context needs to outlive a single release initiative:
|
|
|
50
50
|
|
|
51
51
|
| Place | Use for |
|
|
52
52
|
| --- | --- |
|
|
53
|
-
| `
|
|
54
|
-
| `
|
|
55
|
-
| `
|
|
56
|
-
| `
|
|
53
|
+
| `context/programs/` | Long-lived multi-release efforts, phase history, roadmaps, and durable decisions. |
|
|
54
|
+
| `context/programs/<program>/planned-initiatives/` | Scoped future delivery slices that belong to a program but are not in the current release yet. |
|
|
55
|
+
| `context/backlog/items/` | Deferred isolated work cut from an initiative but worth preserving. |
|
|
56
|
+
| `context/releases/<version>/initiatives/` | Release-scoped delivery slices and historical implementation context. |
|
|
57
57
|
|
|
58
58
|
The rule is:
|
|
59
59
|
|
|
60
60
|
> Active work belongs in a release initiative. Multi-release context belongs in
|
|
61
61
|
> a program. Scoped future program work belongs in a planned initiative.
|
|
62
|
-
> Deferred isolated work belongs in the
|
|
62
|
+
> Deferred isolated work belongs in the context backlog.
|
|
63
63
|
|
|
64
64
|
The delivery-surface rule is:
|
|
65
65
|
|
|
@@ -82,7 +82,7 @@ not copy specs, plans, or ADRs into area-local documents.
|
|
|
82
82
|
## Standard Layout
|
|
83
83
|
|
|
84
84
|
```text
|
|
85
|
-
|
|
85
|
+
context/
|
|
86
86
|
current.md
|
|
87
87
|
programs/
|
|
88
88
|
<program-slug>/
|
|
@@ -140,11 +140,11 @@ Release initiatives should link to their program when one exists. Programs
|
|
|
140
140
|
should link back to the release initiatives that delivered each slice.
|
|
141
141
|
|
|
142
142
|
Do not use a program for a small leftover task. Use
|
|
143
|
-
`
|
|
143
|
+
`context/backlog/items/` for deferred isolated work.
|
|
144
144
|
|
|
145
|
-
##
|
|
145
|
+
## Context Backlog
|
|
146
146
|
|
|
147
|
-
Use `
|
|
147
|
+
Use `context/backlog/items/` for isolated work that was taken out of an
|
|
148
148
|
initiative's scope but should be kept for later. Each backlog item records its
|
|
149
149
|
origin initiative and release.
|
|
150
150
|
|
|
@@ -214,23 +214,23 @@ Use when relevant:
|
|
|
214
214
|
When an initiative produces context that needs to survive after the release:
|
|
215
215
|
|
|
216
216
|
- Move multi-release strategy, roadmap, and durable decisions into
|
|
217
|
-
`
|
|
217
|
+
`context/programs/<program-slug>/`.
|
|
218
218
|
- Move scoped future delivery slices into
|
|
219
|
-
`
|
|
219
|
+
`context/programs/<program-slug>/planned-initiatives/<initiative-slug>/`.
|
|
220
220
|
- Move isolated deferred work into
|
|
221
|
-
`
|
|
221
|
+
`context/backlog/items/<originating-initiative-slug>--<item-slug>.md`.
|
|
222
222
|
- Keep release-scoped plans, implementation history, and final release notes
|
|
223
223
|
inside the original initiative.
|
|
224
224
|
|
|
225
225
|
## Changing The Current Release
|
|
226
226
|
|
|
227
|
-
Changing `
|
|
228
|
-
edit. Use `
|
|
229
|
-
Create missing release folders from `
|
|
227
|
+
Changing `context/current.md` is a release transition, not just a line
|
|
228
|
+
edit. Use `context/_templates/release-transition.md` as the checklist.
|
|
229
|
+
Create missing release folders from `context/_templates/release-context/`.
|
|
230
230
|
|
|
231
231
|
When setting a release as current, agents should scan all program planned
|
|
232
232
|
initiatives for matching `Target release:` metadata and promote matching items
|
|
233
|
-
into `
|
|
233
|
+
into `context/releases/<version>/initiatives/`.
|
|
234
234
|
|
|
235
235
|
The promotion rule is:
|
|
236
236
|
|
|
@@ -241,7 +241,7 @@ The promotion rule is:
|
|
|
241
241
|
When changing behavior, agents should:
|
|
242
242
|
|
|
243
243
|
1. Read the local `AGENTS.md`.
|
|
244
|
-
2. Open `
|
|
244
|
+
2. Open `context/current.md`.
|
|
245
245
|
3. Check the current release's initiatives for matching context.
|
|
246
246
|
4. Use `plan.md` for live alignment, open questions, and rough thinking.
|
|
247
247
|
Promote settled conclusions into the stable initiative files.
|
|
@@ -251,7 +251,7 @@ When changing behavior, agents should:
|
|
|
251
251
|
7. Create or update a program planned initiative when future scoped work is
|
|
252
252
|
clear but belongs outside the current release.
|
|
253
253
|
8. Record future product-doc impact in `release-doc-notes.md`, not in
|
|
254
|
-
`
|
|
254
|
+
`docs/`, unless a human explicitly asks for documentation refresh.
|
|
255
255
|
|
|
256
256
|
The key rule for planning is:
|
|
257
257
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Backlog Item Title
|
|
2
2
|
|
|
3
3
|
Status: Candidate
|
|
4
|
-
Originating initiative: `
|
|
4
|
+
Originating initiative: `context/releases/v0_1_0/initiatives/<initiative-slug>/`
|
|
5
5
|
Originating release: `v0_1_0`
|
|
6
6
|
Area: TBD
|
|
7
7
|
Reason deferred: TBD
|
|
@@ -35,6 +35,6 @@ section and leave the item as a historical record.
|
|
|
35
35
|
|
|
36
36
|
```md
|
|
37
37
|
Status: Promoted
|
|
38
|
-
Promoted to: `
|
|
38
|
+
Promoted to: `context/releases/<version>/initiatives/<initiative-slug>/`
|
|
39
39
|
```
|
|
40
40
|
|
|
@@ -17,7 +17,7 @@ produce.
|
|
|
17
17
|
- Tests or verification: `path/to/...`
|
|
18
18
|
- Delivery, CI/CD, build, or artifacts: `path/to/...`
|
|
19
19
|
- Infrastructure, IaC, or environment config: `path/to/...`
|
|
20
|
-
-
|
|
20
|
+
- Docs or release notes: `path/to/...`
|
|
21
21
|
|
|
22
22
|
Remove entries that do not apply and add the real paths. Prefer naming the
|
|
23
23
|
delivery concern over assuming a specific folder layout.
|
|
@@ -59,5 +59,5 @@ support, observability, rollback, or repair context.
|
|
|
59
59
|
Promote settled conclusions into the stable initiative files.
|
|
60
60
|
- Update `release-doc-notes.md` when shipped behavior or product-facing
|
|
61
61
|
behavior changes.
|
|
62
|
-
- Do not update `
|
|
62
|
+
- Do not update `docs/` from this initiative unless a human
|
|
63
63
|
explicitly asks for release documentation work.
|
|
@@ -19,10 +19,10 @@
|
|
|
19
19
|
Use this section only for work deferred within the active initiative.
|
|
20
20
|
|
|
21
21
|
If a deferred item should outlive this initiative as future isolated work,
|
|
22
|
-
create a backlog item from `
|
|
22
|
+
create a backlog item from `context/_templates/backlog-item.md` under:
|
|
23
23
|
|
|
24
24
|
```text
|
|
25
|
-
|
|
25
|
+
context/backlog/items/<originating-initiative-slug>--<item-slug>.md
|
|
26
26
|
```
|
|
27
27
|
|
|
28
28
|
- None yet.
|
|
@@ -51,7 +51,7 @@ the canonical initiative files.
|
|
|
51
51
|
- [ ] Move settled environment and IaC context into `infrastructure.md`
|
|
52
52
|
- [ ] Move actionable runtime/support concerns into `operations.md`
|
|
53
53
|
- [ ] Move executable work into `backlog.md`
|
|
54
|
-
- [ ] Move multi-release context into `
|
|
55
|
-
- [ ] Move isolated deferred work into `
|
|
54
|
+
- [ ] Move multi-release context into `context/programs/`
|
|
55
|
+
- [ ] Move isolated deferred work into `context/backlog/items/`
|
|
56
56
|
- [ ] Move durable decisions into `decisions/`
|
|
57
57
|
- [ ] Move product-documentation impact into `release-doc-notes.md`
|
|
@@ -1,20 +1,20 @@
|
|
|
1
|
-
# Release
|
|
1
|
+
# Release Doc Notes
|
|
2
2
|
|
|
3
3
|
Use this file to capture product-documentation impact while development is
|
|
4
|
-
in progress. At release time, these notes help refresh `
|
|
4
|
+
in progress. At release time, these notes help refresh `docs/`
|
|
5
5
|
against the final shipped behavior.
|
|
6
6
|
|
|
7
|
-
Do not edit `
|
|
7
|
+
Do not edit `docs/` from normal development work unless a human
|
|
8
8
|
explicitly asks for a documentation refresh or a specific documentation fix.
|
|
9
9
|
|
|
10
10
|
## Product Behavior Changes
|
|
11
11
|
|
|
12
12
|
- None yet.
|
|
13
13
|
|
|
14
|
-
## Candidate
|
|
14
|
+
## Candidate Docs Areas
|
|
15
15
|
|
|
16
|
-
- `
|
|
17
|
-
- `
|
|
16
|
+
- `docs/<Area>/README.md`
|
|
17
|
+
- `docs/<Area>/features/<feature>.md`
|
|
18
18
|
|
|
19
19
|
## QA Or Support Notes
|
|
20
20
|
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
Status: Planned
|
|
4
4
|
Target release: vNEXT
|
|
5
|
-
Program: `
|
|
6
|
-
Promotion target: `
|
|
5
|
+
Program: `context/programs/<program-slug>/`
|
|
6
|
+
Promotion target: `context/releases/vNEXT/initiatives/<initiative-slug>/`
|
|
7
7
|
Promoted to: None
|
|
8
8
|
Promoted on: None
|
|
9
9
|
|
|
@@ -19,7 +19,7 @@ and what outcome it should produce.
|
|
|
19
19
|
- Tests or verification: `path/to/...`
|
|
20
20
|
- Delivery, CI/CD, build, or artifacts: `path/to/...`
|
|
21
21
|
- Infrastructure, IaC, or environment config: `path/to/...`
|
|
22
|
-
-
|
|
22
|
+
- Docs or release notes: `path/to/...`
|
|
23
23
|
|
|
24
24
|
Remove entries that do not apply and add the real paths. Prefer naming the
|
|
25
25
|
delivery concern over assuming a specific folder layout.
|
|
@@ -1,20 +1,20 @@
|
|
|
1
|
-
# Release
|
|
1
|
+
# Release Doc Notes
|
|
2
2
|
|
|
3
3
|
Use this file to capture expected product-documentation impact while future
|
|
4
4
|
work is being planned. When the planned initiative is promoted and later
|
|
5
5
|
implemented, compare these notes against the final shipped behavior.
|
|
6
6
|
|
|
7
|
-
Do not edit `
|
|
7
|
+
Do not edit `docs/` from normal development work unless a human
|
|
8
8
|
explicitly asks for a documentation refresh or a specific documentation fix.
|
|
9
9
|
|
|
10
10
|
## Expected Product Behavior Changes
|
|
11
11
|
|
|
12
12
|
- None yet.
|
|
13
13
|
|
|
14
|
-
## Candidate
|
|
14
|
+
## Candidate Docs Areas
|
|
15
15
|
|
|
16
|
-
- `
|
|
17
|
-
- `
|
|
16
|
+
- `docs/<Area>/README.md`
|
|
17
|
+
- `docs/<Area>/features/<feature>.md`
|
|
18
18
|
|
|
19
19
|
## QA Or Support Notes
|
|
20
20
|
|
|
@@ -59,5 +59,5 @@ this program but are not in the current release yet.
|
|
|
59
59
|
a scoped delivery slice before the target release becomes current.
|
|
60
60
|
- Keep release-scoped implementation history in the relevant release
|
|
61
61
|
initiative.
|
|
62
|
-
- Use `
|
|
62
|
+
- Use `context/backlog/items/` for isolated deferred items that do not
|
|
63
63
|
need a program.
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
This backlog holds future work that belongs to the program as a durable
|
|
4
4
|
multi-release effort.
|
|
5
5
|
|
|
6
|
-
Use `
|
|
6
|
+
Use `context/backlog/items/` instead for isolated deferred work that does
|
|
7
7
|
not need program-level context.
|
|
8
8
|
|
|
9
9
|
Use `planned-initiatives/` instead when future work is already clear enough
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
# vNEXT
|
|
1
|
+
# vNEXT Context
|
|
2
2
|
|
|
3
|
-
This folder contains
|
|
3
|
+
This folder contains working context for the `vNEXT` release.
|
|
4
4
|
|
|
5
5
|
## Navigation
|
|
6
6
|
|
|
@@ -14,20 +14,20 @@ Create an initiative when work is non-trivial, behavior-changing,
|
|
|
14
14
|
cross-project, release-significant, or likely to need future product
|
|
15
15
|
documentation.
|
|
16
16
|
|
|
17
|
-
Use `
|
|
17
|
+
Use `context/_templates/initiative/` as the starting point.
|
|
18
18
|
|
|
19
19
|
## Carry-Forward Rule
|
|
20
20
|
|
|
21
21
|
If an initiative is part of a larger phased effort, link it to a program
|
|
22
|
-
under `
|
|
22
|
+
under `context/programs/`.
|
|
23
23
|
|
|
24
24
|
If isolated work is cut from scope but should be kept for later, create a
|
|
25
|
-
backlog item under `
|
|
25
|
+
backlog item under `context/backlog/items/` and link it back to the
|
|
26
26
|
originating initiative.
|
|
27
27
|
|
|
28
28
|
## Planned Initiative Promotion
|
|
29
29
|
|
|
30
30
|
When this release becomes current, promote matching planned initiatives from
|
|
31
|
-
`
|
|
31
|
+
`context/programs/*/planned-initiatives/` into this release's
|
|
32
32
|
`initiatives/` folder. Leave the planned initiative in place as historical
|
|
33
33
|
planning context and update its status to `Promoted`.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# vNEXT Backlog
|
|
2
2
|
|
|
3
|
-
This file tracks release-level
|
|
3
|
+
This file tracks release-level working context that is not yet captured
|
|
4
4
|
by an initiative, plus a short summary of initiative progress once
|
|
5
5
|
initiatives exist.
|
|
6
6
|
|
|
@@ -11,4 +11,3 @@ No backlog items recorded yet.
|
|
|
11
11
|
## Initiative Summary
|
|
12
12
|
|
|
13
13
|
No initiatives registered yet.
|
|
14
|
-
|
|
@@ -1,23 +1,23 @@
|
|
|
1
1
|
# Release Transition Checklist
|
|
2
2
|
|
|
3
|
-
Use this checklist when changing `
|
|
3
|
+
Use this checklist when changing `context/current.md` to a new current
|
|
4
4
|
release.
|
|
5
5
|
|
|
6
6
|
Target release: vNEXT
|
|
7
7
|
|
|
8
8
|
## Steps
|
|
9
9
|
|
|
10
|
-
- [ ] Update `
|
|
11
|
-
- [ ] Create `
|
|
12
|
-
`
|
|
10
|
+
- [ ] Update `context/current.md` to the target release.
|
|
11
|
+
- [ ] Create `context/releases/<target-release>/` from
|
|
12
|
+
`context/_templates/release-context/` if it does not exist.
|
|
13
13
|
- [ ] Create `README.md`, `backlog.md`, and `initiatives/` for the target
|
|
14
14
|
release if missing.
|
|
15
|
-
- [ ] Scan `
|
|
15
|
+
- [ ] Scan `context/programs/*/planned-initiatives/*/README.md` for
|
|
16
16
|
`Target release: <target-release>`.
|
|
17
17
|
- [ ] For each matching planned initiative, materialize it into:
|
|
18
18
|
|
|
19
19
|
```text
|
|
20
|
-
|
|
20
|
+
context/releases/<target-release>/initiatives/<initiative-slug>/
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
- [ ] Update the promoted release initiative so it links back to the parent
|
|
@@ -26,7 +26,7 @@ Development/releases/<target-release>/initiatives/<initiative-slug>/
|
|
|
26
26
|
|
|
27
27
|
```md
|
|
28
28
|
Status: Promoted
|
|
29
|
-
Promoted to: `
|
|
29
|
+
Promoted to: `context/releases/<target-release>/initiatives/<initiative-slug>/`
|
|
30
30
|
Promoted on: YYYY-MM-DD
|
|
31
31
|
```
|
|
32
32
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Context Backlog
|
|
2
2
|
|
|
3
3
|
This folder stores isolated deferred work that was cut from a release
|
|
4
4
|
initiative but should remain discoverable.
|
|
@@ -10,8 +10,8 @@ Use a backlog item when:
|
|
|
10
10
|
- it does not need durable program-level context
|
|
11
11
|
- it is not active in the current release
|
|
12
12
|
|
|
13
|
-
Create items from `
|
|
14
|
-
`
|
|
13
|
+
Create items from `context/_templates/backlog-item.md` and place them in
|
|
14
|
+
`context/backlog/items/`.
|
|
15
15
|
|
|
16
16
|
When a backlog item is picked up later, do not move or rewrite the original
|
|
17
17
|
item. Mark it as `Promoted` and link to the new release initiative.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Code-Anchored Context: The Structure
|
|
2
2
|
|
|
3
3
|
This is the companion to the
|
|
4
|
-
[reasoning article](code-anchored-context-why.md). It covers how
|
|
4
|
+
[reasoning article](code-anchored-context-why.md). It covers how working
|
|
5
5
|
context is laid out so both humans and agents can navigate it.
|
|
6
6
|
|
|
7
7
|
## Denormalize Navigation, Not Knowledge
|
|
@@ -15,24 +15,24 @@ keeps its own plans, cross-project work fragments.
|
|
|
15
15
|
|
|
16
16
|
Local `AGENTS.md` files point agents toward the right place. But plans, specs,
|
|
17
17
|
ADRs, release context, testing strategy, delivery notes, and infrastructure
|
|
18
|
-
context live centrally under `
|
|
18
|
+
context live centrally under `context/`.
|
|
19
19
|
|
|
20
20
|
## The Core Model
|
|
21
21
|
|
|
22
|
-
Vocabulary is captured in `
|
|
22
|
+
Vocabulary is captured in `context/terminology.md`. The main containers:
|
|
23
23
|
|
|
24
24
|
```text
|
|
25
25
|
Program Long-lived multi-release effort.
|
|
26
26
|
Planned initiative A scoped future slice inside a program.
|
|
27
27
|
Release initiative Active or historical work for a specific release.
|
|
28
|
-
|
|
28
|
+
Context backlog item Isolated work cut from scope but worth preserving.
|
|
29
29
|
Program release slice What a release contributes to a program.
|
|
30
30
|
```
|
|
31
31
|
|
|
32
32
|
Each kind of context gets a home:
|
|
33
33
|
|
|
34
34
|
```text
|
|
35
|
-
|
|
35
|
+
context/
|
|
36
36
|
terminology.md
|
|
37
37
|
current.md
|
|
38
38
|
programs/
|
|
@@ -49,7 +49,7 @@ knowledge it preserves, not the tool that produced it.
|
|
|
49
49
|
The main unit of active delivery:
|
|
50
50
|
|
|
51
51
|
```text
|
|
52
|
-
|
|
52
|
+
context/releases/<version>/initiatives/<initiative>/
|
|
53
53
|
README.md plan.md spec.md interface.md architecture.md
|
|
54
54
|
testing.md delivery.md infrastructure.md operations.md
|
|
55
55
|
backlog.md decisions/ release-doc-notes.md
|
|
@@ -85,7 +85,7 @@ Some work is bigger than one release. A program holds durable multi-release
|
|
|
85
85
|
context:
|
|
86
86
|
|
|
87
87
|
```text
|
|
88
|
-
|
|
88
|
+
context/programs/<program>/
|
|
89
89
|
README.md context.md roadmap.md backlog.md
|
|
90
90
|
decisions/ planned-initiatives/ releases/
|
|
91
91
|
```
|
|
@@ -94,20 +94,20 @@ Future work that is clear enough to plan — but whose target release is not
|
|
|
94
94
|
current yet — becomes a planned initiative:
|
|
95
95
|
|
|
96
96
|
```text
|
|
97
|
-
|
|
97
|
+
context/programs/<program>/planned-initiatives/<initiative>/
|
|
98
98
|
```
|
|
99
99
|
|
|
100
100
|
When the target release becomes current, it is promoted into
|
|
101
|
-
`
|
|
101
|
+
`context/releases/<version>/initiatives/<initiative>/`. Promotion is
|
|
102
102
|
explicit; the original planned initiative stays as historical context.
|
|
103
103
|
|
|
104
|
-
##
|
|
104
|
+
## Context Backlog
|
|
105
105
|
|
|
106
106
|
Work cut from scope but worth preserving — when it doesn't justify a program or
|
|
107
107
|
planned initiative — lives in:
|
|
108
108
|
|
|
109
109
|
```text
|
|
110
|
-
|
|
110
|
+
context/backlog/items/<originating-initiative>--<item>.md
|
|
111
111
|
```
|
|
112
112
|
|
|
113
113
|
Each item records where it came from, why it was deferred, future value, and
|
|
@@ -117,7 +117,7 @@ silently rewritten.
|
|
|
117
117
|
## Release Transitions
|
|
118
118
|
|
|
119
119
|
Changing the current release is more than editing a pointer. When
|
|
120
|
-
`
|
|
120
|
+
`context/current.md` moves to a new release, agents should scan program
|
|
121
121
|
planned initiatives, promote items targeting the new release into the release
|
|
122
122
|
folder, update links both ways, and preserve the originals as history.
|
|
123
123
|
|
|
@@ -13,19 +13,19 @@ That context usually exists — in chats, tickets, pull request comments,
|
|
|
13
13
|
planning notes, and people's heads — but agents need it in a structured,
|
|
14
14
|
discoverable form.
|
|
15
15
|
|
|
16
|
-
##
|
|
16
|
+
## Docs vs Working Context
|
|
17
17
|
|
|
18
|
-
This is why I separate **released product documentation** from **
|
|
18
|
+
This is why I separate **released product documentation** from **working
|
|
19
19
|
context**:
|
|
20
20
|
|
|
21
21
|
```text
|
|
22
|
-
|
|
23
|
-
|
|
22
|
+
docs/ What shipped.
|
|
23
|
+
context/ What we are planning, building, deciding, testing,
|
|
24
24
|
shipping, hosting, deferring, and learning.
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
Product documentation stays stable and release-accurate: it describes a known
|
|
28
|
-
release, not an unfinished branch.
|
|
28
|
+
release, not an unfinished branch. Working context is allowed to evolve —
|
|
29
29
|
it is where humans and agents work through ambiguity.
|
|
30
30
|
|
|
31
31
|
## The Principle
|
|
@@ -52,8 +52,8 @@ instead of reconstructing it from memory.
|
|
|
52
52
|
```mermaid
|
|
53
53
|
flowchart LR
|
|
54
54
|
Code["Codebase<br/>What exists"]
|
|
55
|
-
Dev["
|
|
56
|
-
Docs["
|
|
55
|
+
Dev["context/<br/>What is being planned, built, decided, tested, shipped, deferred"]
|
|
56
|
+
Docs["docs/<br/>What shipped in a known release"]
|
|
57
57
|
Agents["Agents and humans"]
|
|
58
58
|
|
|
59
59
|
Agents --> Code
|
|
@@ -73,7 +73,7 @@ Code-Anchored Context is context continuity. It helps agents and humans answer:
|
|
|
73
73
|
- What should become product documentation later?
|
|
74
74
|
- What reasoning needs to survive a change of IDE, agent, or session?
|
|
75
75
|
|
|
76
|
-
Code tells an agent *what exists*.
|
|
76
|
+
Code tells an agent *what exists*. Working context tells it *why* it
|
|
77
77
|
exists, where it is going, what has been decided, and what was left for later.
|
|
78
78
|
|
|
79
79
|
For the concrete folder layout, see the companion article,
|