code-anchored-context 0.2.2 → 0.2.4
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/code-anchored-context/SKILL.md +40 -11
- package/AGENTS.md +18 -15
- package/README.md +16 -12
- package/bin/code-anchored-context.js +17 -11
- package/context/AGENTS.md +9 -3
- package/context/README.md +40 -9
- package/context/_templates/initiative/README.md +5 -3
- package/context/_templates/initiative/delivery.md +4 -0
- package/context/_templates/initiative/infrastructure.md +4 -0
- package/context/_templates/initiative/operations.md +4 -0
- package/context/_templates/initiative/plan.md +2 -2
- package/context/_templates/initiative/release-doc-notes.md +9 -9
- package/context/_templates/initiative/testing.md +4 -0
- package/context/_templates/planned-initiative/README.md +3 -1
- package/context/_templates/planned-initiative/delivery.md +4 -0
- package/context/_templates/planned-initiative/infrastructure.md +4 -0
- package/context/_templates/planned-initiative/operations.md +4 -0
- package/context/_templates/planned-initiative/plan.md +1 -1
- package/context/_templates/planned-initiative/release-doc-notes.md +6 -6
- package/context/_templates/planned-initiative/testing.md +4 -0
- package/context/current.md +4 -0
- package/context/project-profile.md +130 -0
- package/context/terminology.md +6 -2
- package/package.json +5 -4
- package/{product-docs → reference}/README.md +16 -15
- package/{product-docs → reference}/_authoring/README.md +8 -8
- package/{product-docs → reference}/_authoring/areas/README.md +2 -2
- package/{product-docs → reference}/_authoring/areas/_template.md +5 -5
- package/{product-docs → reference}/_authoring/terminology.md +1 -1
- package/{product-docs → reference}/_authoring/workflow.md +50 -46
- package/{product-docs → reference}/releases/index.md +2 -2
- /package/{product-docs → reference}/_templates/area/README.md +0 -0
- /package/{product-docs → reference}/_templates/area/features/feature-template.md +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: code-anchored-context
|
|
3
|
-
description: Use central repository context for planning and implementation. Use when starting, changing, reviewing, or documenting behavior-changing work; when checking or updating context/current.md, context/releases/*/initiatives/*, context/programs/*, context/programs/*/planned-initiatives/*, context/backlog/items/*, specs, plans, interface notes, architecture notes, testing notes, delivery notes, infrastructure notes, actionable operations notes, ADRs, backlog, release-doc-notes.md; when promoting planned initiatives during release transitions; or when deciding whether
|
|
3
|
+
description: Use central repository context for planning and implementation. Use when starting, changing, reviewing, or documenting behavior-changing work; when checking or updating context/current.md, context/project-profile.md, context/releases/*/initiatives/*, context/programs/*, context/programs/*/planned-initiatives/*, context/backlog/items/*, specs, plans, interface notes, architecture notes, testing notes, delivery notes, infrastructure notes, actionable operations notes, ADRs, backlog, release-doc-notes.md; when promoting planned initiatives during release transitions; or when deciding whether reference/ should be left untouched.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Code-Anchored Context
|
|
@@ -16,6 +16,9 @@ Working context should also cover delivery concerns such as testing,
|
|
|
16
16
|
delivery pipelines, and infrastructure when they affect how the work is
|
|
17
17
|
verified, shipped, deployed, or hosted.
|
|
18
18
|
|
|
19
|
+
Repo-specific stack and toolchain facts belong in
|
|
20
|
+
`context/project-profile.md`, not in this reusable skill.
|
|
21
|
+
|
|
19
22
|
## Workflow
|
|
20
23
|
|
|
21
24
|
### 1) Read The Local Rules
|
|
@@ -32,6 +35,24 @@ Use `context/terminology.md` as the canonical vocabulary for programs,
|
|
|
32
35
|
planned initiatives, release initiatives, backlog items, statuses, and
|
|
33
36
|
promotion.
|
|
34
37
|
|
|
38
|
+
Open `context/project-profile.md` when it exists. It is the repo-wide
|
|
39
|
+
operating profile for stack, commands, source roots, verification layers,
|
|
40
|
+
CI/CD, delivery automation, infrastructure, observability, and generated
|
|
41
|
+
artifacts. Use it before inventing default commands or tooling assumptions.
|
|
42
|
+
|
|
43
|
+
If a human explicitly asks for a project profile, tech-stack baseline, or
|
|
44
|
+
repository operating baseline, create or refresh `context/project-profile.md`
|
|
45
|
+
by inspecting source-backed local facts: manifests, lockfiles, runtime version
|
|
46
|
+
files, build config, test config, CI/CD workflows, deployment scripts,
|
|
47
|
+
infrastructure config, observability config, generated-artifact owners, and
|
|
48
|
+
existing docs. Do not guess. Mark unknowns clearly and cite source paths where
|
|
49
|
+
useful.
|
|
50
|
+
|
|
51
|
+
If the human asks for a "baseline" without saying whether they mean an
|
|
52
|
+
operating profile or accepted behavior reference, distinguish
|
|
53
|
+
`context/project-profile.md` from baseline reference under `reference/` before
|
|
54
|
+
editing.
|
|
55
|
+
|
|
35
56
|
If the workspace starts inside a subfolder, navigate upward to the repository
|
|
36
57
|
root when the environment allows it. If `context/` is not available in
|
|
37
58
|
the workspace, mention that limitation in the task summary.
|
|
@@ -50,6 +71,9 @@ Search for:
|
|
|
50
71
|
- the feature or bug name
|
|
51
72
|
- affected concern names, such as product code, APIs, contracts, tests,
|
|
52
73
|
delivery, CI/CD, infrastructure, config, generated artifacts, or automation
|
|
74
|
+
- repo-wide toolchain facts from `context/project-profile.md`, such as test
|
|
75
|
+
commands, e2e tooling, observability tooling, deploy CLIs, source roots,
|
|
76
|
+
generated artifacts, or CI/CD files
|
|
53
77
|
- related domain terms, APIs, jobs, entities, routes, config names, or tickets
|
|
54
78
|
|
|
55
79
|
Use an existing initiative when the work belongs to it, even if the code
|
|
@@ -59,8 +83,8 @@ effort, link it to the relevant program.
|
|
|
59
83
|
### 4) Create An Initiative When Needed
|
|
60
84
|
|
|
61
85
|
Create a new initiative for non-trivial behavior changes, cross-project
|
|
62
|
-
work, release-significant work, or anything likely to need future
|
|
63
|
-
|
|
86
|
+
work, release-significant work, or anything likely to need future reference
|
|
87
|
+
updates.
|
|
64
88
|
|
|
65
89
|
Use `context/_templates/initiative/` as the source. Copy it to:
|
|
66
90
|
|
|
@@ -164,7 +188,10 @@ Use these files as the standard map:
|
|
|
164
188
|
observability, failure modes, rollback, repair, and support tooling
|
|
165
189
|
- `backlog.md`: work slices and implementation progress
|
|
166
190
|
- `decisions/ADR-*.md`: meaningful choices and their consequences
|
|
167
|
-
- `release-doc-notes.md`:
|
|
191
|
+
- `release-doc-notes.md`: reference impact to review at release
|
|
192
|
+
- `context/project-profile.md`: repo-wide stack, command, testing, delivery,
|
|
193
|
+
infrastructure, observability, and generated-artifact facts; update it only
|
|
194
|
+
for stable source-backed discoveries or an explicit baseline request
|
|
168
195
|
|
|
169
196
|
Not every initiative needs every file. Mark a file as not applicable or omit
|
|
170
197
|
it after copying the template when it genuinely does not apply.
|
|
@@ -175,15 +202,14 @@ settled truth lives. Promote stable conclusions into `spec.md`,
|
|
|
175
202
|
`infrastructure.md`, `operations.md` when actionable, `backlog.md`, ADRs, or
|
|
176
203
|
`release-doc-notes.md` as appropriate.
|
|
177
204
|
|
|
178
|
-
### 9) Preserve The
|
|
205
|
+
### 9) Preserve The Reference Boundary
|
|
179
206
|
|
|
180
|
-
Do not edit `
|
|
207
|
+
Do not edit `reference/` as part of normal feature work, bug fixes,
|
|
181
208
|
refactors, or planning. Instead, update the initiative's
|
|
182
209
|
`release-doc-notes.md`.
|
|
183
210
|
|
|
184
|
-
Only update `
|
|
185
|
-
|
|
186
|
-
fix.
|
|
211
|
+
Only update `reference/` when a human explicitly asks for release reference
|
|
212
|
+
work, a specific page update, or a demonstrable reference fix.
|
|
187
213
|
|
|
188
214
|
## Knowledge Ownership
|
|
189
215
|
|
|
@@ -198,6 +224,9 @@ folder. Do not create area-local copies of initiative documents.
|
|
|
198
224
|
Before finishing behavior-changing work:
|
|
199
225
|
|
|
200
226
|
- The matching initiative was read or a reason was given for why none exists.
|
|
227
|
+
- `context/project-profile.md` was read when present and relevant to
|
|
228
|
+
verification, delivery, infrastructure, operations, or generated artifacts;
|
|
229
|
+
if a human requested a baseline, it was populated from source-backed facts.
|
|
201
230
|
- Matching programs or context backlog items were checked when the work
|
|
202
231
|
appears phased, deferred, or multi-release.
|
|
203
232
|
- Planned initiatives were checked or created when future program scope is
|
|
@@ -205,5 +234,5 @@ Before finishing behavior-changing work:
|
|
|
205
234
|
- Any changed behavior, interface, architecture, testing, delivery,
|
|
206
235
|
infrastructure, actionable operations, or backlog state was reflected in the
|
|
207
236
|
initiative when appropriate.
|
|
208
|
-
- Future
|
|
209
|
-
- `
|
|
237
|
+
- Future reference impact was captured in `release-doc-notes.md`.
|
|
238
|
+
- `reference/` was left untouched unless explicitly requested.
|
package/AGENTS.md
CHANGED
|
@@ -8,27 +8,30 @@ subfolders layer on top of it. Read those too when working in a given area.
|
|
|
8
8
|
In-progress specs, plans, ADRs, backlog, implementation context, and
|
|
9
9
|
release-documentation notes live under [`context/`](context/).
|
|
10
10
|
Start with [`context/current.md`](context/current.md).
|
|
11
|
+
Use [`context/project-profile.md`](context/project-profile.md) for
|
|
12
|
+
repo-wide stack, command, testing, delivery, infrastructure, observability,
|
|
13
|
+
and generated-artifact facts when it has been populated.
|
|
11
14
|
|
|
12
15
|
For behavior-changing work, use the repo-wide skill at
|
|
13
16
|
[`.agents/skills/code-anchored-context/SKILL.md`](.agents/skills/code-anchored-context/SKILL.md).
|
|
14
17
|
Keep initiative knowledge centralized under `context/`; area
|
|
15
18
|
`AGENTS.md` files should point there rather than copying active plans.
|
|
16
19
|
|
|
17
|
-
##
|
|
20
|
+
## Reference Authoring
|
|
18
21
|
|
|
19
|
-
### When To Edit `
|
|
22
|
+
### When To Edit `reference/`
|
|
20
23
|
|
|
21
|
-
Do not edit `
|
|
22
|
-
refactors, or other code changes.
|
|
24
|
+
Do not edit `reference/` as a side effect of feature work, bug fixes,
|
|
25
|
+
refactors, or other code changes. Reference material in this model is
|
|
23
26
|
release-anchored:
|
|
24
27
|
they describe the behavior of a specific release tag, not the partial state of
|
|
25
28
|
a working branch.
|
|
26
29
|
|
|
27
|
-
Touch `
|
|
30
|
+
Touch `reference/` only when:
|
|
28
31
|
|
|
29
|
-
- A human explicitly asks you to refresh
|
|
32
|
+
- A human explicitly asks you to refresh reference for a release, typically
|
|
30
33
|
after a release tag is cut and QA has signed off.
|
|
31
|
-
- A human explicitly asks you to create or refresh baseline
|
|
34
|
+
- A human explicitly asks you to create or refresh baseline reference for
|
|
32
35
|
an existing project.
|
|
33
36
|
- A human explicitly asks you to update a specific page.
|
|
34
37
|
- A human asks you to fix a demonstrable error in an existing page, such as a
|
|
@@ -36,20 +39,20 @@ Touch `product-docs/` only when:
|
|
|
36
39
|
|
|
37
40
|
If you are unsure whether the request is one of these, ask before editing.
|
|
38
41
|
|
|
39
|
-
If a project has
|
|
42
|
+
If a project has reference material that intentionally follows a different cadence,
|
|
40
43
|
document that exception in the area's README and in
|
|
41
|
-
`
|
|
44
|
+
`reference/_authoring/areas/`.
|
|
42
45
|
|
|
43
46
|
### Where The Authoring Guidance Lives
|
|
44
47
|
|
|
45
|
-
All
|
|
46
|
-
live under [`
|
|
47
|
-
with [`
|
|
48
|
+
All reference workflow, per-area authoring guides, and domain terminology
|
|
49
|
+
live under [`reference/_authoring/`](reference/_authoring/). Start
|
|
50
|
+
with [`reference/_authoring/README.md`](reference/_authoring/README.md).
|
|
48
51
|
|
|
49
|
-
If you are refreshing
|
|
50
|
-
[`
|
|
52
|
+
If you are refreshing reference, the per-area guides in
|
|
53
|
+
[`reference/_authoring/areas/`](reference/_authoring/areas/) tell you
|
|
51
54
|
what matters and what to ignore for each area.
|
|
52
55
|
|
|
53
56
|
`AGENTS.md` files stay lean. They are for coding conventions and agent
|
|
54
|
-
restrictions, not detailed
|
|
57
|
+
restrictions, not detailed reference guidance. If you have reference rules to
|
|
55
58
|
add, add them under `_authoring/`.
|
package/README.md
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
# Code-Anchored Context Template
|
|
2
2
|
|
|
3
3
|
This repository is a reusable starting point for keeping repository-local
|
|
4
|
-
working context and release-anchored
|
|
4
|
+
working context and release-anchored reference close to the
|
|
5
5
|
code they describe.
|
|
6
6
|
|
|
7
7
|
It separates two kinds of truth:
|
|
8
8
|
|
|
9
9
|
| Folder | Meaning | Updated when |
|
|
10
10
|
| --- | --- | --- |
|
|
11
|
-
| `context/` | What the team is planning, building, deciding, validating, shipping, hosting, deferring, and learning. | During normal development. |
|
|
12
|
-
| `
|
|
11
|
+
| `context/` | What the team is planning, building, deciding, validating, shipping, hosting, deferring, and learning, plus optional repo-wide operating facts in `project-profile.md`. | During normal development. |
|
|
12
|
+
| `reference/` | What the system does as of a known release or explicit baseline. | Only during explicit reference refresh work. |
|
|
13
13
|
|
|
14
14
|
The goal is to give humans and AI agents enough structured context to change a
|
|
15
15
|
codebase without relying on chat history, tribal memory, or scattered planning
|
|
@@ -21,8 +21,9 @@ notes.
|
|
|
21
21
|
- `.agents/skills/code-anchored-context/SKILL.md` for the recurring
|
|
22
22
|
working-context workflow.
|
|
23
23
|
- `context/` with terminology, release context, backlog/program structure,
|
|
24
|
-
initiative templates, and
|
|
25
|
-
|
|
24
|
+
a repo-wide project profile starter, initiative templates, and
|
|
25
|
+
release-documentation notes.
|
|
26
|
+
- `reference/` with a generic release-anchored reference workflow,
|
|
26
27
|
authoring guide structure, and area/page templates.
|
|
27
28
|
|
|
28
29
|
## Adopting This In A Project
|
|
@@ -39,7 +40,7 @@ Useful options:
|
|
|
39
40
|
|
|
40
41
|
```bash
|
|
41
42
|
npx code-anchored-context init --dry-run
|
|
42
|
-
npx code-anchored-context init --no-
|
|
43
|
+
npx code-anchored-context init --no-reference
|
|
43
44
|
npx code-anchored-context init --target ../existing-project
|
|
44
45
|
```
|
|
45
46
|
|
|
@@ -54,10 +55,13 @@ Manual adoption still works:
|
|
|
54
55
|
2. Replace `PROJECT_NAME` placeholders with the project name.
|
|
55
56
|
3. Set the first active release in `context/current.md`.
|
|
56
57
|
4. Add or revise area-specific `AGENTS.md` files so they point back to
|
|
57
|
-
`context/` and `
|
|
58
|
-
5.
|
|
58
|
+
`context/` and `reference/_authoring/`.
|
|
59
|
+
5. If you want a repo operating profile, ask an agent to populate
|
|
60
|
+
`context/project-profile.md` from source files, manifests, CI/CD,
|
|
61
|
+
infrastructure, test config, and observability tooling.
|
|
62
|
+
6. Create `reference/_authoring/areas/<area>.md` for each referenced
|
|
59
63
|
product or code area.
|
|
60
|
-
|
|
64
|
+
7. Keep product or domain-specific reference content out of this template repo.
|
|
61
65
|
|
|
62
66
|
## Publishing The Package
|
|
63
67
|
|
|
@@ -78,8 +82,8 @@ npx @your-scope/code-anchored-context init
|
|
|
78
82
|
|
|
79
83
|
## Working Rule
|
|
80
84
|
|
|
81
|
-
Working context can evolve with the branch.
|
|
85
|
+
Working context can evolve with the branch. Reference material should
|
|
82
86
|
stay stable and release-accurate. When behavior changes during development,
|
|
83
|
-
record future
|
|
84
|
-
`release-doc-notes.md`; refresh `
|
|
87
|
+
record future reference impact in the relevant initiative's
|
|
88
|
+
`release-doc-notes.md`; refresh `reference/` only when that work is
|
|
85
89
|
explicitly requested.
|
|
@@ -54,7 +54,7 @@ async function main() {
|
|
|
54
54
|
dryRun: args.dryRun
|
|
55
55
|
});
|
|
56
56
|
|
|
57
|
-
await installer.init({
|
|
57
|
+
await installer.init({ includeReference: args.reference });
|
|
58
58
|
}
|
|
59
59
|
|
|
60
60
|
function parseArgs(argv) {
|
|
@@ -65,7 +65,7 @@ function parseArgs(argv) {
|
|
|
65
65
|
release: defaultRelease,
|
|
66
66
|
force: false,
|
|
67
67
|
dryRun: false,
|
|
68
|
-
|
|
68
|
+
reference: true,
|
|
69
69
|
help: false,
|
|
70
70
|
version: false
|
|
71
71
|
};
|
|
@@ -95,8 +95,8 @@ function parseArgs(argv) {
|
|
|
95
95
|
continue;
|
|
96
96
|
}
|
|
97
97
|
|
|
98
|
-
if (arg === '--no-
|
|
99
|
-
options.
|
|
98
|
+
if (arg === '--no-reference') {
|
|
99
|
+
options.reference = false;
|
|
100
100
|
continue;
|
|
101
101
|
}
|
|
102
102
|
|
|
@@ -170,8 +170,7 @@ Options:
|
|
|
170
170
|
--target <path> Project root to install into. Defaults to cwd.
|
|
171
171
|
--project-name <name> Name used to replace PROJECT_NAME placeholders.
|
|
172
172
|
--release <slug> Initial release slug. Defaults to ${defaultRelease}.
|
|
173
|
-
--no-
|
|
174
|
-
--no-docs Alias for --no-product-docs.
|
|
173
|
+
--no-reference Skip the reference/ starter files.
|
|
175
174
|
--force Replace existing generated directories.
|
|
176
175
|
--dry-run Show planned changes without writing files.
|
|
177
176
|
-h, --help Show help.
|
|
@@ -179,7 +178,7 @@ Options:
|
|
|
179
178
|
|
|
180
179
|
Examples:
|
|
181
180
|
npx code-anchored-context init --project-name "My App"
|
|
182
|
-
npx code-anchored-context init --release v1_0_0 --no-
|
|
181
|
+
npx code-anchored-context init --release v1_0_0 --no-reference
|
|
183
182
|
`);
|
|
184
183
|
}
|
|
185
184
|
|
|
@@ -216,7 +215,7 @@ class Installer {
|
|
|
216
215
|
this.agentsFilePath = path.join(targetRoot, 'AGENTS.md');
|
|
217
216
|
}
|
|
218
217
|
|
|
219
|
-
async init({
|
|
218
|
+
async init({ includeReference }) {
|
|
220
219
|
await this.ensureDirectory(this.targetRoot);
|
|
221
220
|
|
|
222
221
|
await this.installAgentsFile();
|
|
@@ -224,10 +223,10 @@ class Installer {
|
|
|
224
223
|
await this.copyTemplatePath('context', 'context');
|
|
225
224
|
await this.renameReleasePaths();
|
|
226
225
|
|
|
227
|
-
if (
|
|
228
|
-
await this.copyTemplatePath('
|
|
226
|
+
if (includeReference) {
|
|
227
|
+
await this.copyTemplatePath('reference', 'reference');
|
|
229
228
|
} else {
|
|
230
|
-
this.note('skip
|
|
229
|
+
this.note('skip reference/ (--no-reference)');
|
|
231
230
|
}
|
|
232
231
|
|
|
233
232
|
this.printSummary();
|
|
@@ -305,6 +304,9 @@ class Installer {
|
|
|
305
304
|
In-progress specs, plans, ADRs, backlog, implementation context, and
|
|
306
305
|
release-documentation notes live under [\`context/\`](context/).
|
|
307
306
|
Start with [\`context/current.md\`](context/current.md).
|
|
307
|
+
Use [\`context/project-profile.md\`](context/project-profile.md) for
|
|
308
|
+
repo-wide stack, command, testing, delivery, infrastructure, observability,
|
|
309
|
+
and generated-artifact facts when it has been populated.
|
|
308
310
|
|
|
309
311
|
For behavior-changing work, use the repo-wide skill at
|
|
310
312
|
[\`.agents/skills/${skillName}/SKILL.md\`](.agents/skills/${skillName}/SKILL.md).
|
|
@@ -487,6 +489,10 @@ Start here:
|
|
|
487
489
|
- \`releases/${this.release}/backlog.md\`
|
|
488
490
|
- \`releases/${this.release}/initiatives/\`
|
|
489
491
|
|
|
492
|
+
Project-wide operating profile:
|
|
493
|
+
|
|
494
|
+
- \`project-profile.md\`
|
|
495
|
+
|
|
490
496
|
Durable or deferred context:
|
|
491
497
|
|
|
492
498
|
- \`programs/\`
|
package/context/AGENTS.md
CHANGED
|
@@ -7,6 +7,9 @@ Scope: everything under `/context`.
|
|
|
7
7
|
This folder is the canonical home for in-progress working context: specs,
|
|
8
8
|
interface notes, architecture notes, actionable operations notes, ADRs,
|
|
9
9
|
backlogs, implementation plans, and release-documentation notes.
|
|
10
|
+
`project-profile.md` is the canonical home for repo-wide operating facts such
|
|
11
|
+
as stack, commands, test layers, CI/CD, infrastructure, observability, and
|
|
12
|
+
generated artifacts when a baseline has been populated.
|
|
10
13
|
|
|
11
14
|
Testing, delivery, and infrastructure notes belong here when they affect how
|
|
12
15
|
work is verified, shipped, deployed, or hosted. Operational notes belong here
|
|
@@ -14,17 +17,20 @@ only when they are actionable runtime, support, observability, rollback, or
|
|
|
14
17
|
repair context.
|
|
15
18
|
|
|
16
19
|
`context/` describes what is being planned, built, debated, or validated.
|
|
17
|
-
`
|
|
20
|
+
`reference/` describes what has shipped for a release.
|
|
18
21
|
|
|
19
22
|
## Editing Rules
|
|
20
23
|
|
|
21
24
|
- Use `context/terminology.md` as the canonical vocabulary for programs,
|
|
22
25
|
planned initiatives, release initiatives, backlog items, and promotion.
|
|
26
|
+
- Use `context/project-profile.md` for stable repo-wide operating facts.
|
|
27
|
+
Populate it only from source-backed discovery or an explicit human request
|
|
28
|
+
for a repository baseline.
|
|
23
29
|
- Keep initiative knowledge centralized here. Area `AGENTS.md` files may point
|
|
24
30
|
here, but they should not duplicate initiative content.
|
|
25
|
-
- Do not move in-progress plans into `
|
|
31
|
+
- Do not move in-progress plans into `reference/`.
|
|
26
32
|
- Use `release-doc-notes.md` inside an initiative to capture what may need to
|
|
27
|
-
become
|
|
33
|
+
become reference later.
|
|
28
34
|
- Create initiatives from `context/_templates/initiative/`.
|
|
29
35
|
- Create durable multi-release programs from `context/_templates/program/`.
|
|
30
36
|
- Create scoped future program work from
|
package/context/README.md
CHANGED
|
@@ -6,12 +6,18 @@ repository.
|
|
|
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
|
+
`reference/` for in-progress development planning.
|
|
10
|
+
|
|
11
|
+
Use `project-profile.md` for repo-wide operating facts such as stack,
|
|
12
|
+
commands, verification layers, CI/CD, infrastructure, observability, and
|
|
13
|
+
generated artifacts.
|
|
10
14
|
|
|
11
15
|
## Start Here
|
|
12
16
|
|
|
13
17
|
- `terminology.md` defines the shared vocabulary.
|
|
14
18
|
- `current.md` points to the active release context.
|
|
19
|
+
- `project-profile.md` captures repo-wide stack, command, testing, delivery,
|
|
20
|
+
infrastructure, operations, and generated-artifact facts when populated.
|
|
15
21
|
- `programs/` contains durable multi-release working context.
|
|
16
22
|
- `backlog/` contains deferred isolated work cut from initiatives.
|
|
17
23
|
- `releases/` contains release-scoped working context.
|
|
@@ -20,17 +26,17 @@ implementation plans, and release-documentation notes. Do not use
|
|
|
20
26
|
shape for scoped program work outside the current release.
|
|
21
27
|
- `_templates/release-context/` contains the standard release folder shell.
|
|
22
28
|
|
|
23
|
-
## Relationship To
|
|
29
|
+
## Relationship To reference/
|
|
24
30
|
|
|
25
|
-
`context/` and `
|
|
31
|
+
`context/` and `reference/` serve different jobs:
|
|
26
32
|
|
|
27
33
|
| Folder | Meaning | Updated when |
|
|
28
34
|
| --- | --- | --- |
|
|
29
35
|
| `context/` | What we are planning, building, deciding, or validating. | During normal development. |
|
|
30
|
-
| `
|
|
36
|
+
| `reference/` | What the system does as of a release, tag, or explicit baseline. | Only during explicit reference refresh work. |
|
|
31
37
|
|
|
32
|
-
Working context can feed release
|
|
33
|
-
|
|
38
|
+
Working context can feed release reference, but it is not accepted
|
|
39
|
+
reference. Capture that bridge in each initiative's
|
|
34
40
|
`release-doc-notes.md`.
|
|
35
41
|
|
|
36
42
|
## Core Model
|
|
@@ -63,6 +69,9 @@ The delivery-surface rule is:
|
|
|
63
69
|
|
|
64
70
|
Use `testing.md`, `delivery.md`, and `infrastructure.md` for concern-based
|
|
65
71
|
context. Mention specific tools inside those files only when the tools matter.
|
|
72
|
+
Use `project-profile.md` for repo-wide defaults such as package manager,
|
|
73
|
+
common commands, test tools, delivery automation, infrastructure tooling, and
|
|
74
|
+
observability entry points.
|
|
66
75
|
|
|
67
76
|
Mermaid diagrams are encouraged for flows, dependencies, and lifecycle maps
|
|
68
77
|
because they stay readable as Markdown for agents while rendering as visible
|
|
@@ -80,6 +89,7 @@ not copy specs, plans, or ADRs into area-local documents.
|
|
|
80
89
|
```text
|
|
81
90
|
context/
|
|
82
91
|
current.md
|
|
92
|
+
project-profile.md
|
|
83
93
|
programs/
|
|
84
94
|
<program-slug>/
|
|
85
95
|
README.md
|
|
@@ -120,6 +130,27 @@ context/
|
|
|
120
130
|
brief.html
|
|
121
131
|
```
|
|
122
132
|
|
|
133
|
+
## Project Profile
|
|
134
|
+
|
|
135
|
+
`project-profile.md` is the optional repo-wide operating profile. It answers
|
|
136
|
+
questions future agents routinely need before changing behavior:
|
|
137
|
+
|
|
138
|
+
- where code, tests, config, infrastructure, generated artifacts, and
|
|
139
|
+
reference material live
|
|
140
|
+
- which runtime, package manager, frameworks, services, and hosting platform
|
|
141
|
+
the project uses
|
|
142
|
+
- which commands verify, build, package, run, deploy, or release the project
|
|
143
|
+
- which CI/CD, IaC, observability, support, rollback, and repair tools matter
|
|
144
|
+
|
|
145
|
+
Populate it when a human asks for a project profile, tech-stack baseline, or
|
|
146
|
+
repository operating baseline, or when a concrete repo-wide fact is discovered
|
|
147
|
+
during work. Do not guess. Mark unknowns explicitly and cite source paths
|
|
148
|
+
where possible.
|
|
149
|
+
|
|
150
|
+
Initiatives can rely on the project profile for stable defaults. Put only the
|
|
151
|
+
initiative-specific changes, exceptions, and release gates in the initiative's
|
|
152
|
+
`testing.md`, `delivery.md`, `infrastructure.md`, or `operations.md`.
|
|
153
|
+
|
|
123
154
|
## Programs
|
|
124
155
|
|
|
125
156
|
Programs preserve durable context for work that spans releases or phases. Use a
|
|
@@ -190,7 +221,7 @@ Required for most initiatives:
|
|
|
190
221
|
| `plan.md` | Working alignment space for humans and agents; rough notes, questions, options, and points to promote. |
|
|
191
222
|
| `spec.md` | What the system should do and which behavior is in or out. |
|
|
192
223
|
| `backlog.md` | What is changing now, sliced into trackable work. |
|
|
193
|
-
| `release-doc-notes.md` |
|
|
224
|
+
| `release-doc-notes.md` | Reference impact to review at release time. |
|
|
194
225
|
|
|
195
226
|
Use when relevant:
|
|
196
227
|
|
|
@@ -246,8 +277,8 @@ When changing behavior, agents should:
|
|
|
246
277
|
behavior changes that do not belong to an existing initiative.
|
|
247
278
|
7. Create or update a program planned initiative when future scoped work is
|
|
248
279
|
clear but belongs outside the current release.
|
|
249
|
-
8. Record future
|
|
250
|
-
`
|
|
280
|
+
8. Record future reference impact in `release-doc-notes.md`, not in
|
|
281
|
+
`reference/`, unless a human explicitly asks for reference refresh.
|
|
251
282
|
|
|
252
283
|
The key rule for planning is:
|
|
253
284
|
|
|
@@ -17,7 +17,9 @@ 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
|
+
- Repo-wide operating profile: `context/project-profile.md` if a stable
|
|
21
|
+
project fact changes
|
|
22
|
+
- Reference or release notes: `path/to/...`
|
|
21
23
|
|
|
22
24
|
Remove entries that do not apply and add the real paths. Prefer naming the
|
|
23
25
|
delivery concern over assuming a specific folder layout.
|
|
@@ -59,5 +61,5 @@ support, observability, rollback, or repair context.
|
|
|
59
61
|
Promote settled conclusions into the stable initiative files.
|
|
60
62
|
- Update `release-doc-notes.md` when shipped behavior or product-facing
|
|
61
63
|
behavior changes.
|
|
62
|
-
- Do not update `
|
|
63
|
-
explicitly asks for release
|
|
64
|
+
- Do not update `reference/` from this initiative unless a human
|
|
65
|
+
explicitly asks for release reference work.
|
|
@@ -5,6 +5,10 @@ Name the concern, not the tool. Pipeline definitions, workflow files,
|
|
|
5
5
|
deployment scripts, release toggles, and gates can all appear here when
|
|
6
6
|
relevant.
|
|
7
7
|
|
|
8
|
+
Start from `context/project-profile.md` for repo-wide delivery defaults.
|
|
9
|
+
Capture only initiative-specific pipeline, build, deployment, artifact, or
|
|
10
|
+
release changes here.
|
|
11
|
+
|
|
8
12
|
## Pipeline Impact
|
|
9
13
|
|
|
10
14
|
Describe pipeline, workflow, build, packaging, or artifact changes.
|
|
@@ -4,6 +4,10 @@ Use this file for environment shape and infrastructure dependencies. Name the
|
|
|
4
4
|
concern, not the tool. Infrastructure modules, resource templates, manifests,
|
|
5
5
|
or manual environment steps can all appear here when relevant.
|
|
6
6
|
|
|
7
|
+
Start from `context/project-profile.md` for repo-wide infrastructure and
|
|
8
|
+
configuration defaults. Capture only initiative-specific environment, IaC,
|
|
9
|
+
resource, secret, or migration changes here.
|
|
10
|
+
|
|
7
11
|
## Environment Shape
|
|
8
12
|
|
|
9
13
|
Describe new or changed resources, services, networks, identity boundaries,
|
|
@@ -7,6 +7,10 @@ If there is nothing concrete for an agent or engineer to act on, omit this
|
|
|
7
7
|
file after copying the template or mark it as not applicable. Delivery belongs
|
|
8
8
|
in `delivery.md`; environment shape and IaC belong in `infrastructure.md`.
|
|
9
9
|
|
|
10
|
+
Start from `context/project-profile.md` for repo-wide observability, support,
|
|
11
|
+
rollback, and repair entry points. Capture only initiative-specific actionable
|
|
12
|
+
runtime or support changes here.
|
|
13
|
+
|
|
10
14
|
## Runtime Behavior
|
|
11
15
|
|
|
12
16
|
Describe how the live system behaves after the initiative ships, especially
|
|
@@ -18,7 +18,7 @@ initiative files:
|
|
|
18
18
|
repair notes
|
|
19
19
|
- `backlog.md` for executable work items
|
|
20
20
|
- `decisions/ADR-*.md` for durable decisions
|
|
21
|
-
- `release-doc-notes.md` for future
|
|
21
|
+
- `release-doc-notes.md` for future reference impact
|
|
22
22
|
|
|
23
23
|
## Current Alignment
|
|
24
24
|
|
|
@@ -54,4 +54,4 @@ the canonical initiative files.
|
|
|
54
54
|
- [ ] Move multi-release context into `context/programs/`
|
|
55
55
|
- [ ] Move isolated deferred work into `context/backlog/items/`
|
|
56
56
|
- [ ] Move durable decisions into `decisions/`
|
|
57
|
-
- [ ] Move
|
|
57
|
+
- [ ] Move reference impact into `release-doc-notes.md`
|
|
@@ -1,20 +1,20 @@
|
|
|
1
1
|
# Release Doc Notes
|
|
2
2
|
|
|
3
|
-
Use this file to capture
|
|
4
|
-
in progress. At release time, these notes help refresh `
|
|
3
|
+
Use this file to capture reference impact while development is
|
|
4
|
+
in progress. At release time, these notes help refresh `reference/`
|
|
5
5
|
against the final shipped behavior.
|
|
6
6
|
|
|
7
|
-
Do not edit `
|
|
8
|
-
explicitly asks for a
|
|
7
|
+
Do not edit `reference/` from normal development work unless a human
|
|
8
|
+
explicitly asks for a reference refresh or a specific reference fix.
|
|
9
9
|
|
|
10
10
|
## Product Behavior Changes
|
|
11
11
|
|
|
12
12
|
- None yet.
|
|
13
13
|
|
|
14
|
-
## Candidate
|
|
14
|
+
## Candidate Reference Areas
|
|
15
15
|
|
|
16
|
-
- `
|
|
17
|
-
- `
|
|
16
|
+
- `reference/<Area>/README.md`
|
|
17
|
+
- `reference/<Area>/features/<feature>.md`
|
|
18
18
|
|
|
19
19
|
## QA Or Support Notes
|
|
20
20
|
|
|
@@ -29,6 +29,6 @@ ship.
|
|
|
29
29
|
## Release-Time Checklist
|
|
30
30
|
|
|
31
31
|
- [ ] Compare this initiative against the final shipped code.
|
|
32
|
-
- [ ] Update the relevant
|
|
32
|
+
- [ ] Update the relevant reference only after release-doc work
|
|
33
33
|
is explicitly requested.
|
|
34
|
-
- [ ] Add the release row if the
|
|
34
|
+
- [ ] Add the release row if the reference workflow requires it.
|
|
@@ -4,6 +4,10 @@ Use this file for the initiative's verification strategy. Name the concern,
|
|
|
4
4
|
not the tool. Specific test runners, unit test frameworks, contract tests, or
|
|
5
5
|
manual scripts can all appear here when they are relevant.
|
|
6
6
|
|
|
7
|
+
Start from `context/project-profile.md` for repo-wide default commands and
|
|
8
|
+
test tooling. Capture only initiative-specific additions, exceptions, data
|
|
9
|
+
needs, or release gates here.
|
|
10
|
+
|
|
7
11
|
## Test Strategy
|
|
8
12
|
|
|
9
13
|
Describe what must be proven before this initiative can ship.
|
|
@@ -19,7 +19,9 @@ 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
|
+
- Repo-wide operating profile: `context/project-profile.md` if a stable
|
|
23
|
+
project fact is expected to change
|
|
24
|
+
- Reference or release notes: `path/to/...`
|
|
23
25
|
|
|
24
26
|
Remove entries that do not apply and add the real paths. Prefer naming the
|
|
25
27
|
delivery concern over assuming a specific folder layout.
|
|
@@ -3,6 +3,10 @@
|
|
|
3
3
|
Use this file for future CI/CD, build, release, and environment-promotion
|
|
4
4
|
behavior that is already clear enough to preserve.
|
|
5
5
|
|
|
6
|
+
Start from `context/project-profile.md` for repo-wide delivery defaults.
|
|
7
|
+
Capture only planned initiative-specific pipeline, build, deployment,
|
|
8
|
+
artifact, or release changes here.
|
|
9
|
+
|
|
6
10
|
## Pipeline Impact
|
|
7
11
|
|
|
8
12
|
Describe expected pipeline, workflow, build, packaging, or artifact changes.
|
|
@@ -3,6 +3,10 @@
|
|
|
3
3
|
Use this file for future environment shape and infrastructure dependencies
|
|
4
4
|
that are already clear enough to preserve.
|
|
5
5
|
|
|
6
|
+
Start from `context/project-profile.md` for repo-wide infrastructure and
|
|
7
|
+
configuration defaults. Capture only planned initiative-specific environment,
|
|
8
|
+
IaC, resource, secret, or migration changes here.
|
|
9
|
+
|
|
6
10
|
## Environment Shape
|
|
7
11
|
|
|
8
12
|
Describe expected resources, services, networks, identity boundaries, storage,
|
|
@@ -8,6 +8,10 @@ If there is nothing concrete for an agent or engineer to act on, omit this
|
|
|
8
8
|
file after copying the template or mark it as not applicable. Delivery belongs
|
|
9
9
|
in `delivery.md`; environment shape and IaC belong in `infrastructure.md`.
|
|
10
10
|
|
|
11
|
+
Start from `context/project-profile.md` for repo-wide observability, support,
|
|
12
|
+
rollback, and repair entry points. Capture only planned initiative-specific
|
|
13
|
+
actionable runtime or support changes here.
|
|
14
|
+
|
|
11
15
|
## Runtime Behavior
|
|
12
16
|
|
|
13
17
|
Describe expected live-system behavior, especially jobs, schedules, queues,
|