code-anchored-context 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. package/.agents/skills/README.md +1 -1
  2. package/.agents/skills/{development-initiative-context → code-anchored-context}/SKILL.md +38 -38
  3. package/AGENTS.md +15 -13
  4. package/README.md +14 -14
  5. package/bin/code-anchored-context.js +125 -43
  6. package/{Development → context}/AGENTS.md +13 -13
  7. package/{Development → context}/README.md +29 -29
  8. package/{Development → context}/_templates/backlog-item.md +2 -2
  9. package/{Development → context}/_templates/initiative/README.md +9 -5
  10. package/{Development → context}/_templates/initiative/backlog.md +2 -2
  11. package/{Development → context}/_templates/initiative/plan.md +2 -2
  12. package/{Development → context}/_templates/initiative/release-doc-notes.md +6 -6
  13. package/{Development → context}/_templates/planned-initiative/README.md +10 -6
  14. package/{Development → context}/_templates/planned-initiative/release-doc-notes.md +5 -5
  15. package/{Development → context}/_templates/program/README.md +1 -1
  16. package/{Development → context}/_templates/program/backlog.md +1 -1
  17. package/{Development → context}/_templates/program/releases/v0_1_0.md +1 -1
  18. package/{Development → context}/_templates/release-context/README.md +6 -6
  19. package/{Development → context}/_templates/release-context/backlog.md +1 -2
  20. package/{Development → context}/_templates/release-transition.md +7 -7
  21. package/{Development → context}/backlog/README.md +3 -3
  22. package/{Development → context}/code-anchored-context-structure.md +16 -15
  23. package/{Development → context}/code-anchored-context-why.md +8 -8
  24. package/{Development → context}/code-anchored-context.html +20 -20
  25. package/{Development → context}/current.md +3 -3
  26. package/{Development → context}/giving-ai-agents-context-around-code.md +32 -32
  27. package/{Development → context}/programs/README.md +2 -2
  28. package/{Development → context}/releases/v0_1_0/README.md +6 -6
  29. package/{Development → context}/releases/v0_1_0/backlog.md +1 -1
  30. package/{Development → context}/terminology.md +22 -22
  31. package/{Documentation → docs}/Welcome.md +11 -6
  32. package/{Documentation → docs}/_authoring/README.md +6 -5
  33. package/{Documentation → docs}/_authoring/areas/README.md +1 -1
  34. package/{Documentation → docs}/_authoring/areas/_template.md +19 -5
  35. package/{Documentation → docs}/_authoring/terminology.md +1 -1
  36. package/docs/_authoring/workflow.md +210 -0
  37. package/docs/_templates/area/README.md +58 -0
  38. package/docs/_templates/area/features/feature-template.md +71 -0
  39. package/{Documentation → docs}/releases/index.md +3 -1
  40. package/package.json +19 -18
  41. package/Documentation/_authoring/workflow.md +0 -123
  42. package/Documentation/_templates/area/README.md +0 -20
  43. package/Documentation/_templates/area/features/feature-template.md +0 -29
  44. /package/{Development → context}/_templates/initiative/architecture.md +0 -0
  45. /package/{Development → context}/_templates/initiative/brief.html +0 -0
  46. /package/{Development → context}/_templates/initiative/decisions/ADR-0000-template.md +0 -0
  47. /package/{Development → context}/_templates/initiative/delivery.md +0 -0
  48. /package/{Development → context}/_templates/initiative/infrastructure.md +0 -0
  49. /package/{Development → context}/_templates/initiative/interface.md +0 -0
  50. /package/{Development → context}/_templates/initiative/operations.md +0 -0
  51. /package/{Development → context}/_templates/initiative/spec.md +0 -0
  52. /package/{Development → context}/_templates/initiative/testing.md +0 -0
  53. /package/{Development → context}/_templates/planned-initiative/architecture.md +0 -0
  54. /package/{Development → context}/_templates/planned-initiative/backlog.md +0 -0
  55. /package/{Development → context}/_templates/planned-initiative/decisions/ADR-0000-template.md +0 -0
  56. /package/{Development → context}/_templates/planned-initiative/delivery.md +0 -0
  57. /package/{Development → context}/_templates/planned-initiative/infrastructure.md +0 -0
  58. /package/{Development → context}/_templates/planned-initiative/interface.md +0 -0
  59. /package/{Development → context}/_templates/planned-initiative/operations.md +0 -0
  60. /package/{Development → context}/_templates/planned-initiative/plan.md +0 -0
  61. /package/{Development → context}/_templates/planned-initiative/spec.md +0 -0
  62. /package/{Development → context}/_templates/planned-initiative/testing.md +0 -0
  63. /package/{Development → context}/_templates/program/context.md +0 -0
  64. /package/{Development → context}/_templates/program/decisions/ADR-0000-template.md +0 -0
  65. /package/{Development → context}/_templates/program/planned-initiatives/.gitkeep +0 -0
  66. /package/{Development → context}/_templates/program/roadmap.md +0 -0
  67. /package/{Development → context}/_templates/release-context/initiatives/.gitkeep +0 -0
  68. /package/{Development → context}/backlog/items/.gitkeep +0 -0
  69. /package/{Development → context}/releases/v0_1_0/initiatives/.gitkeep +0 -0
  70. /package/{Documentation → docs}/.order +0 -0
@@ -16,13 +16,13 @@ infrastructure conversations, and people's heads. The problem is that agents
16
16
  need this context in a structured, discoverable form.
17
17
 
18
18
  This is why I started separating **released product documentation** from
19
- **development context**.
19
+ **working context**.
20
20
 
21
21
  ```text
22
- Documentation/
22
+ docs/
23
23
  What shipped.
24
24
 
25
- Development/
25
+ context/
26
26
  What we are planning, building, deciding, testing, shipping, hosting,
27
27
  deferring, and learning.
28
28
  ```
@@ -31,7 +31,7 @@ Product documentation should stay stable and release-accurate. It should
31
31
  describe the behavior of a known release, not the current shape of an unfinished
32
32
  branch.
33
33
 
34
- Development context is different. It is allowed to evolve. It is where humans
34
+ Working context is different. It is allowed to evolve. It is where humans
35
35
  and agents work through ambiguity.
36
36
 
37
37
  Over time, I have started thinking about this as **Code-Anchored Context**.
@@ -53,7 +53,7 @@ One practical benefit is that the reasoning travels with the work.
53
53
  When context is materialized in the repository, it stops being tied to one
54
54
  chat transcript, IDE, agent, or session. A team can switch tools without
55
55
  losing the trail of why the system is shaped the way it is. The next human or
56
- agent can open the repo, read the development context, and continue from the
56
+ agent can open the repo, read the working context, and continue from the
57
57
  same accumulated understanding instead of reconstructing it from memory. That
58
58
  continuity keeps hours of planning from being lost and makes handoffs between
59
59
  models and team members materially better.
@@ -61,8 +61,8 @@ models and team members materially better.
61
61
  ```mermaid
62
62
  flowchart LR
63
63
  Code["Codebase<br/>What exists in the system"]
64
- Dev["Development/<br/>What is being planned, built, decided, tested, shipped, hosted, deferred, and learned"]
65
- Docs["Documentation/<br/>What shipped in a known release"]
64
+ Dev["context/<br/>What is being planned, built, decided, tested, shipped, hosted, deferred, and learned"]
65
+ Docs["docs/<br/>What shipped in a known release"]
66
66
  Agents["Agents and humans<br/>Need context before changing behavior"]
67
67
 
68
68
  Agents --> Code
@@ -74,8 +74,8 @@ flowchart LR
74
74
  ## The Navigation Problem
75
75
 
76
76
  In large repositories, agents and IDEs do not always open the workspace from
77
- the root. They may start in `src/`, `deploy/`, a specific application, or a
78
- nested project folder.
77
+ the root. They may start in product code, CI/CD config, infrastructure code,
78
+ generated artifacts, a specific application, or a nested project folder.
79
79
 
80
80
  If all guidance lives at the top, it may be missed. But if each area keeps its
81
81
  own plans, cross-project work becomes fragmented.
@@ -86,15 +86,15 @@ So the rule became:
86
86
 
87
87
  Local `AGENTS.md` files can point agents toward the right place. But plans,
88
88
  specs, ADRs, release context, testing strategy, delivery notes, and
89
- infrastructure context should live centrally under `Development/`.
89
+ infrastructure context should live centrally under `context/`.
90
90
 
91
91
  ```mermaid
92
92
  flowchart TD
93
93
  Root["Repository root"]
94
- AreaA["src/AGENTS.md<br/>local signpost"]
95
- AreaB["deploy/AGENTS.md<br/>local signpost"]
96
- AreaC["apps/*/AGENTS.md<br/>local signpost"]
97
- Dev["Development/<br/>central working context"]
94
+ AreaA["product area AGENTS.md<br/>local signpost"]
95
+ AreaB["delivery area AGENTS.md<br/>local signpost"]
96
+ AreaC["nested project AGENTS.md<br/>local signpost"]
97
+ Dev["context/<br/>central working context"]
98
98
  Initiative["Release initiative<br/>single delivery story"]
99
99
 
100
100
  Root --> Dev
@@ -107,7 +107,7 @@ flowchart TD
107
107
  ## The Core Model
108
108
 
109
109
  Code-Anchored Context uses explicit terminology, captured in
110
- `Development/terminology.md`. That matters because agents need stable
110
+ `context/terminology.md`. That matters because agents need stable
111
111
  vocabulary as much as humans do.
112
112
 
113
113
  The main containers are:
@@ -122,7 +122,7 @@ Planned initiative
122
122
  Release initiative
123
123
  Active or historical delivery work for a specific release.
124
124
 
125
- Development backlog item
125
+ Context backlog item
126
126
  Isolated work cut from scope but worth preserving.
127
127
 
128
128
  Program release slice
@@ -132,7 +132,7 @@ Program release slice
132
132
  This gives each kind of context a natural home.
133
133
 
134
134
  ```text
135
- Development/
135
+ context/
136
136
  terminology.md
137
137
  current.md
138
138
  programs/
@@ -168,7 +168,7 @@ flowchart TD
168
168
  Release initiatives are the main unit of active delivery.
169
169
 
170
170
  ```text
171
- Development/releases/v0_1_0/initiatives/<initiative>/
171
+ context/releases/v0_1_0/initiatives/<initiative>/
172
172
  README.md
173
173
  plan.md
174
174
  spec.md
@@ -276,7 +276,7 @@ stable knowledge a place to land.
276
276
  ## Testing, Delivery, And Infrastructure
277
277
 
278
278
  The model treats verification, delivery, and infrastructure as first-class
279
- development context.
279
+ working context.
280
280
 
281
281
  That matters because agents often need to answer questions beyond "what code
282
282
  should change?"
@@ -332,7 +332,7 @@ Some work is bigger than one release.
332
332
  A program holds durable context for multi-release work:
333
333
 
334
334
  ```text
335
- Development/programs/<program>/
335
+ context/programs/<program>/
336
336
  README.md
337
337
  context.md
338
338
  roadmap.md
@@ -350,7 +350,7 @@ future phase is clear enough to plan, but the target release is not current
350
350
  yet, it becomes a planned initiative:
351
351
 
352
352
  ```text
353
- Development/programs/<program>/planned-initiatives/<initiative>/
353
+ context/programs/<program>/planned-initiatives/<initiative>/
354
354
  ```
355
355
 
356
356
  A planned initiative can also preserve future testing, delivery, or
@@ -365,7 +365,7 @@ When the target release becomes current, the planned initiative is promoted
365
365
  into:
366
366
 
367
367
  ```text
368
- Development/releases/<version>/initiatives/<initiative>/
368
+ context/releases/<version>/initiatives/<initiative>/
369
369
  ```
370
370
 
371
371
  Promotion is explicit and traceable. The original planned initiative remains
@@ -386,7 +386,7 @@ flowchart LR
386
386
  History -.->|"links to promoted initiative"| Release
387
387
  ```
388
388
 
389
- ## Development Backlog
389
+ ## Context Backlog
390
390
 
391
391
  Not every deferred item deserves a program or planned initiative.
392
392
 
@@ -394,7 +394,7 @@ Sometimes work is cut from scope because of risk, timing, or focus, but it is
394
394
  still worth preserving. That belongs in:
395
395
 
396
396
  ```text
397
- Development/backlog/items/
397
+ context/backlog/items/
398
398
  <originating-initiative>--<item>.md
399
399
  ```
400
400
 
@@ -408,7 +408,7 @@ release initiative. It is not silently rewritten.
408
408
 
409
409
  Changing the current release is not just editing a pointer.
410
410
 
411
- `Development/current.md` identifies the active release, but moving from one
411
+ `context/current.md` identifies the active release, but moving from one
412
412
  release to another is a release transition. During that transition, agents
413
413
  should scan program planned initiatives, find items targeting the new release,
414
414
  promote them into the release folder, and update links both ways.
@@ -462,22 +462,22 @@ It helps agents and humans answer:
462
462
  The mental model is simple:
463
463
 
464
464
  ```text
465
- Documentation/
465
+ docs/
466
466
  Released truth.
467
467
 
468
- Development/releases/
468
+ context/releases/
469
469
  Release-scoped delivery truth.
470
470
 
471
- Development/programs/
471
+ context/programs/
472
472
  Multi-release truth.
473
473
 
474
- Development/programs/*/planned-initiatives/
474
+ context/programs/*/planned-initiatives/
475
475
  Future scoped program work.
476
476
 
477
- Development/backlog/
477
+ context/backlog/
478
478
  Deferred isolated work.
479
479
 
480
- Development/terminology.md
480
+ context/terminology.md
481
481
  Shared vocabulary.
482
482
 
483
483
  AGENTS.md
@@ -486,7 +486,7 @@ AGENTS.md
486
486
 
487
487
  Code tells an agent what exists.
488
488
 
489
- Development context tells it why it exists, where it is going, what has
489
+ Working context tells it why it exists, where it is going, what has
490
490
  already been decided, how it should be verified, how it should ship, what
491
491
  infrastructure it relies on, and what has intentionally been left for later.
492
492
 
@@ -10,7 +10,7 @@ Use a program when an effort has:
10
10
  - planned future work that should remain visible
11
11
  - context that would be lost if it lived only in one release initiative
12
12
 
13
- Create programs from `Development/_templates/program/`.
13
+ Create programs from `context/_templates/program/`.
14
14
 
15
15
  ## Planned Initiatives
16
16
 
@@ -19,7 +19,7 @@ to scope, split, or preserve implementation intent, but the target release is
19
19
  not current yet.
20
20
 
21
21
  When a planned initiative's target release becomes current, promote it into
22
- `Development/releases/<version>/initiatives/` and leave the planned initiative
22
+ `context/releases/<version>/initiatives/` and leave the planned initiative
23
23
  behind as historical planning context.
24
24
 
25
25
  ## Current Programs
@@ -1,6 +1,6 @@
1
- # v0.1.0 Development Context
1
+ # v0.1.0 Context
2
2
 
3
- This folder contains development context for the `v0_1_0` release.
3
+ This folder contains working context for the `v0_1_0` release.
4
4
 
5
5
  ## Navigation
6
6
 
@@ -14,20 +14,20 @@ Create an initiative when work is non-trivial, behavior-changing,
14
14
  cross-project, release-significant, or likely to need future product
15
15
  documentation.
16
16
 
17
- Use `Development/_templates/initiative/` as the starting point.
17
+ Use `context/_templates/initiative/` as the starting point.
18
18
 
19
19
  ## Carry-Forward Rule
20
20
 
21
21
  If an initiative is part of a larger phased effort, link it to a program
22
- under `Development/programs/`.
22
+ under `context/programs/`.
23
23
 
24
24
  If isolated work is cut from scope but should be kept for later, create a
25
- backlog item under `Development/backlog/items/` and link it back to the
25
+ backlog item under `context/backlog/items/` and link it back to the
26
26
  originating initiative.
27
27
 
28
28
  ## Planned Initiative Promotion
29
29
 
30
30
  When this release becomes current, promote matching planned initiatives from
31
- `Development/programs/*/planned-initiatives/` into this release's
31
+ `context/programs/*/planned-initiatives/` into this release's
32
32
  `initiatives/` folder. Leave the planned initiative in place as historical
33
33
  planning context and update its status to `Promoted`.
@@ -1,6 +1,6 @@
1
1
  # v0.1.0 Backlog
2
2
 
3
- This file tracks release-level development context that is not yet captured
3
+ This file tracks release-level working context that is not yet captured
4
4
  by an initiative, plus a short summary of initiative progress once
5
5
  initiatives exist.
6
6
 
@@ -1,29 +1,29 @@
1
- # Development Terminology
1
+ # Context Terminology
2
2
 
3
3
  This glossary defines the terms used by the Code-Anchored Context practice in
4
- `Development/`. Use these terms consistently in programs, initiatives,
4
+ `context/`. Use these terms consistently in programs, initiatives,
5
5
  backlog items, ADRs, agent summaries, and release-transition work.
6
6
 
7
7
  ## Core Folders
8
8
 
9
9
  | Term | Meaning |
10
10
  | --- | --- |
11
- | `Development/` | Working development context: plans, specs, ADRs, implementation notes, delivery-surface context, future scope, and release-documentation notes. |
12
- | `Documentation/` | Released product documentation. It describes shipped behavior for a release/tag and is not edited during normal development work. |
13
- | `Development/current.md` | Pointer to the current active release context. Updating this is a release transition. |
14
- | `Development/releases/<version>/` | Release-scoped development context for one version. |
15
- | `Development/programs/` | Durable multi-release development context. |
16
- | `Development/backlog/items/` | Deferred isolated work cut from initiatives but worth preserving. |
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. |
13
+ | `context/current.md` | Pointer to the current active release context. Updating this is a release transition. |
14
+ | `context/releases/<version>/` | Release-scoped working context for one version. |
15
+ | `context/programs/` | Durable multi-release working context. |
16
+ | `context/backlog/items/` | Deferred isolated work cut from initiatives but worth preserving. |
17
17
 
18
18
  ## Work Containers
19
19
 
20
20
  | Term | Meaning | Lives in |
21
21
  | --- | --- | --- |
22
- | Program | A cross-release parent effort with durable context, roadmap, phase history, and program-level decisions. | `Development/programs/<program-slug>/` |
23
- | Planned initiative | A scoped future delivery slice that belongs to a program but is not in the current release yet. | `Development/programs/<program-slug>/planned-initiatives/<initiative-slug>/` |
24
- | Release initiative | An active or historical delivery slice for a specific release. | `Development/releases/<version>/initiatives/<initiative-slug>/` |
25
- | Development backlog item | Isolated deferred work that was cut from an initiative and may be picked up later. | `Development/backlog/items/<originating-initiative>--<item>.md` |
26
- | Program release slice | A program-level summary of what a release is expected to do or did for the program. | `Development/programs/<program-slug>/releases/<version>.md` |
22
+ | Program | A cross-release parent effort with durable context, roadmap, phase history, and program-level decisions. | `context/programs/<program-slug>/` |
23
+ | Planned initiative | A scoped future delivery slice that belongs to a program but is not in the current release yet. | `context/programs/<program-slug>/planned-initiatives/<initiative-slug>/` |
24
+ | Release initiative | An active or historical delivery slice for a specific release. | `context/releases/<version>/initiatives/<initiative-slug>/` |
25
+ | Context backlog item | Isolated deferred work that was cut from an initiative and may be picked up later. | `context/backlog/items/<originating-initiative>--<item>.md` |
26
+ | Program release slice | A program-level summary of what a release is expected to do or did for the program. | `context/programs/<program-slug>/releases/<version>.md` |
27
27
 
28
28
  ## Choosing The Right Container
29
29
 
@@ -36,7 +36,7 @@ or needs a roadmap beyond one release.
36
36
  Use a planned initiative when future program work is clear enough to plan,
37
37
  specify, or split, but the target release is not current yet.
38
38
 
39
- Use a development backlog item when an isolated piece of work was cut from
39
+ Use a context backlog item when an isolated piece of work was cut from
40
40
  scope and should be preserved, but it does not need program-level context.
41
41
 
42
42
  ## Files
@@ -45,7 +45,7 @@ The structure follows delivery concerns, not technologies. Use concern names
45
45
  such as `testing.md`, `delivery.md`, and `infrastructure.md`; name specific
46
46
  tools inside those files only when the tools matter.
47
47
 
48
- Mermaid is the preferred diagram syntax for development context because it is
48
+ Mermaid is the preferred diagram syntax for working context because it is
49
49
  both readable Markdown for agents and renderable visual context for humans.
50
50
 
51
51
  | Term | Meaning |
@@ -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 `Documentation/`. |
63
+ | `release-doc-notes.md` | Notes for future product documentation refresh work. This is the bridge to `docs/`. |
64
64
  | ADR | Architecture Decision Record. Use for durable decisions and tradeoffs. |
65
65
  | `brief.html` | Optional human-friendly presentation layer. |
66
66
 
@@ -88,15 +88,15 @@ Planned initiatives are promoted when their target release becomes current or
88
88
  when release planning explicitly begins:
89
89
 
90
90
  ```text
91
- Development/programs/<program>/planned-initiatives/<initiative>/
92
- -> Development/releases/<version>/initiatives/<initiative>/
91
+ context/programs/<program>/planned-initiatives/<initiative>/
92
+ -> context/releases/<version>/initiatives/<initiative>/
93
93
  ```
94
94
 
95
95
  Backlog items are promoted when someone decides to pick them up:
96
96
 
97
97
  ```text
98
- Development/backlog/items/<originating-initiative>--<item>.md
99
- -> Development/releases/<version>/initiatives/<initiative>/
98
+ context/backlog/items/<originating-initiative>--<item>.md
99
+ -> context/releases/<version>/initiatives/<initiative>/
100
100
  ```
101
101
 
102
102
  Promotion does not silently move or delete the original context. Leave the
@@ -105,7 +105,7 @@ original planned initiative or backlog item in place, update its status to
105
105
 
106
106
  ## Release Transition
107
107
 
108
- A release transition is the act of changing `Development/current.md` to a new
108
+ A release transition is the act of changing `context/current.md` to a new
109
109
  release. This is not just a line edit.
110
110
 
111
111
  During a release transition, agents should:
@@ -117,4 +117,4 @@ During a release transition, agents should:
117
117
  - update links both ways
118
118
  - leave planned initiatives as historical planning context
119
119
 
120
- Use `Development/_templates/release-transition.md` as the checklist.
120
+ Use `context/_templates/release-transition.md` as the checklist.
@@ -1,15 +1,15 @@
1
- # PROJECT_NAME Documentation
1
+ # PROJECT_NAME Docs
2
2
 
3
3
  Welcome to the release-anchored documentation for PROJECT_NAME.
4
4
 
5
5
  This folder describes shipped behavior for a known release or tag. It is not
6
6
  the place for in-progress feature planning, implementation notes, or draft
7
- architecture decisions. Put that work in `Development/`.
7
+ architecture decisions. Put that work in `context/`.
8
8
 
9
- ## How This Documentation Is Organized
9
+ ## How These Docs Are Organized
10
10
 
11
11
  ```text
12
- Documentation/
12
+ docs/
13
13
  .order
14
14
  Welcome.md
15
15
  releases/
@@ -30,14 +30,19 @@ Every documented area should have:
30
30
 
31
31
  - a high-level `README.md` that explains the area's purpose and architecture
32
32
  - one page per feature under `features/`
33
- - an authoring guide under `Documentation/_authoring/areas/`
33
+ - an authoring guide under `docs/_authoring/areas/`
34
34
 
35
35
  ## Contributing
36
36
 
37
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.
38
41
  - Write for non-developer technical readers unless the project states
39
42
  otherwise.
43
+ - Write from behavior outward: product-readable first, technically anchored
44
+ where details affect shipped behavior, operations, or support.
40
45
  - Describe behavior, inputs, outputs, permissions, errors, business rules, and
41
46
  operational expectations in domain language.
42
47
  - Prefer Mermaid diagrams for flows, architecture, and relationships.
43
- - Add release refreshes to `Documentation/releases/index.md`.
48
+ - Add release refreshes to `docs/releases/index.md`.
@@ -1,7 +1,7 @@
1
- # Documentation Authoring Guide
1
+ # Docs Authoring Guide
2
2
 
3
3
  This subtree owns all guidance for authoring and refreshing the documentation
4
- under `Documentation/`. Humans and agents both read from here to know how
4
+ under `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
 
@@ -18,13 +18,14 @@ and which domain terminology to use.
18
18
  Create one authoring guide per documented area:
19
19
 
20
20
  ```text
21
- Documentation/_authoring/areas/<area-slug>.md
21
+ docs/_authoring/areas/<area-slug>.md
22
22
  ```
23
23
 
24
24
  Each area guide should identify:
25
25
 
26
- - the code folder or folders that own the behavior
27
- - the documentation root under `Documentation/`
26
+ - the source locations that own the behavior, such as product code,
27
+ interfaces, tests, CI/CD, generated artifacts, infrastructure, or config
28
+ - the docs root under `docs/`
28
29
  - feature pages that should exist
29
30
  - behavior that matters at release time
30
31
  - changes to ignore, such as pure refactors or test-only edits
@@ -5,7 +5,7 @@ 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
- Documentation/_authoring/areas/<area-slug>.md
8
+ docs/_authoring/areas/<area-slug>.md
9
9
  ```
10
10
 
11
11
  Each guide should help a human or agent refresh docs from a release diff
@@ -2,17 +2,25 @@
2
2
 
3
3
  ## Scope
4
4
 
5
- - Code root: `path/to/code`
6
- - Documentation root: `Documentation/<Area>/`
5
+ - Source orientation: `path/to/runtime-or-product-code`, `path/to/contracts`,
6
+ `path/to/tests`, `path/to/ci-or-delivery`, `path/to/infra-or-config`
7
+ - Docs root: `docs/<Area>/`
7
8
  - Owner or reviewer: TBD
8
9
 
9
10
  Describe what this area owns and what it intentionally does not own.
10
11
 
12
+ ## Audience And Depth
13
+
14
+ State any area-specific audience or depth rules. By default, write for
15
+ Product Owners, QA, support, operators, customer engineers, and technical
16
+ readers who need behavior, rules, data effects, permissions, errors, and
17
+ operational expectations without private implementation detail.
18
+
11
19
  ## Feature Inventory
12
20
 
13
- | Feature | Documentation page | Notes |
21
+ | Feature | Docs page | Notes |
14
22
  | --- | --- | --- |
15
- | TBD | `Documentation/<Area>/features/<feature>.md` | TBD |
23
+ | TBD | `docs/<Area>/features/<feature>.md` | TBD |
16
24
 
17
25
  ## What Matters At Release Time
18
26
 
@@ -41,9 +49,15 @@ Ignore changes that do not alter released behavior:
41
49
  List the files, folders, entry points, or search terms that help an agent map a
42
50
  release diff to documentation pages.
43
51
 
52
+ ## Baseline Discovery Notes
53
+
54
+ Use this section when creating first-pass documentation for an existing
55
+ project. List stable workflows, important entry points, source references,
56
+ known gaps, and questions that should not yet appear in product-facing docs.
57
+
44
58
  ## Terminology
45
59
 
46
- List area-specific terms or link to `Documentation/_authoring/terminology.md`.
60
+ List area-specific terms or link to `docs/_authoring/terminology.md`.
47
61
 
48
62
  ## Cross-Links
49
63
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  Use this file to define the domain language that documentation should use.
4
4
 
5
- Documentation should translate code-level names into reader-facing domain
5
+ 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