code-anchored-context 0.2.2 → 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.
@@ -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 product-docs/ should be left untouched.
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 product
63
- documentation.
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`: product-documentation impact to review at release
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 Product Docs Boundary
178
+ ### 9) Preserve The Reference Boundary
179
179
 
180
- Do not edit `product-docs/` as part of normal feature work, bug fixes,
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 `product-docs/` when a human explicitly asks for release
185
- documentation work, a specific page update, or a demonstrable documentation
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 product-documentation impact was captured in `release-doc-notes.md`.
209
- - `product-docs/` was left untouched unless explicitly requested.
207
+ - Future reference impact was captured in `release-doc-notes.md`.
208
+ - `reference/` was left untouched unless explicitly requested.
package/AGENTS.md CHANGED
@@ -14,21 +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
- ## Product Docs Authoring
17
+ ## Reference Authoring
18
18
 
19
- ### When To Edit `product-docs/`
19
+ ### When To Edit `reference/`
20
20
 
21
- Do not edit `product-docs/` as a side effect of feature work, bug fixes,
22
- refactors, or other code changes. Product docs in this model are
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
23
  release-anchored:
24
24
  they describe the behavior of a specific release tag, not the partial state of
25
25
  a working branch.
26
26
 
27
- Touch `product-docs/` only when:
27
+ Touch `reference/` only when:
28
28
 
29
- - A human explicitly asks you to refresh product docs for a release, typically
29
+ - A human explicitly asks you to refresh reference for a release, typically
30
30
  after a release tag is cut and QA has signed off.
31
- - A human explicitly asks you to create or refresh baseline documentation for
31
+ - A human explicitly asks you to create or refresh baseline reference for
32
32
  an existing project.
33
33
  - A human explicitly asks you to update a specific page.
34
34
  - A human asks you to fix a demonstrable error in an existing page, such as a
@@ -36,20 +36,20 @@ Touch `product-docs/` only when:
36
36
 
37
37
  If you are unsure whether the request is one of these, ask before editing.
38
38
 
39
- If a project has documentation that intentionally follows a different cadence,
39
+ If a project has reference material that intentionally follows a different cadence,
40
40
  document that exception in the area's README and in
41
- `product-docs/_authoring/areas/`.
41
+ `reference/_authoring/areas/`.
42
42
 
43
43
  ### Where The Authoring Guidance Lives
44
44
 
45
- All documentation workflow, per-area authoring guides, and domain terminology
46
- live under [`product-docs/_authoring/`](product-docs/_authoring/). Start
47
- with [`product-docs/_authoring/README.md`](product-docs/_authoring/README.md).
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).
48
48
 
49
- If you are refreshing product docs, the per-area guides in
50
- [`product-docs/_authoring/areas/`](product-docs/_authoring/areas/) tell you
49
+ If you are refreshing reference, the per-area guides in
50
+ [`reference/_authoring/areas/`](reference/_authoring/areas/) tell you
51
51
  what matters and what to ignore for each area.
52
52
 
53
53
  `AGENTS.md` files stay lean. They are for coding conventions and agent
54
- restrictions, not detailed documentation guidance. If you have doc rules to
54
+ restrictions, not detailed reference guidance. If you have reference rules to
55
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 product documentation close to the
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
- | `product-docs/` | What the product does as of a known release or tag. | Only during explicit documentation refresh work. |
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
@@ -22,7 +22,7 @@ notes.
22
22
  working-context workflow.
23
23
  - `context/` with terminology, release context, backlog/program structure,
24
24
  initiative templates, and release-documentation notes.
25
- - `product-docs/` with a generic release-anchored documentation workflow,
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-product-docs
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 `product-docs/_authoring/`.
58
- 5. Create `product-docs/_authoring/areas/<area>.md` for each documented
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 documentation out of this template repo.
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. Product docs should
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 documentation impact in the relevant initiative's
84
- `release-doc-notes.md`; refresh `product-docs/` only when that work is
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({ includeProductDocs: args.productDocs });
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
- productDocs: true,
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-product-docs' || arg === '--no-docs') {
99
- options.productDocs = false;
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-product-docs Skip the product-docs/ starter files.
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-product-docs
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({ includeProductDocs }) {
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 (includeProductDocs) {
228
- await this.copyTemplatePath('product-docs', 'product-docs');
226
+ if (includeReference) {
227
+ await this.copyTemplatePath('reference', 'reference');
229
228
  } else {
230
- this.note('skip product-docs/ (--no-product-docs)');
229
+ this.note('skip reference/ (--no-reference)');
231
230
  }
232
231
 
233
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
- `product-docs/` describes what has shipped for a release.
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 `product-docs/`.
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 product documentation later.
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
- `product-docs/` for in-progress development planning.
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 product-docs/
23
+ ## Relationship To reference/
24
24
 
25
- `context/` and `product-docs/` serve different jobs:
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
- | `product-docs/` | What the product does as of a release or tag. | Only during explicit documentation refresh work. |
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 documentation, but it is not product
33
- documentation. Capture that bridge in each initiative's
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` | Product documentation impact to review at release time. |
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 product-doc impact in `release-doc-notes.md`, not in
250
- `product-docs/`, unless a human explicitly asks for documentation refresh.
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
- - Product docs or release notes: `path/to/...`
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 `product-docs/` from this initiative unless a human
63
- explicitly asks for release documentation work.
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 product-documentation impact
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 product-documentation impact into `release-doc-notes.md`
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 product-documentation impact while development is
4
- in progress. At release time, these notes help refresh `product-docs/`
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 `product-docs/` from normal development work unless a human
8
- explicitly asks for a documentation refresh or a specific documentation fix.
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 Product Docs Areas
14
+ ## Candidate Reference Areas
15
15
 
16
- - `product-docs/<Area>/README.md`
17
- - `product-docs/<Area>/features/<feature>.md`
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 product documentation only after release-doc work
32
+ - [ ] Update the relevant reference only after release-doc work
33
33
  is explicitly requested.
34
- - [ ] Add the release row if the documentation workflow requires it.
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
- - Product docs or release notes: `path/to/...`
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 product-documentation impact into `release-doc-notes.md`
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 product-documentation impact while future
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 `product-docs/` from normal development work unless a human
8
- explicitly asks for a documentation refresh or a specific documentation fix.
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 Product Docs Areas
14
+ ## Candidate Reference Areas
15
15
 
16
- - `product-docs/<Area>/README.md`
17
- - `product-docs/<Area>/features/<feature>.md`
16
+ - `reference/<Area>/README.md`
17
+ - `reference/<Area>/features/<feature>.md`
18
18
 
19
19
  ## QA Or Support Notes
20
20
 
@@ -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
- | `product-docs/` | Released product documentation. It describes shipped behavior for a release/tag and is not edited during normal development work. |
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 product documentation refresh work. This is the bridge to `product-docs/`. |
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.2",
4
- "description": "Install repo-local agent context, release initiatives, and release-anchored product-docs scaffolding into an existing project.",
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
- "product-docs/",
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
- "product-docs"
40
+ "reference"
41
41
  ]
42
42
  }
@@ -1,24 +1,25 @@
1
- # Product Docs
1
+ # Reference
2
2
 
3
- This folder holds release-anchored product documentation for PROJECT_NAME.
3
+ This folder holds release-anchored reference material for PROJECT_NAME.
4
4
 
5
- Product docs describe shipped behavior for a known release, tag, or explicit
6
- baseline. They are not the place for in-progress planning, implementation
7
- notes, or draft architecture decisions. Put that work in `context/`.
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/`.
8
9
 
9
10
  ## Start Here
10
11
 
11
- - `releases/index.md` records release or baseline documentation refreshes.
12
- - `_authoring/README.md` explains how humans and agents should author product
13
- docs.
14
- - `_authoring/workflow.md` defines when product docs are refreshed and what
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
15
16
  belongs here.
16
17
  - `_authoring/areas/` contains per-area authoring guidance.
17
18
 
18
19
  ## Standard Layout
19
20
 
20
21
  ```text
21
- product-docs/
22
+ reference/
22
23
  README.md
23
24
  releases/
24
25
  index.md
@@ -43,13 +44,13 @@ Every documented area should have:
43
44
 
44
45
  - a high-level `README.md` that explains the area's purpose and architecture
45
46
  - one page per feature under `features/`
46
- - an authoring guide under `product-docs/_authoring/areas/`
47
+ - an authoring guide under `reference/_authoring/areas/`
47
48
 
48
49
  ## Contributing
49
50
 
50
- - Refresh product docs only when explicitly asked.
51
- - For existing projects with little or no product documentation, create
52
- baseline product docs only when explicitly asked; otherwise document touched
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
53
54
  behavior during future release refreshes.
54
55
  - Write for non-developer technical readers unless the project states
55
56
  otherwise.
@@ -58,4 +59,4 @@ Every documented area should have:
58
59
  - Describe behavior, inputs, outputs, permissions, errors, business rules, and
59
60
  operational expectations in domain language.
60
61
  - Prefer Mermaid diagrams for flows, architecture, and relationships.
61
- - Add release refreshes to `product-docs/releases/index.md`.
62
+ - Add release refreshes to `reference/releases/index.md`.
@@ -1,13 +1,13 @@
1
- # Product Docs Authoring Guide
1
+ # Reference Authoring Guide
2
2
 
3
- This subtree owns all guidance for authoring and refreshing the documentation
4
- under `product-docs/`. Humans and agents both read from here to know how
5
- documentation is structured, when it is refreshed, what belongs in each area,
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 product docs are versioned,
10
+ - [`workflow.md`](workflow.md) explains how reference is versioned,
11
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
@@ -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
- product-docs/_authoring/areas/<area-slug>.md
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 product docs root under `product-docs/`
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
- documentation workflow. Keep authoring rules in this subtree so the guidance
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
- product-docs/_authoring/areas/<area-slug>.md
8
+ reference/_authoring/areas/<area-slug>.md
9
9
  ```
10
10
 
11
- Each guide should help a human or agent refresh product docs from a release diff
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
- - Product docs root: `product-docs/<Area>/`
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 | Product docs page | Notes |
21
+ | Feature | Reference page | Notes |
22
22
  | --- | --- | --- |
23
- | TBD | `product-docs/<Area>/features/<feature>.md` | 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 `product-docs/_authoring/terminology.md`.
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 product docs should cross-link instead of duplicating
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
- Product docs should translate code-level names into reader-facing domain
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,86 +1,86 @@
1
- # Product Docs Workflow
1
+ # Reference Workflow
2
2
 
3
- This file defines how documentation is versioned, refreshed, and structured
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 Product Docs Get Edited
7
+ ## When Reference Gets Edited
8
8
 
9
- Doc refresh is an explicit, on-request activity, not a side effect of code
10
- work. Humans or agents touch `product-docs/` only when:
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 documentation for an existing project,
15
- such as "document this repo baseline" or "create initial docs for the current
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 product docs as part of a feature PR, bug fix, refactor, or
21
+ Do not update reference as part of a feature PR, bug fix, refactor, or
22
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 a doc that looks
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 doc as part of 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
- ## Product Docs Modes
30
+ ## Reference Modes
31
31
 
32
- There are two valid ways to introduce or maintain `product-docs/`.
32
+ There are two valid ways to introduce or maintain `reference/`.
33
33
 
34
- ### Baseline Product Docs
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 product documentation.
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
- `product-docs/_authoring/areas/` before writing product-facing pages.
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 `product-docs/releases/index.md`. If
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 `product-docs/`. Capture open
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 product docs are a snapshot of the system as adopted; they are not a
55
+ Baseline reference is a snapshot of the system as adopted; it is not a
56
56
  promise that every undocumented behavior is unimportant.
57
57
 
58
- ### Release-Forward Product Docs
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, `product-docs/` may start sparse. Agents capture documentation impact
62
- in initiative `release-doc-notes.md` during development, then update product
63
- product docs only at explicit release-refresh time.
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 documentation
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
- Product docs live under `product-docs/`. After any explicit baseline pass,
71
- they are refreshed once per release, at git-tag time, after release acceptance.
72
- Product docs are anchored to the release tag; product docs at tag
73
- `release/v1_2_3` describe the behavior of that release.
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
- `product-docs/releases/index.md`.
79
+ `reference/releases/index.md`.
80
80
 
81
81
  ## Audience
82
82
 
83
- Product docs are written for non-developer technical readers by default: QA,
83
+ Reference is written for non-developer technical readers by default: QA,
84
84
  product owners, solution owners, support engineers, customer engineers, or
85
85
  operators. Adjust this only when the project explicitly defines a different
86
86
  audience.
@@ -89,7 +89,7 @@ audience.
89
89
  business rules in domain language.
90
90
  - Avoid code snippets, private type names, SQL, and framework jargon unless
91
91
  the concept has no plain-language equivalent.
92
- - For readers who need more depth than the product docs provide, link to the
92
+ - For readers who need more depth than the reference provides, link to the
93
93
  source rather than replicating the implementation in prose.
94
94
 
95
95
  ## Writing Focus
@@ -101,10 +101,10 @@ or business process can observe. Add technical detail only when it affects
101
101
  released behavior, configuration, permissions, data, integrations, errors,
102
102
  support, operations, or auditability.
103
103
 
104
- Product docs should be product-readable first and technically anchored
105
- second. They can feed release notes, but they are more durable than release
106
- notes: release notes summarize what changed, while `product-docs/` describes
107
- what the accepted system does as of a release or baseline.
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.
108
108
 
109
109
  Use progressive depth:
110
110
 
@@ -128,7 +128,7 @@ Every documented area has two layers:
128
128
  Standard per-area layout:
129
129
 
130
130
  ```text
131
- product-docs/<Area>/
131
+ reference/<Area>/
132
132
  README.md
133
133
  features/
134
134
  <feature>.md
@@ -159,29 +159,29 @@ Preferred diagram types:
159
159
  Keep diagrams small enough to read. If a diagram needs more than about 15 nodes
160
160
  or steps, simplify it or split it.
161
161
 
162
- ## Feature Docs Cover The Full Vertical
162
+ ## Feature Reference Covers The Full Vertical
163
163
 
164
- A feature doc should describe the full behavior path the feature touches:
164
+ A feature reference page should describe the full behavior path the feature touches:
165
165
  entry point, important services or processes, data stored or read, external
166
166
  systems, permissions, validation, errors, and operational expectations.
167
167
 
168
- If a feature spans multiple areas, place the doc in the area that owns the
168
+ If a feature spans multiple areas, place the page in the area that owns the
169
169
  user-facing or operator-facing entry point. Cross-link from the other areas.
170
170
 
171
- ## Release-Time Doc Refresh
171
+ ## Release-Time Reference Refresh
172
172
 
173
- When invoked to refresh product docs for a release:
173
+ When invoked to refresh reference for a release:
174
174
 
175
175
  1. Work from the diff `<previous-release-tag>..HEAD`, scoped to one area at a
176
176
  time.
177
- 2. Read the matching area guide in `product-docs/_authoring/areas/`.
177
+ 2. Read the matching area guide in `reference/_authoring/areas/`.
178
178
  3. Read relevant initiative `release-doc-notes.md` files under
179
179
  `context/releases/<release>/initiatives/`.
180
180
  4. Update the area's `README.md` if the high-level picture changed.
181
181
  5. Update feature pages for behavior that changed.
182
182
  6. Ignore pure refactors, internal renames, test-only changes, formatting,
183
183
  lint fixes, and dependency bumps with no behavior change.
184
- 7. Append one row to `product-docs/releases/index.md`.
184
+ 7. Append one row to `reference/releases/index.md`.
185
185
 
186
186
  ## Source Order
187
187
 
@@ -190,12 +190,12 @@ source inspection:
190
190
 
191
191
  1. Previous release tag to current release diff.
192
192
  2. Relevant initiative `release-doc-notes.md` files.
193
- 3. Matching area guide under `product-docs/_authoring/areas/`.
194
- 4. Existing product documentation.
193
+ 3. Matching area guide under `reference/_authoring/areas/`.
194
+ 4. Existing reference.
195
195
  5. Source code, tests, config, CI/CD, infrastructure, and generated artifacts
196
196
  only as needed to verify shipped behavior.
197
197
 
198
- For baseline documentation, start from the explicit baseline scope and
198
+ For baseline reference, start from the explicit baseline scope and
199
199
  reference point named by the human. If no reference is named, use the current
200
200
  working tree and say so in the release index row.
201
201
 
@@ -1,9 +1,9 @@
1
- # Product Docs Release Index
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
- Product docs at a given tag describe the behavior of that release.
6
+ Reference at a given tag describes the behavior of that release.
7
7
 
8
8
  | Tag | Date | Areas refreshed | Owner | Summary |
9
9
  | --- | --- | --- | --- | --- |