code-anchored-context 0.2.1 → 0.2.3
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 +10 -11
- package/AGENTS.md +16 -15
- package/README.md +11 -11
- package/bin/code-anchored-context.js +10 -10
- package/context/AGENTS.md +3 -3
- package/context/README.md +9 -9
- package/context/_templates/initiative/README.md +3 -3
- package/context/_templates/initiative/plan.md +2 -2
- package/context/_templates/initiative/release-doc-notes.md +9 -10
- package/context/_templates/planned-initiative/README.md +1 -1
- package/context/_templates/planned-initiative/plan.md +1 -1
- package/context/_templates/planned-initiative/release-doc-notes.md +6 -7
- package/context/terminology.md +2 -2
- package/package.json +4 -4
- package/reference/README.md +62 -0
- package/{docs → reference}/_authoring/README.md +9 -9
- package/{docs → reference}/_authoring/areas/README.md +2 -2
- package/{docs → reference}/_authoring/areas/_template.md +5 -5
- package/{docs → reference}/_authoring/terminology.md +1 -1
- package/{docs → reference}/_authoring/workflow.md +52 -51
- package/{docs → reference}/releases/index.md +2 -2
- package/docs/.order +0 -2
- package/docs/Welcome.md +0 -48
- /package/{docs → reference}/_templates/area/README.md +0 -0
- /package/{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/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
|
|
@@ -59,8 +59,8 @@ effort, link it to the relevant program.
|
|
|
59
59
|
### 4) Create An Initiative When Needed
|
|
60
60
|
|
|
61
61
|
Create a new initiative for non-trivial behavior changes, cross-project
|
|
62
|
-
work, release-significant work, or anything likely to need future
|
|
63
|
-
|
|
62
|
+
work, release-significant work, or anything likely to need future reference
|
|
63
|
+
updates.
|
|
64
64
|
|
|
65
65
|
Use `context/_templates/initiative/` as the source. Copy it to:
|
|
66
66
|
|
|
@@ -164,7 +164,7 @@ Use these files as the standard map:
|
|
|
164
164
|
observability, failure modes, rollback, repair, and support tooling
|
|
165
165
|
- `backlog.md`: work slices and implementation progress
|
|
166
166
|
- `decisions/ADR-*.md`: meaningful choices and their consequences
|
|
167
|
-
- `release-doc-notes.md`:
|
|
167
|
+
- `release-doc-notes.md`: reference impact to review at release
|
|
168
168
|
|
|
169
169
|
Not every initiative needs every file. Mark a file as not applicable or omit
|
|
170
170
|
it after copying the template when it genuinely does not apply.
|
|
@@ -175,15 +175,14 @@ settled truth lives. Promote stable conclusions into `spec.md`,
|
|
|
175
175
|
`infrastructure.md`, `operations.md` when actionable, `backlog.md`, ADRs, or
|
|
176
176
|
`release-doc-notes.md` as appropriate.
|
|
177
177
|
|
|
178
|
-
### 9) Preserve The
|
|
178
|
+
### 9) Preserve The Reference Boundary
|
|
179
179
|
|
|
180
|
-
Do not edit `
|
|
180
|
+
Do not edit `reference/` as part of normal feature work, bug fixes,
|
|
181
181
|
refactors, or planning. Instead, update the initiative's
|
|
182
182
|
`release-doc-notes.md`.
|
|
183
183
|
|
|
184
|
-
Only update `
|
|
185
|
-
|
|
186
|
-
fix.
|
|
184
|
+
Only update `reference/` when a human explicitly asks for release reference
|
|
185
|
+
work, a specific page update, or a demonstrable reference fix.
|
|
187
186
|
|
|
188
187
|
## Knowledge Ownership
|
|
189
188
|
|
|
@@ -205,5 +204,5 @@ Before finishing behavior-changing work:
|
|
|
205
204
|
- Any changed behavior, interface, architecture, testing, delivery,
|
|
206
205
|
infrastructure, actionable operations, or backlog state was reflected in the
|
|
207
206
|
initiative when appropriate.
|
|
208
|
-
- Future
|
|
209
|
-
- `
|
|
207
|
+
- Future reference impact was captured in `release-doc-notes.md`.
|
|
208
|
+
- `reference/` was left untouched unless explicitly requested.
|
package/AGENTS.md
CHANGED
|
@@ -14,20 +14,21 @@ For behavior-changing work, use the repo-wide skill at
|
|
|
14
14
|
Keep initiative knowledge centralized under `context/`; area
|
|
15
15
|
`AGENTS.md` files should point there rather than copying active plans.
|
|
16
16
|
|
|
17
|
-
##
|
|
17
|
+
## Reference Authoring
|
|
18
18
|
|
|
19
|
-
### When To Edit `
|
|
19
|
+
### When To Edit `reference/`
|
|
20
20
|
|
|
21
|
-
Do not edit `
|
|
22
|
-
refactors, or other code changes.
|
|
21
|
+
Do not edit `reference/` as a side effect of feature work, bug fixes,
|
|
22
|
+
refactors, or other code changes. Reference material in this model is
|
|
23
|
+
release-anchored:
|
|
23
24
|
they describe the behavior of a specific release tag, not the partial state of
|
|
24
25
|
a working branch.
|
|
25
26
|
|
|
26
|
-
Touch `
|
|
27
|
+
Touch `reference/` only when:
|
|
27
28
|
|
|
28
|
-
- A human explicitly asks you to refresh
|
|
29
|
+
- A human explicitly asks you to refresh reference for a release, typically
|
|
29
30
|
after a release tag is cut and QA has signed off.
|
|
30
|
-
- A human explicitly asks you to create or refresh baseline
|
|
31
|
+
- A human explicitly asks you to create or refresh baseline reference for
|
|
31
32
|
an existing project.
|
|
32
33
|
- A human explicitly asks you to update a specific page.
|
|
33
34
|
- A human asks you to fix a demonstrable error in an existing page, such as a
|
|
@@ -35,20 +36,20 @@ Touch `docs/` only when:
|
|
|
35
36
|
|
|
36
37
|
If you are unsure whether the request is one of these, ask before editing.
|
|
37
38
|
|
|
38
|
-
If a project has
|
|
39
|
+
If a project has reference material that intentionally follows a different cadence,
|
|
39
40
|
document that exception in the area's README and in
|
|
40
|
-
`
|
|
41
|
+
`reference/_authoring/areas/`.
|
|
41
42
|
|
|
42
43
|
### Where The Authoring Guidance Lives
|
|
43
44
|
|
|
44
|
-
All
|
|
45
|
-
live under [`
|
|
46
|
-
with [`
|
|
45
|
+
All reference workflow, per-area authoring guides, and domain terminology
|
|
46
|
+
live under [`reference/_authoring/`](reference/_authoring/). Start
|
|
47
|
+
with [`reference/_authoring/README.md`](reference/_authoring/README.md).
|
|
47
48
|
|
|
48
|
-
If you are refreshing
|
|
49
|
-
[`
|
|
49
|
+
If you are refreshing reference, the per-area guides in
|
|
50
|
+
[`reference/_authoring/areas/`](reference/_authoring/areas/) tell you
|
|
50
51
|
what matters and what to ignore for each area.
|
|
51
52
|
|
|
52
53
|
`AGENTS.md` files stay lean. They are for coding conventions and agent
|
|
53
|
-
restrictions, not detailed
|
|
54
|
+
restrictions, not detailed reference guidance. If you have reference rules to
|
|
54
55
|
add, add them under `_authoring/`.
|
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
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:
|
|
@@ -9,7 +9,7 @@ It separates two kinds of truth:
|
|
|
9
9
|
| Folder | Meaning | Updated when |
|
|
10
10
|
| --- | --- | --- |
|
|
11
11
|
| `context/` | What the team is planning, building, deciding, validating, shipping, hosting, deferring, and learning. | During normal development. |
|
|
12
|
-
| `
|
|
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,8 @@ 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
|
+
initiative templates, and release-documentation notes.
|
|
25
|
+
- `reference/` with a generic release-anchored reference workflow,
|
|
26
26
|
authoring guide structure, and area/page templates.
|
|
27
27
|
|
|
28
28
|
## Adopting This In A Project
|
|
@@ -39,7 +39,7 @@ Useful options:
|
|
|
39
39
|
|
|
40
40
|
```bash
|
|
41
41
|
npx code-anchored-context init --dry-run
|
|
42
|
-
npx code-anchored-context init --no-
|
|
42
|
+
npx code-anchored-context init --no-reference
|
|
43
43
|
npx code-anchored-context init --target ../existing-project
|
|
44
44
|
```
|
|
45
45
|
|
|
@@ -54,10 +54,10 @@ Manual adoption still works:
|
|
|
54
54
|
2. Replace `PROJECT_NAME` placeholders with the project name.
|
|
55
55
|
3. Set the first active release in `context/current.md`.
|
|
56
56
|
4. Add or revise area-specific `AGENTS.md` files so they point back to
|
|
57
|
-
`context/` and `
|
|
58
|
-
5. Create `
|
|
57
|
+
`context/` and `reference/_authoring/`.
|
|
58
|
+
5. Create `reference/_authoring/areas/<area>.md` for each referenced
|
|
59
59
|
product or code area.
|
|
60
|
-
6. Keep product or domain-specific
|
|
60
|
+
6. Keep product or domain-specific reference content out of this template repo.
|
|
61
61
|
|
|
62
62
|
## Publishing The Package
|
|
63
63
|
|
|
@@ -78,8 +78,8 @@ npx @your-scope/code-anchored-context init
|
|
|
78
78
|
|
|
79
79
|
## Working Rule
|
|
80
80
|
|
|
81
|
-
Working context can evolve with the branch.
|
|
81
|
+
Working context can evolve with the branch. Reference material should
|
|
82
82
|
stay stable and release-accurate. When behavior changes during development,
|
|
83
|
-
record future
|
|
84
|
-
`release-doc-notes.md`; refresh `
|
|
83
|
+
record future reference impact in the relevant initiative's
|
|
84
|
+
`release-doc-notes.md`; refresh `reference/` only when that work is
|
|
85
85
|
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,7 +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-
|
|
173
|
+
--no-reference Skip the reference/ starter files.
|
|
174
174
|
--force Replace existing generated directories.
|
|
175
175
|
--dry-run Show planned changes without writing files.
|
|
176
176
|
-h, --help Show help.
|
|
@@ -178,7 +178,7 @@ Options:
|
|
|
178
178
|
|
|
179
179
|
Examples:
|
|
180
180
|
npx code-anchored-context init --project-name "My App"
|
|
181
|
-
npx code-anchored-context init --release v1_0_0 --no-
|
|
181
|
+
npx code-anchored-context init --release v1_0_0 --no-reference
|
|
182
182
|
`);
|
|
183
183
|
}
|
|
184
184
|
|
|
@@ -215,7 +215,7 @@ class Installer {
|
|
|
215
215
|
this.agentsFilePath = path.join(targetRoot, 'AGENTS.md');
|
|
216
216
|
}
|
|
217
217
|
|
|
218
|
-
async init({
|
|
218
|
+
async init({ includeReference }) {
|
|
219
219
|
await this.ensureDirectory(this.targetRoot);
|
|
220
220
|
|
|
221
221
|
await this.installAgentsFile();
|
|
@@ -223,10 +223,10 @@ class Installer {
|
|
|
223
223
|
await this.copyTemplatePath('context', 'context');
|
|
224
224
|
await this.renameReleasePaths();
|
|
225
225
|
|
|
226
|
-
if (
|
|
227
|
-
await this.copyTemplatePath('
|
|
226
|
+
if (includeReference) {
|
|
227
|
+
await this.copyTemplatePath('reference', 'reference');
|
|
228
228
|
} else {
|
|
229
|
-
this.note('skip
|
|
229
|
+
this.note('skip reference/ (--no-reference)');
|
|
230
230
|
}
|
|
231
231
|
|
|
232
232
|
this.printSummary();
|
package/context/AGENTS.md
CHANGED
|
@@ -14,7 +14,7 @@ only when they are actionable runtime, support, observability, rollback, or
|
|
|
14
14
|
repair context.
|
|
15
15
|
|
|
16
16
|
`context/` describes what is being planned, built, debated, or validated.
|
|
17
|
-
`
|
|
17
|
+
`reference/` describes what has shipped for a release.
|
|
18
18
|
|
|
19
19
|
## Editing Rules
|
|
20
20
|
|
|
@@ -22,9 +22,9 @@ repair context.
|
|
|
22
22
|
planned initiatives, release initiatives, backlog items, and promotion.
|
|
23
23
|
- Keep initiative knowledge centralized here. Area `AGENTS.md` files may point
|
|
24
24
|
here, but they should not duplicate initiative content.
|
|
25
|
-
- Do not move in-progress plans into `
|
|
25
|
+
- Do not move in-progress plans into `reference/`.
|
|
26
26
|
- Use `release-doc-notes.md` inside an initiative to capture what may need to
|
|
27
|
-
become
|
|
27
|
+
become reference later.
|
|
28
28
|
- Create initiatives from `context/_templates/initiative/`.
|
|
29
29
|
- Create durable multi-release programs from `context/_templates/program/`.
|
|
30
30
|
- Create scoped future program work from
|
package/context/README.md
CHANGED
|
@@ -6,7 +6,7 @@ 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
10
|
|
|
11
11
|
## Start Here
|
|
12
12
|
|
|
@@ -20,17 +20,17 @@ implementation plans, and release-documentation notes. Do not use
|
|
|
20
20
|
shape for scoped program work outside the current release.
|
|
21
21
|
- `_templates/release-context/` contains the standard release folder shell.
|
|
22
22
|
|
|
23
|
-
## Relationship To
|
|
23
|
+
## Relationship To reference/
|
|
24
24
|
|
|
25
|
-
`context/` and `
|
|
25
|
+
`context/` and `reference/` serve different jobs:
|
|
26
26
|
|
|
27
27
|
| Folder | Meaning | Updated when |
|
|
28
28
|
| --- | --- | --- |
|
|
29
29
|
| `context/` | What we are planning, building, deciding, or validating. | During normal development. |
|
|
30
|
-
| `
|
|
30
|
+
| `reference/` | What the system does as of a release, tag, or explicit baseline. | Only during explicit reference refresh work. |
|
|
31
31
|
|
|
32
|
-
Working context can feed release
|
|
33
|
-
|
|
32
|
+
Working context can feed release reference, but it is not accepted
|
|
33
|
+
reference. Capture that bridge in each initiative's
|
|
34
34
|
`release-doc-notes.md`.
|
|
35
35
|
|
|
36
36
|
## Core Model
|
|
@@ -190,7 +190,7 @@ Required for most initiatives:
|
|
|
190
190
|
| `plan.md` | Working alignment space for humans and agents; rough notes, questions, options, and points to promote. |
|
|
191
191
|
| `spec.md` | What the system should do and which behavior is in or out. |
|
|
192
192
|
| `backlog.md` | What is changing now, sliced into trackable work. |
|
|
193
|
-
| `release-doc-notes.md` |
|
|
193
|
+
| `release-doc-notes.md` | Reference impact to review at release time. |
|
|
194
194
|
|
|
195
195
|
Use when relevant:
|
|
196
196
|
|
|
@@ -246,8 +246,8 @@ When changing behavior, agents should:
|
|
|
246
246
|
behavior changes that do not belong to an existing initiative.
|
|
247
247
|
7. Create or update a program planned initiative when future scoped work is
|
|
248
248
|
clear but belongs outside the current release.
|
|
249
|
-
8. Record future
|
|
250
|
-
`
|
|
249
|
+
8. Record future reference impact in `release-doc-notes.md`, not in
|
|
250
|
+
`reference/`, unless a human explicitly asks for reference refresh.
|
|
251
251
|
|
|
252
252
|
The key rule for planning is:
|
|
253
253
|
|
|
@@ -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
|
+
- Reference 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 `
|
|
63
|
-
explicitly asks for release
|
|
62
|
+
- Do not update `reference/` from this initiative unless a human
|
|
63
|
+
explicitly asks for release reference work.
|
|
@@ -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,7 +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
|
|
35
|
-
|
|
34
|
+
- [ ] Add the release row if the reference workflow requires it.
|
|
@@ -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
|
+
- Reference 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.
|
|
@@ -37,4 +37,4 @@ Describe the current agreed future direction.
|
|
|
37
37
|
- [ ] Move actionable runtime/support concerns into `operations.md`
|
|
38
38
|
- [ ] Move executable future work into `backlog.md`
|
|
39
39
|
- [ ] Move durable program decisions into the parent program's `decisions/`
|
|
40
|
-
- [ ] Move
|
|
40
|
+
- [ ] 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 expected
|
|
3
|
+
Use this file to capture expected reference 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 `
|
|
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
|
## Expected 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
|
|
|
@@ -25,4 +25,3 @@ explicitly asks for a documentation refresh or a specific documentation fix.
|
|
|
25
25
|
Record details that were considered but should not be documented because
|
|
26
26
|
they are internal implementation details, temporary scaffolding, or might not
|
|
27
27
|
ship.
|
|
28
|
-
|
package/context/terminology.md
CHANGED
|
@@ -9,7 +9,7 @@ backlog items, ADRs, agent summaries, and release-transition work.
|
|
|
9
9
|
| Term | Meaning |
|
|
10
10
|
| --- | --- |
|
|
11
11
|
| `context/` | Working context: plans, specs, ADRs, implementation notes, delivery-surface context, future scope, and release-documentation notes. |
|
|
12
|
-
| `
|
|
12
|
+
| `reference/` | Accepted reference. It describes shipped or baseline behavior for a release/tag and is not edited during normal development work. |
|
|
13
13
|
| `context/current.md` | Pointer to the current active release context. Updating this is a release transition. |
|
|
14
14
|
| `context/releases/<version>/` | Release-scoped working context for one version. |
|
|
15
15
|
| `context/programs/` | Durable multi-release working context. |
|
|
@@ -60,7 +60,7 @@ both readable Markdown for agents and renderable visual context for humans.
|
|
|
60
60
|
| `infrastructure.md` | Stable description of environment shape, IaC, resources, networking, identity, storage, secrets, and environment dependencies. |
|
|
61
61
|
| `operations.md` | Optional actionable runtime support context: observability, failure modes, rollback, repair, support procedures, and tooling. |
|
|
62
62
|
| `backlog.md` | Trackable work items for the containing initiative or program. |
|
|
63
|
-
| `release-doc-notes.md` | Notes for future
|
|
63
|
+
| `release-doc-notes.md` | Notes for future reference refresh work. This is the bridge to `reference/`. |
|
|
64
64
|
| ADR | Architecture Decision Record. Use for durable decisions and tradeoffs. |
|
|
65
65
|
| `brief.html` | Optional human-friendly presentation layer. |
|
|
66
66
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "code-anchored-context",
|
|
3
|
-
"version": "0.2.
|
|
4
|
-
"description": "Install repo-local agent context, release initiatives, and release-anchored
|
|
3
|
+
"version": "0.2.3",
|
|
4
|
+
"description": "Install repo-local agent context, release initiatives, and release-anchored reference scaffolding into an existing project.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
7
7
|
"bin": {
|
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
"context/releases/v0_1_0/backlog.md",
|
|
21
21
|
"context/releases/v0_1_0/initiatives/.gitkeep",
|
|
22
22
|
"context/terminology.md",
|
|
23
|
-
"
|
|
23
|
+
"reference/",
|
|
24
24
|
"bin/",
|
|
25
25
|
"README.md",
|
|
26
26
|
"LICENSE"
|
|
@@ -37,6 +37,6 @@
|
|
|
37
37
|
"ai",
|
|
38
38
|
"documentation",
|
|
39
39
|
"working-context",
|
|
40
|
-
"
|
|
40
|
+
"reference"
|
|
41
41
|
]
|
|
42
42
|
}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# Reference
|
|
2
|
+
|
|
3
|
+
This folder holds release-anchored reference material for PROJECT_NAME.
|
|
4
|
+
|
|
5
|
+
Reference describes accepted system behavior for a known release, tag, or
|
|
6
|
+
explicit baseline. It is not the place for in-progress planning,
|
|
7
|
+
implementation notes, or draft architecture decisions. Put that work in
|
|
8
|
+
`context/`.
|
|
9
|
+
|
|
10
|
+
## Start Here
|
|
11
|
+
|
|
12
|
+
- `releases/index.md` records release or baseline reference refreshes.
|
|
13
|
+
- `_authoring/README.md` explains how humans and agents should author
|
|
14
|
+
reference material.
|
|
15
|
+
- `_authoring/workflow.md` defines when reference material is refreshed and what
|
|
16
|
+
belongs here.
|
|
17
|
+
- `_authoring/areas/` contains per-area authoring guidance.
|
|
18
|
+
|
|
19
|
+
## Standard Layout
|
|
20
|
+
|
|
21
|
+
```text
|
|
22
|
+
reference/
|
|
23
|
+
README.md
|
|
24
|
+
releases/
|
|
25
|
+
index.md
|
|
26
|
+
_authoring/
|
|
27
|
+
README.md
|
|
28
|
+
workflow.md
|
|
29
|
+
terminology.md
|
|
30
|
+
areas/
|
|
31
|
+
<area>.md
|
|
32
|
+
_templates/
|
|
33
|
+
area/
|
|
34
|
+
README.md
|
|
35
|
+
features/
|
|
36
|
+
feature-template.md
|
|
37
|
+
<Area>/
|
|
38
|
+
README.md
|
|
39
|
+
features/
|
|
40
|
+
<feature>.md
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Every documented area should have:
|
|
44
|
+
|
|
45
|
+
- a high-level `README.md` that explains the area's purpose and architecture
|
|
46
|
+
- one page per feature under `features/`
|
|
47
|
+
- an authoring guide under `reference/_authoring/areas/`
|
|
48
|
+
|
|
49
|
+
## Contributing
|
|
50
|
+
|
|
51
|
+
- Refresh reference material only when explicitly asked.
|
|
52
|
+
- For existing projects with little or no reference material, create
|
|
53
|
+
baseline reference only when explicitly asked; otherwise document touched
|
|
54
|
+
behavior during future release refreshes.
|
|
55
|
+
- Write for non-developer technical readers unless the project states
|
|
56
|
+
otherwise.
|
|
57
|
+
- Write from behavior outward: product-readable first, technically anchored
|
|
58
|
+
where details affect shipped behavior, operations, or support.
|
|
59
|
+
- Describe behavior, inputs, outputs, permissions, errors, business rules, and
|
|
60
|
+
operational expectations in domain language.
|
|
61
|
+
- Prefer Mermaid diagrams for flows, architecture, and relationships.
|
|
62
|
+
- Add release refreshes to `reference/releases/index.md`.
|
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Reference Authoring Guide
|
|
2
2
|
|
|
3
|
-
This subtree owns all guidance for authoring and refreshing the
|
|
4
|
-
under `
|
|
5
|
-
|
|
3
|
+
This subtree owns all guidance for authoring and refreshing the reference
|
|
4
|
+
under `reference/`. Humans and agents both read from here to know how
|
|
5
|
+
reference is structured, when it is refreshed, what belongs in each area,
|
|
6
6
|
and which domain terminology to use.
|
|
7
7
|
|
|
8
8
|
## Start Here
|
|
9
9
|
|
|
10
|
-
- [`workflow.md`](workflow.md) explains how
|
|
11
|
-
structured.
|
|
10
|
+
- [`workflow.md`](workflow.md) explains how reference is versioned,
|
|
11
|
+
refreshed, and structured.
|
|
12
12
|
- [`terminology.md`](terminology.md) holds project-specific domain language.
|
|
13
13
|
- [`areas/`](areas/) contains one file per documented area, covering feature
|
|
14
14
|
inventory, code orientation, conventions, and what matters at release time.
|
|
@@ -18,14 +18,14 @@ and which domain terminology to use.
|
|
|
18
18
|
Create one authoring guide per documented area:
|
|
19
19
|
|
|
20
20
|
```text
|
|
21
|
-
|
|
21
|
+
reference/_authoring/areas/<area-slug>.md
|
|
22
22
|
```
|
|
23
23
|
|
|
24
24
|
Each area guide should identify:
|
|
25
25
|
|
|
26
26
|
- the source locations that own the behavior, such as product code,
|
|
27
27
|
interfaces, tests, CI/CD, generated artifacts, infrastructure, or config
|
|
28
|
-
- the
|
|
28
|
+
- the reference root under `reference/`
|
|
29
29
|
- feature pages that should exist
|
|
30
30
|
- behavior that matters at release time
|
|
31
31
|
- changes to ignore, such as pure refactors or test-only edits
|
|
@@ -36,7 +36,7 @@ Use [`areas/_template.md`](areas/_template.md) when adding a new area guide.
|
|
|
36
36
|
## Relationship To `AGENTS.md`
|
|
37
37
|
|
|
38
38
|
Area `AGENTS.md` files may point here, but they should not copy the detailed
|
|
39
|
-
|
|
39
|
+
reference workflow. Keep authoring rules in this subtree so the guidance
|
|
40
40
|
has one source of truth.
|
|
41
41
|
|
|
42
42
|
## Contributing
|
|
@@ -5,10 +5,10 @@ This folder contains one authoring guide per documented area.
|
|
|
5
5
|
Create a guide from `_template.md` when adding a documentation area:
|
|
6
6
|
|
|
7
7
|
```text
|
|
8
|
-
|
|
8
|
+
reference/_authoring/areas/<area-slug>.md
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
Each guide should help a human or agent refresh
|
|
11
|
+
Each guide should help a human or agent refresh reference from a release diff
|
|
12
12
|
without rediscovering the area's structure from scratch.
|
|
13
13
|
|
|
14
14
|
## Current Area Guides
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
- Source orientation: `path/to/runtime-or-product-code`, `path/to/contracts`,
|
|
6
6
|
`path/to/tests`, `path/to/ci-or-delivery`, `path/to/infra-or-config`
|
|
7
|
-
-
|
|
7
|
+
- Reference root: `reference/<Area>/`
|
|
8
8
|
- Owner or reviewer: TBD
|
|
9
9
|
|
|
10
10
|
Describe what this area owns and what it intentionally does not own.
|
|
@@ -18,9 +18,9 @@ operational expectations without private implementation detail.
|
|
|
18
18
|
|
|
19
19
|
## Feature Inventory
|
|
20
20
|
|
|
21
|
-
| Feature |
|
|
21
|
+
| Feature | Reference page | Notes |
|
|
22
22
|
| --- | --- | --- |
|
|
23
|
-
| TBD | `
|
|
23
|
+
| TBD | `reference/<Area>/features/<feature>.md` | TBD |
|
|
24
24
|
|
|
25
25
|
## What Matters At Release Time
|
|
26
26
|
|
|
@@ -57,9 +57,9 @@ known gaps, and questions that should not yet appear in product-facing docs.
|
|
|
57
57
|
|
|
58
58
|
## Terminology
|
|
59
59
|
|
|
60
|
-
List area-specific terms or link to `
|
|
60
|
+
List area-specific terms or link to `reference/_authoring/terminology.md`.
|
|
61
61
|
|
|
62
62
|
## Cross-Links
|
|
63
63
|
|
|
64
|
-
List related areas and when
|
|
64
|
+
List related areas and when reference should cross-link instead of duplicating
|
|
65
65
|
behavior.
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Use this file to define the domain language that documentation should use.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Reference should translate code-level names into reader-facing domain
|
|
6
6
|
terms when those differ. The goal is consistency for QA, product, support,
|
|
7
7
|
operators, and future agents.
|
|
8
8
|
|
|
@@ -1,95 +1,96 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Reference Workflow
|
|
2
2
|
|
|
3
|
-
This file defines how
|
|
3
|
+
This file defines how reference material is versioned, refreshed, and structured
|
|
4
4
|
across the repo. It applies to all documented areas; area-specific guidance
|
|
5
5
|
lives in [`areas/`](areas/).
|
|
6
6
|
|
|
7
|
-
## When
|
|
7
|
+
## When Reference Gets Edited
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
work. Humans or agents touch `
|
|
9
|
+
Reference refresh is an explicit, on-request activity, not a side effect of
|
|
10
|
+
code work. Humans or agents touch `reference/` only when:
|
|
11
11
|
|
|
12
12
|
- A human explicitly asks for a release-time refresh, typically after the
|
|
13
13
|
release tag is cut and QA has signed off.
|
|
14
|
-
- A human explicitly asks for baseline
|
|
15
|
-
|
|
14
|
+
- A human explicitly asks for baseline reference for an existing project, such
|
|
15
|
+
as "document this repo baseline" or "create initial reference for the current
|
|
16
16
|
system."
|
|
17
17
|
- A human explicitly asks to update a specific page.
|
|
18
18
|
- A human asks to fix a demonstrable error in an existing page, such as a
|
|
19
19
|
broken link or factual inaccuracy.
|
|
20
20
|
|
|
21
|
-
Do not update
|
|
22
|
-
bump. Mid-stream commits are partial work; "feature complete" is only
|
|
21
|
+
Do not update reference as part of a feature PR, bug fix, refactor, or
|
|
22
|
+
dependency bump. Mid-stream commits are partial work; "feature complete" is only
|
|
23
23
|
well-defined once the release is accepted.
|
|
24
24
|
|
|
25
|
-
Agents: if you are working on a code change and notice
|
|
25
|
+
Agents: if you are working on a code change and notice reference material that looks
|
|
26
26
|
outdated, leave it alone. Flag the staleness in your summary or add it to the
|
|
27
|
-
initiative's `release-doc-notes.md`, but do not edit the
|
|
28
|
-
current change unless explicitly asked.
|
|
27
|
+
initiative's `release-doc-notes.md`, but do not edit the reference material as
|
|
28
|
+
part of the current change unless explicitly asked.
|
|
29
29
|
|
|
30
|
-
##
|
|
30
|
+
## Reference Modes
|
|
31
31
|
|
|
32
|
-
There are two valid ways to introduce or maintain `
|
|
32
|
+
There are two valid ways to introduce or maintain `reference/`.
|
|
33
33
|
|
|
34
|
-
### Baseline
|
|
34
|
+
### Baseline Reference
|
|
35
35
|
|
|
36
36
|
Use this mode only when a human explicitly asks to document the current system
|
|
37
37
|
as a starting point. This is common when adopting the template in an existing
|
|
38
|
-
project that has little or no
|
|
38
|
+
project that has little or no reference material.
|
|
39
39
|
|
|
40
40
|
When creating a baseline:
|
|
41
41
|
|
|
42
42
|
1. Confirm the scope: whole repo, one product area, one feature family, or one
|
|
43
43
|
operational surface.
|
|
44
44
|
2. Create or update the matching area guide under
|
|
45
|
-
`
|
|
45
|
+
`reference/_authoring/areas/` before writing reference pages.
|
|
46
46
|
3. Document stable, currently accepted behavior from the current branch,
|
|
47
47
|
current tag, or explicit reference point named by the human.
|
|
48
48
|
4. Prefer broad, accurate coverage over exhaustive implementation detail.
|
|
49
|
-
5. Record the baseline reference in `
|
|
49
|
+
5. Record the baseline reference in `reference/releases/index.md`. If
|
|
50
50
|
there is no release tag yet, use the commit, branch, date, or human-named
|
|
51
51
|
baseline label that was used as the source.
|
|
52
|
-
6. Leave uncertain or future behavior out of `
|
|
52
|
+
6. Leave uncertain or future behavior out of `reference/`. Capture open
|
|
53
53
|
questions in `context/` or in the area authoring guide.
|
|
54
54
|
|
|
55
|
-
Baseline
|
|
56
|
-
that every undocumented behavior is unimportant.
|
|
55
|
+
Baseline reference is a snapshot of the system as adopted; it is not a
|
|
56
|
+
promise that every undocumented behavior is unimportant.
|
|
57
57
|
|
|
58
|
-
### Release-Forward
|
|
58
|
+
### Release-Forward Reference
|
|
59
59
|
|
|
60
60
|
Use this mode when the team chooses not to create a full baseline. In this
|
|
61
|
-
mode, `
|
|
62
|
-
|
|
63
|
-
|
|
61
|
+
mode, `reference/` may start sparse. Agents capture reference impact in
|
|
62
|
+
initiative `release-doc-notes.md` during development, then update reference
|
|
63
|
+
only at explicit release-refresh time.
|
|
64
64
|
|
|
65
|
-
This is valid when a full baseline would be too expensive. The
|
|
65
|
+
This is valid when a full baseline would be too expensive. The reference
|
|
66
66
|
becomes complete incrementally around behavior the team changes and releases.
|
|
67
67
|
|
|
68
68
|
## Cadence And Versioning
|
|
69
69
|
|
|
70
|
-
|
|
71
|
-
refreshed once per release, at git-tag time, after release acceptance.
|
|
72
|
-
|
|
73
|
-
|
|
70
|
+
Reference lives under `reference/`. After any explicit baseline pass, it is
|
|
71
|
+
refreshed once per release, at git-tag time, after release acceptance.
|
|
72
|
+
Reference is anchored to the release tag; reference at tag `release/v1_2_3`
|
|
73
|
+
describes the behavior of that release.
|
|
74
74
|
|
|
75
75
|
Default tag names follow the convention `release/vMAJOR_MINOR_PATCH` and match
|
|
76
76
|
the release branch name. If a project uses a different release convention,
|
|
77
77
|
document it here before the first refresh. If the first documentation pass is
|
|
78
78
|
a baseline without a tag, record the baseline reference in
|
|
79
|
-
`
|
|
79
|
+
`reference/releases/index.md`.
|
|
80
80
|
|
|
81
81
|
## Audience
|
|
82
82
|
|
|
83
|
-
|
|
84
|
-
owners, solution owners, support engineers, customer engineers, or
|
|
85
|
-
Adjust this only when the project explicitly defines a different
|
|
83
|
+
Reference is written for non-developer technical readers by default: QA,
|
|
84
|
+
product owners, solution owners, support engineers, customer engineers, or
|
|
85
|
+
operators. Adjust this only when the project explicitly defines a different
|
|
86
|
+
audience.
|
|
86
87
|
|
|
87
88
|
- Describe behavior, inputs, outputs, permissions, error conditions, and
|
|
88
89
|
business rules in domain language.
|
|
89
90
|
- Avoid code snippets, private type names, SQL, and framework jargon unless
|
|
90
91
|
the concept has no plain-language equivalent.
|
|
91
|
-
- For readers who need more depth than the
|
|
92
|
-
rather than replicating the implementation in prose.
|
|
92
|
+
- For readers who need more depth than the reference provides, link to the
|
|
93
|
+
source rather than replicating the implementation in prose.
|
|
93
94
|
|
|
94
95
|
## Writing Focus
|
|
95
96
|
|
|
@@ -100,10 +101,10 @@ or business process can observe. Add technical detail only when it affects
|
|
|
100
101
|
released behavior, configuration, permissions, data, integrations, errors,
|
|
101
102
|
support, operations, or auditability.
|
|
102
103
|
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
104
|
+
Reference should be product-readable first and technically anchored second. It
|
|
105
|
+
can feed release notes, but it is more durable than release notes: release
|
|
106
|
+
notes summarize what changed, while `reference/` describes what the accepted
|
|
107
|
+
system does as of a release or baseline.
|
|
107
108
|
|
|
108
109
|
Use progressive depth:
|
|
109
110
|
|
|
@@ -127,7 +128,7 @@ Every documented area has two layers:
|
|
|
127
128
|
Standard per-area layout:
|
|
128
129
|
|
|
129
130
|
```text
|
|
130
|
-
|
|
131
|
+
reference/<Area>/
|
|
131
132
|
README.md
|
|
132
133
|
features/
|
|
133
134
|
<feature>.md
|
|
@@ -158,29 +159,29 @@ Preferred diagram types:
|
|
|
158
159
|
Keep diagrams small enough to read. If a diagram needs more than about 15 nodes
|
|
159
160
|
or steps, simplify it or split it.
|
|
160
161
|
|
|
161
|
-
## Feature
|
|
162
|
+
## Feature Reference Covers The Full Vertical
|
|
162
163
|
|
|
163
|
-
A feature
|
|
164
|
+
A feature reference page should describe the full behavior path the feature touches:
|
|
164
165
|
entry point, important services or processes, data stored or read, external
|
|
165
166
|
systems, permissions, validation, errors, and operational expectations.
|
|
166
167
|
|
|
167
|
-
If a feature spans multiple areas, place the
|
|
168
|
+
If a feature spans multiple areas, place the page in the area that owns the
|
|
168
169
|
user-facing or operator-facing entry point. Cross-link from the other areas.
|
|
169
170
|
|
|
170
|
-
## Release-Time
|
|
171
|
+
## Release-Time Reference Refresh
|
|
171
172
|
|
|
172
|
-
When invoked to refresh
|
|
173
|
+
When invoked to refresh reference for a release:
|
|
173
174
|
|
|
174
175
|
1. Work from the diff `<previous-release-tag>..HEAD`, scoped to one area at a
|
|
175
176
|
time.
|
|
176
|
-
2. Read the matching area guide in `
|
|
177
|
+
2. Read the matching area guide in `reference/_authoring/areas/`.
|
|
177
178
|
3. Read relevant initiative `release-doc-notes.md` files under
|
|
178
179
|
`context/releases/<release>/initiatives/`.
|
|
179
180
|
4. Update the area's `README.md` if the high-level picture changed.
|
|
180
181
|
5. Update feature pages for behavior that changed.
|
|
181
182
|
6. Ignore pure refactors, internal renames, test-only changes, formatting,
|
|
182
183
|
lint fixes, and dependency bumps with no behavior change.
|
|
183
|
-
7. Append one row to `
|
|
184
|
+
7. Append one row to `reference/releases/index.md`.
|
|
184
185
|
|
|
185
186
|
## Source Order
|
|
186
187
|
|
|
@@ -189,12 +190,12 @@ source inspection:
|
|
|
189
190
|
|
|
190
191
|
1. Previous release tag to current release diff.
|
|
191
192
|
2. Relevant initiative `release-doc-notes.md` files.
|
|
192
|
-
3. Matching area guide under `
|
|
193
|
-
4. Existing
|
|
193
|
+
3. Matching area guide under `reference/_authoring/areas/`.
|
|
194
|
+
4. Existing reference.
|
|
194
195
|
5. Source code, tests, config, CI/CD, infrastructure, and generated artifacts
|
|
195
196
|
only as needed to verify shipped behavior.
|
|
196
197
|
|
|
197
|
-
For baseline
|
|
198
|
+
For baseline reference, start from the explicit baseline scope and
|
|
198
199
|
reference point named by the human. If no reference is named, use the current
|
|
199
200
|
working tree and say so in the release index row.
|
|
200
201
|
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
# Release
|
|
1
|
+
# Reference Release Index
|
|
2
2
|
|
|
3
3
|
One row per tagged release. Tag names default to `release/vMAJOR_MINOR_PATCH`
|
|
4
4
|
unless the project documents a different convention.
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
Reference at a given tag describes the behavior of that release.
|
|
7
7
|
|
|
8
8
|
| Tag | Date | Areas refreshed | Owner | Summary |
|
|
9
9
|
| --- | --- | --- | --- | --- |
|
package/docs/.order
DELETED
package/docs/Welcome.md
DELETED
|
@@ -1,48 +0,0 @@
|
|
|
1
|
-
# PROJECT_NAME Docs
|
|
2
|
-
|
|
3
|
-
Welcome to the release-anchored documentation for PROJECT_NAME.
|
|
4
|
-
|
|
5
|
-
This folder describes shipped behavior for a known release or tag. It is not
|
|
6
|
-
the place for in-progress feature planning, implementation notes, or draft
|
|
7
|
-
architecture decisions. Put that work in `context/`.
|
|
8
|
-
|
|
9
|
-
## How These Docs Are Organized
|
|
10
|
-
|
|
11
|
-
```text
|
|
12
|
-
docs/
|
|
13
|
-
.order
|
|
14
|
-
Welcome.md
|
|
15
|
-
releases/
|
|
16
|
-
index.md
|
|
17
|
-
_authoring/
|
|
18
|
-
README.md
|
|
19
|
-
workflow.md
|
|
20
|
-
terminology.md
|
|
21
|
-
areas/
|
|
22
|
-
<area>.md
|
|
23
|
-
<Area>/
|
|
24
|
-
README.md
|
|
25
|
-
features/
|
|
26
|
-
<feature>.md
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
Every documented area should have:
|
|
30
|
-
|
|
31
|
-
- a high-level `README.md` that explains the area's purpose and architecture
|
|
32
|
-
- one page per feature under `features/`
|
|
33
|
-
- an authoring guide under `docs/_authoring/areas/`
|
|
34
|
-
|
|
35
|
-
## Contributing
|
|
36
|
-
|
|
37
|
-
- Refresh docs only when explicitly asked.
|
|
38
|
-
- For existing projects with no docs, create baseline documentation only when
|
|
39
|
-
explicitly asked; otherwise document touched behavior during future release
|
|
40
|
-
refreshes.
|
|
41
|
-
- Write for non-developer technical readers unless the project states
|
|
42
|
-
otherwise.
|
|
43
|
-
- Write from behavior outward: product-readable first, technically anchored
|
|
44
|
-
where details affect shipped behavior, operations, or support.
|
|
45
|
-
- Describe behavior, inputs, outputs, permissions, errors, business rules, and
|
|
46
|
-
operational expectations in domain language.
|
|
47
|
-
- Prefer Mermaid diagrams for flows, architecture, and relationships.
|
|
48
|
-
- Add release refreshes to `docs/releases/index.md`.
|
|
File without changes
|
|
File without changes
|