code-anchored-context 0.2.1 → 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -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 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 product-docs/ should be left untouched.
4
4
  ---
5
5
 
6
6
  # Code-Anchored Context
@@ -175,13 +175,13 @@ 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 Docs Boundary
178
+ ### 9) Preserve The Product Docs Boundary
179
179
 
180
- Do not edit `docs/` as part of normal feature work, bug fixes,
180
+ Do not edit `product-docs/` 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 `docs/` when a human explicitly asks for release
184
+ Only update `product-docs/` when a human explicitly asks for release
185
185
  documentation work, a specific page update, or a demonstrable documentation
186
186
  fix.
187
187
 
@@ -206,4 +206,4 @@ Before finishing behavior-changing work:
206
206
  infrastructure, actionable operations, or backlog state was reflected in the
207
207
  initiative when appropriate.
208
208
  - Future product-documentation impact was captured in `release-doc-notes.md`.
209
- - `docs/` was left untouched unless explicitly requested.
209
+ - `product-docs/` was left untouched unless explicitly requested.
package/AGENTS.md CHANGED
@@ -14,18 +14,19 @@ 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
- ## Docs Authoring
17
+ ## Product Docs Authoring
18
18
 
19
- ### When To Edit `docs/`
19
+ ### When To Edit `product-docs/`
20
20
 
21
- Do not edit `docs/` as a side effect of feature work, bug fixes,
22
- refactors, or other code changes. Docs in this model are release-anchored:
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
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 `docs/` only when:
27
+ Touch `product-docs/` only when:
27
28
 
28
- - A human explicitly asks you to refresh the docs for a release, typically
29
+ - A human explicitly asks you to refresh product docs for a release, typically
29
30
  after a release tag is cut and QA has signed off.
30
31
  - A human explicitly asks you to create or refresh baseline documentation for
31
32
  an existing project.
@@ -37,16 +38,16 @@ If you are unsure whether the request is one of these, ask before editing.
37
38
 
38
39
  If a project has documentation that intentionally follows a different cadence,
39
40
  document that exception in the area's README and in
40
- `docs/_authoring/areas/`.
41
+ `product-docs/_authoring/areas/`.
41
42
 
42
43
  ### Where The Authoring Guidance Lives
43
44
 
44
45
  All documentation workflow, per-area authoring guides, and domain terminology
45
- live under [`docs/_authoring/`](docs/_authoring/). Start
46
- with [`docs/_authoring/README.md`](docs/_authoring/README.md).
46
+ live under [`product-docs/_authoring/`](product-docs/_authoring/). Start
47
+ with [`product-docs/_authoring/README.md`](product-docs/_authoring/README.md).
47
48
 
48
- If you are refreshing docs, the per-area guides in
49
- [`docs/_authoring/areas/`](docs/_authoring/areas/) tell you
49
+ If you are refreshing product docs, the per-area guides in
50
+ [`product-docs/_authoring/areas/`](product-docs/_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
package/README.md CHANGED
@@ -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
- | `docs/` | What the product does as of a known release or tag. | Only during explicit documentation refresh work. |
12
+ | `product-docs/` | What the product does as of a known release or tag. | Only during explicit documentation 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 a human-readable article and brief.
25
- - `docs/` with a generic release-anchored documentation workflow,
24
+ initiative templates, and release-documentation notes.
25
+ - `product-docs/` with a generic release-anchored documentation 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-docs
42
+ npx code-anchored-context init --no-product-docs
43
43
  npx code-anchored-context init --target ../existing-project
44
44
  ```
45
45
 
@@ -54,8 +54,8 @@ 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 `docs/_authoring/`.
58
- 5. Create `docs/_authoring/areas/<area>.md` for each documented
57
+ `context/` and `product-docs/_authoring/`.
58
+ 5. Create `product-docs/_authoring/areas/<area>.md` for each documented
59
59
  product or code area.
60
60
  6. Keep product or domain-specific documentation out of this template repo.
61
61
 
@@ -81,5 +81,5 @@ npx @your-scope/code-anchored-context init
81
81
  Working context can evolve with the branch. Product docs should
82
82
  stay stable and release-accurate. When behavior changes during development,
83
83
  record future documentation impact in the relevant initiative's
84
- `release-doc-notes.md`; refresh `docs/` only when that work is
84
+ `release-doc-notes.md`; refresh `product-docs/` 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({ includeDocs: args.docs });
57
+ await installer.init({ includeProductDocs: args.productDocs });
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
- docs: true,
68
+ productDocs: 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-docs') {
99
- options.docs = false;
98
+ if (arg === '--no-product-docs' || arg === '--no-docs') {
99
+ options.productDocs = false;
100
100
  continue;
101
101
  }
102
102
 
@@ -170,7 +170,8 @@ 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-docs Skip the docs/ starter files.
173
+ --no-product-docs Skip the product-docs/ starter files.
174
+ --no-docs Alias for --no-product-docs.
174
175
  --force Replace existing generated directories.
175
176
  --dry-run Show planned changes without writing files.
176
177
  -h, --help Show help.
@@ -178,7 +179,7 @@ Options:
178
179
 
179
180
  Examples:
180
181
  npx code-anchored-context init --project-name "My App"
181
- npx code-anchored-context init --release v1_0_0 --no-docs
182
+ npx code-anchored-context init --release v1_0_0 --no-product-docs
182
183
  `);
183
184
  }
184
185
 
@@ -215,7 +216,7 @@ class Installer {
215
216
  this.agentsFilePath = path.join(targetRoot, 'AGENTS.md');
216
217
  }
217
218
 
218
- async init({ includeDocs }) {
219
+ async init({ includeProductDocs }) {
219
220
  await this.ensureDirectory(this.targetRoot);
220
221
 
221
222
  await this.installAgentsFile();
@@ -223,10 +224,10 @@ class Installer {
223
224
  await this.copyTemplatePath('context', 'context');
224
225
  await this.renameReleasePaths();
225
226
 
226
- if (includeDocs) {
227
- await this.copyTemplatePath('docs', 'docs');
227
+ if (includeProductDocs) {
228
+ await this.copyTemplatePath('product-docs', 'product-docs');
228
229
  } else {
229
- this.note('skip docs/ (--no-docs)');
230
+ this.note('skip product-docs/ (--no-product-docs)');
230
231
  }
231
232
 
232
233
  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
- `docs/` describes what has shipped for a release.
17
+ `product-docs/` describes what has shipped for a release.
18
18
 
19
19
  ## Editing Rules
20
20
 
@@ -22,7 +22,7 @@ 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 `docs/`.
25
+ - Do not move in-progress plans into `product-docs/`.
26
26
  - Use `release-doc-notes.md` inside an initiative to capture what may need to
27
27
  become product documentation later.
28
28
  - Create initiatives from `context/_templates/initiative/`.
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
- `docs/` for in-progress development planning.
9
+ `product-docs/` for in-progress development planning.
10
10
 
11
11
  ## Start Here
12
12
 
@@ -20,14 +20,14 @@ 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 docs/
23
+ ## Relationship To product-docs/
24
24
 
25
- `context/` and `docs/` serve different jobs:
25
+ `context/` and `product-docs/` 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
- | `docs/` | What the product does as of a release or tag. | Only during explicit documentation refresh work. |
30
+ | `product-docs/` | What the product does as of a release or tag. | Only during explicit documentation refresh work. |
31
31
 
32
32
  Working context can feed release documentation, but it is not product
33
33
  documentation. Capture that bridge in each initiative's
@@ -247,7 +247,7 @@ When changing behavior, agents should:
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
249
  8. Record future product-doc impact in `release-doc-notes.md`, not in
250
- `docs/`, unless a human explicitly asks for documentation refresh.
250
+ `product-docs/`, unless a human explicitly asks for documentation 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
- - Docs or release notes: `path/to/...`
20
+ - Product docs or release notes: `path/to/...`
21
21
 
22
22
  Remove entries that do not apply and add the real paths. Prefer naming the
23
23
  delivery concern over assuming a specific folder layout.
@@ -59,5 +59,5 @@ support, observability, rollback, or repair context.
59
59
  Promote settled conclusions into the stable initiative files.
60
60
  - Update `release-doc-notes.md` when shipped behavior or product-facing
61
61
  behavior changes.
62
- - Do not update `docs/` from this initiative unless a human
62
+ - Do not update `product-docs/` from this initiative unless a human
63
63
  explicitly asks for release documentation work.
@@ -1,20 +1,20 @@
1
1
  # Release Doc Notes
2
2
 
3
3
  Use this file to capture product-documentation impact while development is
4
- in progress. At release time, these notes help refresh `docs/`
4
+ in progress. At release time, these notes help refresh `product-docs/`
5
5
  against the final shipped behavior.
6
6
 
7
- Do not edit `docs/` from normal development work unless a human
7
+ Do not edit `product-docs/` from normal development work unless a human
8
8
  explicitly asks for a documentation refresh or a specific documentation fix.
9
9
 
10
10
  ## Product Behavior Changes
11
11
 
12
12
  - None yet.
13
13
 
14
- ## Candidate Docs Areas
14
+ ## Candidate Product Docs Areas
15
15
 
16
- - `docs/<Area>/README.md`
17
- - `docs/<Area>/features/<feature>.md`
16
+ - `product-docs/<Area>/README.md`
17
+ - `product-docs/<Area>/features/<feature>.md`
18
18
 
19
19
  ## QA Or Support Notes
20
20
 
@@ -32,4 +32,3 @@ ship.
32
32
  - [ ] Update the relevant product documentation only after release-doc work
33
33
  is explicitly requested.
34
34
  - [ ] Add the release row if the documentation workflow requires it.
35
-
@@ -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
- - Docs or release notes: `path/to/...`
22
+ - Product docs or release notes: `path/to/...`
23
23
 
24
24
  Remove entries that do not apply and add the real paths. Prefer naming the
25
25
  delivery concern over assuming a specific folder layout.
@@ -4,17 +4,17 @@ Use this file to capture expected product-documentation impact while future
4
4
  work is being planned. When the planned initiative is promoted and later
5
5
  implemented, compare these notes against the final shipped behavior.
6
6
 
7
- Do not edit `docs/` from normal development work unless a human
7
+ Do not edit `product-docs/` from normal development work unless a human
8
8
  explicitly asks for a documentation refresh or a specific documentation fix.
9
9
 
10
10
  ## Expected Product Behavior Changes
11
11
 
12
12
  - None yet.
13
13
 
14
- ## Candidate Docs Areas
14
+ ## Candidate Product Docs Areas
15
15
 
16
- - `docs/<Area>/README.md`
17
- - `docs/<Area>/features/<feature>.md`
16
+ - `product-docs/<Area>/README.md`
17
+ - `product-docs/<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
-
@@ -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
- | `docs/` | Released product documentation. It describes shipped behavior for a release/tag and is not edited during normal development work. |
12
+ | `product-docs/` | Released product documentation. It describes shipped 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 `docs/`. |
63
+ | `release-doc-notes.md` | Notes for future product documentation refresh work. This is the bridge to `product-docs/`. |
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.1",
4
- "description": "Install repo-local agent context, release initiatives, and release-anchored docs scaffolding into an existing project.",
3
+ "version": "0.2.2",
4
+ "description": "Install repo-local agent context, release initiatives, and release-anchored product-docs 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
- "docs/",
23
+ "product-docs/",
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
- "docs"
40
+ "product-docs"
41
41
  ]
42
42
  }
@@ -0,0 +1,61 @@
1
+ # Product Docs
2
+
3
+ This folder holds release-anchored product documentation for PROJECT_NAME.
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/`.
8
+
9
+ ## Start Here
10
+
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
15
+ belongs here.
16
+ - `_authoring/areas/` contains per-area authoring guidance.
17
+
18
+ ## Standard Layout
19
+
20
+ ```text
21
+ product-docs/
22
+ README.md
23
+ releases/
24
+ index.md
25
+ _authoring/
26
+ README.md
27
+ workflow.md
28
+ terminology.md
29
+ areas/
30
+ <area>.md
31
+ _templates/
32
+ area/
33
+ README.md
34
+ features/
35
+ feature-template.md
36
+ <Area>/
37
+ README.md
38
+ features/
39
+ <feature>.md
40
+ ```
41
+
42
+ Every documented area should have:
43
+
44
+ - a high-level `README.md` that explains the area's purpose and architecture
45
+ - one page per feature under `features/`
46
+ - an authoring guide under `product-docs/_authoring/areas/`
47
+
48
+ ## Contributing
49
+
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
53
+ behavior during future release refreshes.
54
+ - Write for non-developer technical readers unless the project states
55
+ otherwise.
56
+ - Write from behavior outward: product-readable first, technically anchored
57
+ where details affect shipped behavior, operations, or support.
58
+ - Describe behavior, inputs, outputs, permissions, errors, business rules, and
59
+ operational expectations in domain language.
60
+ - Prefer Mermaid diagrams for flows, architecture, and relationships.
61
+ - Add release refreshes to `product-docs/releases/index.md`.
@@ -1,14 +1,14 @@
1
- # Docs Authoring Guide
1
+ # Product Docs Authoring Guide
2
2
 
3
3
  This subtree owns all guidance for authoring and refreshing the documentation
4
- under `docs/`. Humans and agents both read from here to know how
4
+ under `product-docs/`. Humans and agents both read from here to know how
5
5
  documentation 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 docs are versioned, refreshed, and
11
- structured.
10
+ - [`workflow.md`](workflow.md) explains how product docs are 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
- docs/_authoring/areas/<area-slug>.md
21
+ product-docs/_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 docs root under `docs/`
28
+ - the product docs root under `product-docs/`
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
@@ -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
- docs/_authoring/areas/<area-slug>.md
8
+ product-docs/_authoring/areas/<area-slug>.md
9
9
  ```
10
10
 
11
- Each guide should help a human or agent refresh docs from a release diff
11
+ Each guide should help a human or agent refresh product docs 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
- - Docs root: `docs/<Area>/`
7
+ - Product docs root: `product-docs/<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 | Docs page | Notes |
21
+ | Feature | Product docs page | Notes |
22
22
  | --- | --- | --- |
23
- | TBD | `docs/<Area>/features/<feature>.md` | TBD |
23
+ | TBD | `product-docs/<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 `docs/_authoring/terminology.md`.
60
+ List area-specific terms or link to `product-docs/_authoring/terminology.md`.
61
61
 
62
62
  ## Cross-Links
63
63
 
64
- List related areas and when docs should cross-link instead of duplicating
64
+ List related areas and when product docs 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
- Docs should translate code-level names into reader-facing domain
5
+ Product docs 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,13 +1,13 @@
1
- # Docs Workflow
1
+ # Product Docs Workflow
2
2
 
3
3
  This file defines how documentation 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 Docs Get Edited
7
+ ## When Product Docs Get Edited
8
8
 
9
9
  Doc refresh is an explicit, on-request activity, not a side effect of code
10
- work. Humans or agents touch `docs/` only when:
10
+ work. Humans or agents touch `product-docs/` 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.
@@ -18,8 +18,8 @@ work. Humans or agents touch `docs/` only when:
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 docs as part of a feature PR, bug fix, refactor, or dependency
22
- bump. Mid-stream commits are partial work; "feature complete" is only
21
+ Do not update product docs 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
25
  Agents: if you are working on a code change and notice a doc that looks
@@ -27,11 +27,11 @@ outdated, leave it alone. Flag the staleness in your summary or add it to the
27
27
  initiative's `release-doc-notes.md`, but do not edit the doc as part of the
28
28
  current change unless explicitly asked.
29
29
 
30
- ## Docs Modes
30
+ ## Product Docs Modes
31
31
 
32
- There are two valid ways to introduce or maintain `docs/`.
32
+ There are two valid ways to introduce or maintain `product-docs/`.
33
33
 
34
- ### Baseline Docs
34
+ ### Baseline Product Docs
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
@@ -42,54 +42,55 @@ When creating a baseline:
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
- `docs/_authoring/areas/` before writing product-facing pages.
45
+ `product-docs/_authoring/areas/` before writing product-facing 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 `docs/releases/index.md`. If
49
+ 5. Record the baseline reference in `product-docs/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 `docs/`. Capture open
52
+ 6. Leave uncertain or future behavior out of `product-docs/`. Capture open
53
53
  questions in `context/` or in the area authoring guide.
54
54
 
55
- Baseline docs are a snapshot of the system as adopted; they are not a promise
56
- that every undocumented behavior is unimportant.
55
+ Baseline product docs are a snapshot of the system as adopted; they are not a
56
+ promise that every undocumented behavior is unimportant.
57
57
 
58
- ### Release-Forward Docs
58
+ ### Release-Forward Product Docs
59
59
 
60
60
  Use this mode when the team chooses not to create a full baseline. In this
61
- mode, `docs/` may start sparse. Agents capture documentation impact
61
+ mode, `product-docs/` may start sparse. Agents capture documentation impact
62
62
  in initiative `release-doc-notes.md` during development, then update product
63
- docs only at explicit release-refresh time.
63
+ product docs only at explicit release-refresh time.
64
64
 
65
65
  This is valid when a full baseline would be too expensive. The documentation
66
66
  becomes complete incrementally around behavior the team changes and releases.
67
67
 
68
68
  ## Cadence And Versioning
69
69
 
70
- Docs live under `docs/`. After any explicit baseline pass, they are
71
- refreshed once per release, at git-tag time, after release acceptance. Release
72
- docs are anchored to the release tag; the docs at tag `release/v1_2_3`
73
- describe the behavior of that release.
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.
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
- `docs/releases/index.md`.
79
+ `product-docs/releases/index.md`.
80
80
 
81
81
  ## Audience
82
82
 
83
- Docs are written for non-developer technical readers by default: QA, product
84
- owners, solution owners, support engineers, customer engineers, or operators.
85
- Adjust this only when the project explicitly defines a different audience.
83
+ Product docs are 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 docs provide, link to the source
92
- rather than replicating the implementation in prose.
92
+ - For readers who need more depth than the product docs provide, 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
- Docs should be product-readable first and technically anchored
104
- second. They can feed release notes, but they are more durable than release notes:
105
- release notes summarize what changed, while `docs/` describes what
106
- the accepted system does as of a release or baseline.
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.
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
- docs/<Area>/
131
+ product-docs/<Area>/
131
132
  README.md
132
133
  features/
133
134
  <feature>.md
@@ -169,18 +170,18 @@ user-facing or operator-facing entry point. Cross-link from the other areas.
169
170
 
170
171
  ## Release-Time Doc Refresh
171
172
 
172
- When invoked to refresh docs for a release:
173
+ When invoked to refresh product docs 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 `docs/_authoring/areas/`.
177
+ 2. Read the matching area guide in `product-docs/_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 `docs/releases/index.md`.
184
+ 7. Append one row to `product-docs/releases/index.md`.
184
185
 
185
186
  ## Source Order
186
187
 
@@ -189,7 +190,7 @@ 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 `docs/_authoring/areas/`.
193
+ 3. Matching area guide under `product-docs/_authoring/areas/`.
193
194
  4. Existing product documentation.
194
195
  5. Source code, tests, config, CI/CD, infrastructure, and generated artifacts
195
196
  only as needed to verify shipped behavior.
@@ -1,9 +1,9 @@
1
- # Release Docs Index
1
+ # Product Docs 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
- Docs at a given tag describe the behavior of that release.
6
+ Product docs at a given tag describe the behavior of that release.
7
7
 
8
8
  | Tag | Date | Areas refreshed | Owner | Summary |
9
9
  | --- | --- | --- | --- | --- |
package/docs/.order DELETED
@@ -1,2 +0,0 @@
1
- Welcome
2
- releases
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`.