code-anchored-context 0.1.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.
- package/.agents/skills/README.md +13 -0
- package/.agents/skills/development-initiative-context/SKILL.md +209 -0
- package/AGENTS.md +52 -0
- package/Development/AGENTS.md +46 -0
- package/Development/README.md +259 -0
- package/Development/_templates/backlog-item.md +40 -0
- package/Development/_templates/initiative/README.md +59 -0
- package/Development/_templates/initiative/architecture.md +44 -0
- package/Development/_templates/initiative/backlog.md +28 -0
- package/Development/_templates/initiative/brief.html +56 -0
- package/Development/_templates/initiative/decisions/ADR-0000-template.md +34 -0
- package/Development/_templates/initiative/delivery.md +38 -0
- package/Development/_templates/initiative/infrastructure.md +33 -0
- package/Development/_templates/initiative/interface.md +41 -0
- package/Development/_templates/initiative/operations.md +40 -0
- package/Development/_templates/initiative/plan.md +57 -0
- package/Development/_templates/initiative/release-doc-notes.md +35 -0
- package/Development/_templates/initiative/spec.md +35 -0
- package/Development/_templates/initiative/testing.md +41 -0
- package/Development/_templates/planned-initiative/README.md +55 -0
- package/Development/_templates/planned-initiative/architecture.md +44 -0
- package/Development/_templates/planned-initiative/backlog.md +27 -0
- package/Development/_templates/planned-initiative/decisions/ADR-0000-template.md +35 -0
- package/Development/_templates/planned-initiative/delivery.md +33 -0
- package/Development/_templates/planned-initiative/infrastructure.md +30 -0
- package/Development/_templates/planned-initiative/interface.md +41 -0
- package/Development/_templates/planned-initiative/operations.md +41 -0
- package/Development/_templates/planned-initiative/plan.md +40 -0
- package/Development/_templates/planned-initiative/release-doc-notes.md +28 -0
- package/Development/_templates/planned-initiative/spec.md +37 -0
- package/Development/_templates/planned-initiative/testing.md +30 -0
- package/Development/_templates/program/README.md +63 -0
- package/Development/_templates/program/backlog.md +26 -0
- package/Development/_templates/program/context.md +25 -0
- package/Development/_templates/program/decisions/ADR-0000-template.md +34 -0
- package/Development/_templates/program/planned-initiatives/.gitkeep +1 -0
- package/Development/_templates/program/releases/v0_1_0.md +32 -0
- package/Development/_templates/program/roadmap.md +27 -0
- package/Development/_templates/release-context/README.md +33 -0
- package/Development/_templates/release-context/backlog.md +14 -0
- package/Development/_templates/release-context/initiatives/.gitkeep +1 -0
- package/Development/_templates/release-transition.md +39 -0
- package/Development/backlog/README.md +17 -0
- package/Development/backlog/items/.gitkeep +0 -0
- package/Development/code-anchored-context-structure.md +132 -0
- package/Development/code-anchored-context-why.md +80 -0
- package/Development/code-anchored-context.html +830 -0
- package/Development/current.md +32 -0
- package/Development/giving-ai-agents-context-around-code.md +496 -0
- package/Development/programs/README.md +27 -0
- package/Development/releases/v0_1_0/README.md +33 -0
- package/Development/releases/v0_1_0/backlog.md +15 -0
- package/Development/releases/v0_1_0/initiatives/.gitkeep +1 -0
- package/Development/terminology.md +120 -0
- package/Documentation/.order +2 -0
- package/Documentation/Welcome.md +43 -0
- package/Documentation/_authoring/README.md +45 -0
- package/Documentation/_authoring/areas/README.md +16 -0
- package/Documentation/_authoring/areas/_template.md +51 -0
- package/Documentation/_authoring/terminology.md +40 -0
- package/Documentation/_authoring/workflow.md +123 -0
- package/Documentation/_templates/area/README.md +20 -0
- package/Documentation/_templates/area/features/feature-template.md +29 -0
- package/Documentation/releases/index.md +18 -0
- package/LICENSE +21 -0
- package/README.md +85 -0
- package/bin/code-anchored-context.js +558 -0
- package/package.json +45 -0
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Project Skills
|
|
2
|
+
|
|
3
|
+
This directory contains repository-wide skills for agents working in this
|
|
4
|
+
project.
|
|
5
|
+
|
|
6
|
+
- Each skill is a folder containing a `SKILL.md` file.
|
|
7
|
+
- Skills are loaded on demand for repeated workflows and project conventions.
|
|
8
|
+
|
|
9
|
+
## Repository-Wide Skills
|
|
10
|
+
|
|
11
|
+
- `development-initiative-context` - use central `Development/` initiatives
|
|
12
|
+
for planning, implementation context, programs, planned initiatives, ADRs,
|
|
13
|
+
backlog, and release-documentation notes.
|
|
@@ -0,0 +1,209 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: development-initiative-context
|
|
3
|
+
description: Use central repository Development context for planning and implementation. Use when starting, changing, reviewing, or documenting behavior-changing work; when checking or updating Development/current.md, Development/releases/*/initiatives/*, Development/programs/*, Development/programs/*/planned-initiatives/*, Development/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 Documentation/ should be left untouched.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Development Initiative Context
|
|
7
|
+
|
|
8
|
+
## Overview
|
|
9
|
+
|
|
10
|
+
Use this skill to connect code work back to the central development context
|
|
11
|
+
under `Development/`. The goal is to keep initiative knowledge centralized,
|
|
12
|
+
preserve durable multi-release context in programs, and keep deferred
|
|
13
|
+
isolated work discoverable in the development backlog. Scoped future program
|
|
14
|
+
work belongs in planned initiatives until the target release becomes current.
|
|
15
|
+
Development context should also cover delivery concerns such as testing,
|
|
16
|
+
delivery pipelines, and infrastructure when they affect how the work is
|
|
17
|
+
verified, shipped, deployed, or hosted.
|
|
18
|
+
|
|
19
|
+
## Workflow
|
|
20
|
+
|
|
21
|
+
### 1) Read The Local Rules
|
|
22
|
+
|
|
23
|
+
Read the nearest `AGENTS.md` files for the workspace and area being changed.
|
|
24
|
+
Respect area-specific engineering rules first.
|
|
25
|
+
|
|
26
|
+
### 2) Find The Current Development Context
|
|
27
|
+
|
|
28
|
+
Open `Development/current.md` from the repository root. It points to the
|
|
29
|
+
active release folder.
|
|
30
|
+
|
|
31
|
+
Use `Development/terminology.md` as the canonical vocabulary for programs,
|
|
32
|
+
planned initiatives, release initiatives, backlog items, statuses, and
|
|
33
|
+
promotion.
|
|
34
|
+
|
|
35
|
+
If the workspace starts inside a subfolder, navigate upward to the repository
|
|
36
|
+
root when the environment allows it. If `Development/` is not available in
|
|
37
|
+
the workspace, mention that limitation in the task summary.
|
|
38
|
+
|
|
39
|
+
### 3) Match Existing Context
|
|
40
|
+
|
|
41
|
+
Search these places for matching context:
|
|
42
|
+
|
|
43
|
+
- active release initiatives under `Development/releases/<current-release>/initiatives/`
|
|
44
|
+
- durable programs under `Development/programs/`
|
|
45
|
+
- scoped future program work under `Development/programs/<program>/planned-initiatives/`
|
|
46
|
+
- deferred items under `Development/backlog/items/`
|
|
47
|
+
|
|
48
|
+
Search for:
|
|
49
|
+
|
|
50
|
+
- the feature or bug name
|
|
51
|
+
- affected area names, such as frontend, API, shared library, deploy, or
|
|
52
|
+
automation
|
|
53
|
+
- related domain terms, APIs, jobs, entities, routes, config names, or tickets
|
|
54
|
+
|
|
55
|
+
Use an existing initiative when the work belongs to it, even if the code
|
|
56
|
+
change is local to one project. If the initiative is part of a multi-release
|
|
57
|
+
effort, link it to the relevant program.
|
|
58
|
+
|
|
59
|
+
### 4) Create An Initiative When Needed
|
|
60
|
+
|
|
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.
|
|
64
|
+
|
|
65
|
+
Use `Development/_templates/initiative/` as the source. Copy it to:
|
|
66
|
+
|
|
67
|
+
```text
|
|
68
|
+
Development/releases/<current-release>/initiatives/<initiative-slug>/
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Update the copied `README.md` first so future agents can quickly understand
|
|
72
|
+
status, scope, touched areas, open questions, and implementation state. Use
|
|
73
|
+
`plan.md` for live alignment with the human before the stable initiative
|
|
74
|
+
files settle.
|
|
75
|
+
|
|
76
|
+
For tiny localized fixes that do not belong to an initiative, do not invent
|
|
77
|
+
process. Summarize that no initiative was needed.
|
|
78
|
+
|
|
79
|
+
### 5) Capture Planned Future Initiatives
|
|
80
|
+
|
|
81
|
+
If future program work is known well enough to scope, split, or preserve
|
|
82
|
+
implementation intent, create a planned initiative under the parent program:
|
|
83
|
+
|
|
84
|
+
```text
|
|
85
|
+
Development/programs/<program-slug>/planned-initiatives/<initiative-slug>/
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
Use `Development/_templates/planned-initiative/` as the source.
|
|
89
|
+
|
|
90
|
+
Use a planned initiative when:
|
|
91
|
+
|
|
92
|
+
- the work belongs to a program
|
|
93
|
+
- the target release is not current yet
|
|
94
|
+
- the future phase is clear enough for a plan, spec, or backlog
|
|
95
|
+
- capturing it only in `roadmap.md` or `releases/<version>.md` would lose
|
|
96
|
+
useful scope or implementation context
|
|
97
|
+
|
|
98
|
+
Do not create a future `Development/releases/<version>/` initiative just to
|
|
99
|
+
hold planned work unless that release is being made current or release
|
|
100
|
+
planning has explicitly begun.
|
|
101
|
+
|
|
102
|
+
### 6) Carry Context Forward When Scope Changes
|
|
103
|
+
|
|
104
|
+
Use the right outliving path when initiative context needs to survive beyond
|
|
105
|
+
the current release:
|
|
106
|
+
|
|
107
|
+
- `Development/programs/<program-slug>/`: multi-release efforts, phases,
|
|
108
|
+
roadmaps, durable decisions, and release-slice history
|
|
109
|
+
- `Development/programs/<program-slug>/planned-initiatives/<initiative-slug>/`:
|
|
110
|
+
scoped future delivery slices that are not in the current release yet
|
|
111
|
+
- `Development/backlog/items/<originating-initiative-slug>--<item-slug>.md`:
|
|
112
|
+
isolated deferred work cut from an initiative
|
|
113
|
+
|
|
114
|
+
When creating a backlog item, use `Development/_templates/backlog-item.md`
|
|
115
|
+
and link to the originating initiative and release.
|
|
116
|
+
|
|
117
|
+
When picking up a backlog item later, keep the item as a historical record.
|
|
118
|
+
Mark it as promoted and link to the new release initiative.
|
|
119
|
+
|
|
120
|
+
### 7) Transition The Current Release
|
|
121
|
+
|
|
122
|
+
When asked to set a new current release, treat it as a release transition,
|
|
123
|
+
not just a `current.md` edit.
|
|
124
|
+
|
|
125
|
+
Use `Development/_templates/release-transition.md` as the checklist:
|
|
126
|
+
|
|
127
|
+
1. Update `Development/current.md`.
|
|
128
|
+
2. Create `Development/releases/<target-release>/` from
|
|
129
|
+
`Development/_templates/release-context/` if missing.
|
|
130
|
+
3. Scan `Development/programs/*/planned-initiatives/*/README.md` for
|
|
131
|
+
`Target release: <target-release>`.
|
|
132
|
+
4. Promote each match into:
|
|
133
|
+
|
|
134
|
+
```text
|
|
135
|
+
Development/releases/<target-release>/initiatives/<initiative-slug>/
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
5. Update the planned initiative metadata to `Status: Promoted`, with
|
|
139
|
+
`Promoted to:` and `Promoted on:`.
|
|
140
|
+
6. Link both directions between the program/planned initiative and the
|
|
141
|
+
promoted release initiative.
|
|
142
|
+
|
|
143
|
+
Planned initiatives are promoted, not moved silently. Leave the planned
|
|
144
|
+
initiative in place as historical planning context.
|
|
145
|
+
|
|
146
|
+
### 8) Update The Right Files
|
|
147
|
+
|
|
148
|
+
Use these files as the standard map:
|
|
149
|
+
|
|
150
|
+
- `README.md`: entry point, status, touched areas, links, open questions
|
|
151
|
+
- `plan.md`: working alignment space for rough notes, questions, options,
|
|
152
|
+
and notes to promote
|
|
153
|
+
- `spec.md`: what the system should do
|
|
154
|
+
- `interface.md`: how humans, clients, APIs, config, or tools interact with it
|
|
155
|
+
- `architecture.md`: internal shape, boundaries, flows, contracts, data
|
|
156
|
+
Use Mermaid for diagrams when a flow or relationship is clearer visually;
|
|
157
|
+
it remains readable Markdown for agents and renders for humans.
|
|
158
|
+
- `testing.md`: verification strategy, coverage, test data, release gates
|
|
159
|
+
- `delivery.md`: CI/CD, build behavior, deployment flow, environment
|
|
160
|
+
promotion, release toggles, delivery automation
|
|
161
|
+
- `infrastructure.md`: environment shape, IaC, resources, networking,
|
|
162
|
+
identity, storage, secrets, environment dependencies
|
|
163
|
+
- `operations.md`: optional actionable runtime/support context such as
|
|
164
|
+
observability, failure modes, rollback, repair, and support tooling
|
|
165
|
+
- `backlog.md`: work slices and implementation progress
|
|
166
|
+
- `decisions/ADR-*.md`: meaningful choices and their consequences
|
|
167
|
+
- `release-doc-notes.md`: product-documentation impact to review at release
|
|
168
|
+
|
|
169
|
+
Not every initiative needs every file. Mark a file as not applicable or omit
|
|
170
|
+
it after copying the template when it genuinely does not apply.
|
|
171
|
+
|
|
172
|
+
`plan.md` is allowed to be messy, but it must not become the only place where
|
|
173
|
+
settled truth lives. Promote stable conclusions into `spec.md`,
|
|
174
|
+
`interface.md`, `architecture.md`, `testing.md`, `delivery.md`,
|
|
175
|
+
`infrastructure.md`, `operations.md` when actionable, `backlog.md`, ADRs, or
|
|
176
|
+
`release-doc-notes.md` as appropriate.
|
|
177
|
+
|
|
178
|
+
### 9) Preserve The Documentation Boundary
|
|
179
|
+
|
|
180
|
+
Do not edit `Documentation/` as part of normal feature work, bug fixes,
|
|
181
|
+
refactors, or planning. Instead, update the initiative's
|
|
182
|
+
`release-doc-notes.md`.
|
|
183
|
+
|
|
184
|
+
Only update `Documentation/` when a human explicitly asks for release
|
|
185
|
+
documentation work, a specific page update, or a demonstrable documentation
|
|
186
|
+
fix.
|
|
187
|
+
|
|
188
|
+
## Knowledge Ownership
|
|
189
|
+
|
|
190
|
+
Denormalize navigation, not knowledge.
|
|
191
|
+
|
|
192
|
+
Local `AGENTS.md` files may point to `Development/`, but initiative specs,
|
|
193
|
+
plans, ADRs, and release-doc notes should live in the central initiative
|
|
194
|
+
folder. Do not create area-local copies of initiative documents.
|
|
195
|
+
|
|
196
|
+
## Completion Check
|
|
197
|
+
|
|
198
|
+
Before finishing behavior-changing work:
|
|
199
|
+
|
|
200
|
+
- The matching initiative was read or a reason was given for why none exists.
|
|
201
|
+
- Matching programs or development backlog items were checked when the work
|
|
202
|
+
appears phased, deferred, or multi-release.
|
|
203
|
+
- Planned initiatives were checked or created when future program scope is
|
|
204
|
+
already clear but outside the current release.
|
|
205
|
+
- Any changed behavior, interface, architecture, testing, delivery,
|
|
206
|
+
infrastructure, actionable operations, or backlog state was reflected in the
|
|
207
|
+
initiative when appropriate.
|
|
208
|
+
- Future product-documentation impact was captured in `release-doc-notes.md`.
|
|
209
|
+
- `Documentation/` was left untouched unless explicitly requested.
|
package/AGENTS.md
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# Agent Guidance - PROJECT_NAME
|
|
2
|
+
|
|
3
|
+
This file applies to the whole repo. Area-specific `AGENTS.md` files in
|
|
4
|
+
subfolders layer on top of it. Read those too when working in a given area.
|
|
5
|
+
|
|
6
|
+
## Development Context
|
|
7
|
+
|
|
8
|
+
In-progress specs, plans, ADRs, backlog, implementation context, and
|
|
9
|
+
release-documentation notes live under [`Development/`](Development/).
|
|
10
|
+
Start with [`Development/current.md`](Development/current.md).
|
|
11
|
+
|
|
12
|
+
For behavior-changing work, use the repo-wide skill at
|
|
13
|
+
[`.agents/skills/development-initiative-context/SKILL.md`](.agents/skills/development-initiative-context/SKILL.md).
|
|
14
|
+
Keep initiative knowledge centralized under `Development/`; area
|
|
15
|
+
`AGENTS.md` files should point there rather than copying active plans.
|
|
16
|
+
|
|
17
|
+
## Documentation Authoring
|
|
18
|
+
|
|
19
|
+
### When To Edit `Documentation/`
|
|
20
|
+
|
|
21
|
+
Do not edit `Documentation/` as a side effect of feature work, bug fixes,
|
|
22
|
+
refactors, or other code changes. Docs in this model are release-anchored:
|
|
23
|
+
they describe the behavior of a specific release tag, not the partial state of
|
|
24
|
+
a working branch.
|
|
25
|
+
|
|
26
|
+
Touch `Documentation/` only when:
|
|
27
|
+
|
|
28
|
+
- A human explicitly asks you to refresh the docs for a release, typically
|
|
29
|
+
after a release tag is cut and QA has signed off.
|
|
30
|
+
- A human explicitly asks you to update a specific page.
|
|
31
|
+
- A human asks you to fix a demonstrable error in an existing page, such as a
|
|
32
|
+
broken link or factual inaccuracy.
|
|
33
|
+
|
|
34
|
+
If you are unsure whether the request is one of these, ask before editing.
|
|
35
|
+
|
|
36
|
+
If a project has documentation that intentionally follows a different cadence,
|
|
37
|
+
document that exception in the area's README and in
|
|
38
|
+
`Documentation/_authoring/areas/`.
|
|
39
|
+
|
|
40
|
+
### Where The Authoring Guidance Lives
|
|
41
|
+
|
|
42
|
+
All documentation workflow, per-area authoring guides, and domain terminology
|
|
43
|
+
live under [`Documentation/_authoring/`](Documentation/_authoring/). Start
|
|
44
|
+
with [`Documentation/_authoring/README.md`](Documentation/_authoring/README.md).
|
|
45
|
+
|
|
46
|
+
If you are refreshing docs, the per-area guides in
|
|
47
|
+
[`Documentation/_authoring/areas/`](Documentation/_authoring/areas/) tell you
|
|
48
|
+
what matters and what to ignore for each area.
|
|
49
|
+
|
|
50
|
+
`AGENTS.md` files stay lean. They are for coding conventions and agent
|
|
51
|
+
restrictions, not detailed documentation guidance. If you have doc rules to
|
|
52
|
+
add, add them under `_authoring/`.
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Agent Guidance - Development
|
|
2
|
+
|
|
3
|
+
Scope: everything under `/Development`.
|
|
4
|
+
|
|
5
|
+
## Purpose
|
|
6
|
+
|
|
7
|
+
This folder is the canonical home for in-progress development context: specs,
|
|
8
|
+
interface notes, architecture notes, actionable operations notes, ADRs,
|
|
9
|
+
backlogs, implementation plans, and release-documentation notes.
|
|
10
|
+
|
|
11
|
+
Testing, delivery, and infrastructure notes belong here when they affect how
|
|
12
|
+
work is verified, shipped, deployed, or hosted. Operational notes belong here
|
|
13
|
+
only when they are actionable runtime, support, observability, rollback, or
|
|
14
|
+
repair context.
|
|
15
|
+
|
|
16
|
+
`Development/` describes what is being planned, built, debated, or validated.
|
|
17
|
+
`Documentation/` describes what has shipped for a release.
|
|
18
|
+
|
|
19
|
+
## Editing Rules
|
|
20
|
+
|
|
21
|
+
- Use `Development/terminology.md` as the canonical vocabulary for programs,
|
|
22
|
+
planned initiatives, release initiatives, backlog items, and promotion.
|
|
23
|
+
- Keep initiative knowledge centralized here. Area `AGENTS.md` files may point
|
|
24
|
+
here, but they should not duplicate initiative content.
|
|
25
|
+
- Do not move in-progress plans into `Documentation/`.
|
|
26
|
+
- Use `release-doc-notes.md` inside an initiative to capture what may need to
|
|
27
|
+
become product documentation later.
|
|
28
|
+
- Create initiatives from `Development/_templates/initiative/`.
|
|
29
|
+
- Create durable multi-release programs from `Development/_templates/program/`.
|
|
30
|
+
- Create scoped future program work from
|
|
31
|
+
`Development/_templates/planned-initiative/` under a program's
|
|
32
|
+
`planned-initiatives/` folder.
|
|
33
|
+
- Create deferred isolated backlog items from
|
|
34
|
+
`Development/_templates/backlog-item.md`.
|
|
35
|
+
- Keep release initiative history in the release folder. Use `programs/` for
|
|
36
|
+
multi-release context, `planned-initiatives/` for scoped future program work,
|
|
37
|
+
and `backlog/items/` for isolated deferred work.
|
|
38
|
+
- Treat changes to `Development/current.md` as release transitions. Use
|
|
39
|
+
`Development/_templates/release-transition.md` and promote matching planned
|
|
40
|
+
initiatives for the new current release.
|
|
41
|
+
- When a backlog item is picked up later, mark it as promoted and link to the
|
|
42
|
+
new release initiative instead of rewriting the item into an active plan.
|
|
43
|
+
- Keep templates practical. If a file does not apply to an initiative, mark it
|
|
44
|
+
as not applicable or omit it after copying the template.
|
|
45
|
+
- Use `operations.md` only for actionable runtime, support, observability,
|
|
46
|
+
rollback, or repair context.
|
|
@@ -0,0 +1,259 @@
|
|
|
1
|
+
# Development
|
|
2
|
+
|
|
3
|
+
This folder is the working memory for active and historical development
|
|
4
|
+
context in this repository.
|
|
5
|
+
|
|
6
|
+
Use it for specs, interface notes, architecture notes, testing notes, delivery
|
|
7
|
+
notes, infrastructure notes, actionable operations notes, ADRs, backlog items,
|
|
8
|
+
implementation plans, and release-documentation notes. Do not use
|
|
9
|
+
`Documentation/` for in-progress development planning.
|
|
10
|
+
|
|
11
|
+
## Start Here
|
|
12
|
+
|
|
13
|
+
- `code-anchored-context.html` is a human-friendly visual brief for this
|
|
14
|
+
opinionated context practice.
|
|
15
|
+
- `giving-ai-agents-context-around-code.md` is an article-form explanation of
|
|
16
|
+
Code-Anchored Context for human-agent collaboration.
|
|
17
|
+
- `terminology.md` defines the shared vocabulary.
|
|
18
|
+
- `current.md` points to the active release context.
|
|
19
|
+
- `programs/` contains durable multi-release development context.
|
|
20
|
+
- `backlog/` contains deferred isolated work cut from initiatives.
|
|
21
|
+
- `releases/` contains release-scoped development context.
|
|
22
|
+
- `_templates/initiative/` contains the standard initiative shape.
|
|
23
|
+
- `_templates/planned-initiative/` contains the standard future initiative
|
|
24
|
+
shape for scoped program work outside the current release.
|
|
25
|
+
- `_templates/release-context/` contains the standard release folder shell.
|
|
26
|
+
|
|
27
|
+
## Relationship To Documentation
|
|
28
|
+
|
|
29
|
+
`Development/` and `Documentation/` serve different jobs:
|
|
30
|
+
|
|
31
|
+
| Folder | Meaning | Updated when |
|
|
32
|
+
| --- | --- | --- |
|
|
33
|
+
| `Development/` | What we are planning, building, deciding, or validating. | During normal development. |
|
|
34
|
+
| `Documentation/` | What the product does as of a release or tag. | Only during explicit documentation refresh work. |
|
|
35
|
+
|
|
36
|
+
Development notes can feed release documentation, but they are not product
|
|
37
|
+
documentation. Capture that bridge in each initiative's
|
|
38
|
+
`release-doc-notes.md`.
|
|
39
|
+
|
|
40
|
+
## Core Model
|
|
41
|
+
|
|
42
|
+
The vocabulary for this context model is defined in `terminology.md`.
|
|
43
|
+
|
|
44
|
+
Release initiatives are the durable unit of release-scoped development
|
|
45
|
+
context. An initiative may touch one project, many projects, IaC, automation,
|
|
46
|
+
tests, or all of them. Keep the release story in one initiative folder even
|
|
47
|
+
when the code changes span several areas.
|
|
48
|
+
|
|
49
|
+
Some context needs to outlive a single release initiative:
|
|
50
|
+
|
|
51
|
+
| Place | Use for |
|
|
52
|
+
| --- | --- |
|
|
53
|
+
| `Development/programs/` | Long-lived multi-release efforts, phase history, roadmaps, and durable decisions. |
|
|
54
|
+
| `Development/programs/<program>/planned-initiatives/` | Scoped future delivery slices that belong to a program but are not in the current release yet. |
|
|
55
|
+
| `Development/backlog/items/` | Deferred isolated work cut from an initiative but worth preserving. |
|
|
56
|
+
| `Development/releases/<version>/initiatives/` | Release-scoped delivery slices and historical implementation context. |
|
|
57
|
+
|
|
58
|
+
The rule is:
|
|
59
|
+
|
|
60
|
+
> Active work belongs in a release initiative. Multi-release context belongs in
|
|
61
|
+
> a program. Scoped future program work belongs in a planned initiative.
|
|
62
|
+
> Deferred isolated work belongs in the development backlog.
|
|
63
|
+
|
|
64
|
+
The delivery-surface rule is:
|
|
65
|
+
|
|
66
|
+
> Structure follows delivery concerns, not technologies.
|
|
67
|
+
|
|
68
|
+
Use `testing.md`, `delivery.md`, and `infrastructure.md` for concern-based
|
|
69
|
+
context. Mention specific tools inside those files only when the tools matter.
|
|
70
|
+
|
|
71
|
+
Mermaid diagrams are encouraged for flows, dependencies, and lifecycle maps
|
|
72
|
+
because they stay readable as Markdown for agents while rendering as visible
|
|
73
|
+
diagrams for humans.
|
|
74
|
+
|
|
75
|
+
The navigation rule is:
|
|
76
|
+
|
|
77
|
+
> Denormalize navigation, not knowledge.
|
|
78
|
+
|
|
79
|
+
Area `AGENTS.md` files should point agents back to this folder. They should
|
|
80
|
+
not copy specs, plans, or ADRs into area-local documents.
|
|
81
|
+
|
|
82
|
+
## Standard Layout
|
|
83
|
+
|
|
84
|
+
```text
|
|
85
|
+
Development/
|
|
86
|
+
current.md
|
|
87
|
+
programs/
|
|
88
|
+
<program-slug>/
|
|
89
|
+
README.md
|
|
90
|
+
context.md
|
|
91
|
+
roadmap.md
|
|
92
|
+
backlog.md
|
|
93
|
+
decisions/
|
|
94
|
+
planned-initiatives/
|
|
95
|
+
<planned-initiative-slug>/
|
|
96
|
+
README.md
|
|
97
|
+
plan.md
|
|
98
|
+
spec.md
|
|
99
|
+
releases/
|
|
100
|
+
v0_1_0.md
|
|
101
|
+
backlog/
|
|
102
|
+
README.md
|
|
103
|
+
items/
|
|
104
|
+
<originating-initiative-slug>--<item-slug>.md
|
|
105
|
+
releases/
|
|
106
|
+
v0_1_0/
|
|
107
|
+
README.md
|
|
108
|
+
backlog.md
|
|
109
|
+
initiatives/
|
|
110
|
+
<initiative-slug>/
|
|
111
|
+
README.md
|
|
112
|
+
plan.md
|
|
113
|
+
spec.md
|
|
114
|
+
interface.md
|
|
115
|
+
architecture.md
|
|
116
|
+
testing.md
|
|
117
|
+
delivery.md
|
|
118
|
+
infrastructure.md
|
|
119
|
+
operations.md
|
|
120
|
+
backlog.md
|
|
121
|
+
decisions/
|
|
122
|
+
ADR-0000-template.md
|
|
123
|
+
release-doc-notes.md
|
|
124
|
+
brief.html
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
## Programs
|
|
128
|
+
|
|
129
|
+
Programs preserve durable context for work that spans releases or phases. Use a
|
|
130
|
+
program when the larger effort has a roadmap, several release slices, important
|
|
131
|
+
decisions, or remaining scope that should stay visible after a release
|
|
132
|
+
initiative closes.
|
|
133
|
+
|
|
134
|
+
Use `planned-initiatives/` inside a program when future work is already clear
|
|
135
|
+
enough to scope, split, or preserve implementation intent, but the target
|
|
136
|
+
release is not current yet. Planned initiatives are promoted into release
|
|
137
|
+
initiatives when their target release becomes current.
|
|
138
|
+
|
|
139
|
+
Release initiatives should link to their program when one exists. Programs
|
|
140
|
+
should link back to the release initiatives that delivered each slice.
|
|
141
|
+
|
|
142
|
+
Do not use a program for a small leftover task. Use
|
|
143
|
+
`Development/backlog/items/` for deferred isolated work.
|
|
144
|
+
|
|
145
|
+
## Development Backlog
|
|
146
|
+
|
|
147
|
+
Use `Development/backlog/items/` for isolated work that was taken out of an
|
|
148
|
+
initiative's scope but should be kept for later. Each backlog item records its
|
|
149
|
+
origin initiative and release.
|
|
150
|
+
|
|
151
|
+
When a backlog item is picked up later, keep the backlog item as a historical
|
|
152
|
+
record. Mark it as promoted and link to the new release initiative instead of
|
|
153
|
+
rewriting the item into the new plan.
|
|
154
|
+
|
|
155
|
+
## Planned Initiatives
|
|
156
|
+
|
|
157
|
+
Planned initiatives are scoped children of a program that target a future
|
|
158
|
+
release. They preserve clear future scope without pretending that the future
|
|
159
|
+
release is already active.
|
|
160
|
+
|
|
161
|
+
Use a planned initiative when:
|
|
162
|
+
|
|
163
|
+
- the future phase is clear enough to write a plan, spec, or backlog
|
|
164
|
+
- the work belongs to a program
|
|
165
|
+
- the target release is known or likely
|
|
166
|
+
- the current release should not own active delivery for that scope yet
|
|
167
|
+
|
|
168
|
+
When the target release becomes current, promote the planned initiative into
|
|
169
|
+
the target release's `initiatives/` folder and leave the planned initiative
|
|
170
|
+
behind as historical planning context.
|
|
171
|
+
|
|
172
|
+
## Delivery Concerns
|
|
173
|
+
|
|
174
|
+
Release initiatives should describe the whole delivery surface when it matters,
|
|
175
|
+
not only the application code.
|
|
176
|
+
|
|
177
|
+
| File | Use for |
|
|
178
|
+
| --- | --- |
|
|
179
|
+
| `testing.md` | Verification strategy, automated coverage, manual checks, test data, regression risk, and release gates. |
|
|
180
|
+
| `delivery.md` | CI/CD, build behavior, deployment flow, environment promotion, release toggles, and delivery automation. |
|
|
181
|
+
| `infrastructure.md` | Environment shape, IaC, resources, networking, identity, storage, secrets, and environment dependencies. |
|
|
182
|
+
|
|
183
|
+
At the program level, use equivalent concern files only when the concern spans
|
|
184
|
+
multiple releases. A release-local test plan belongs in the release initiative.
|
|
185
|
+
A cross-release migration testing strategy may belong in the program.
|
|
186
|
+
|
|
187
|
+
## Initiative Files
|
|
188
|
+
|
|
189
|
+
Required for most initiatives:
|
|
190
|
+
|
|
191
|
+
| File | Purpose |
|
|
192
|
+
| --- | --- |
|
|
193
|
+
| `README.md` | Agent entry point, status, scope, touched areas, links, open questions. |
|
|
194
|
+
| `plan.md` | Working alignment space for humans and agents; rough notes, questions, options, and points to promote. |
|
|
195
|
+
| `spec.md` | What the system should do and which behavior is in or out. |
|
|
196
|
+
| `backlog.md` | What is changing now, sliced into trackable work. |
|
|
197
|
+
| `release-doc-notes.md` | Product documentation impact to review at release time. |
|
|
198
|
+
|
|
199
|
+
Use when relevant:
|
|
200
|
+
|
|
201
|
+
| File | Purpose |
|
|
202
|
+
| --- | --- |
|
|
203
|
+
| `interface.md` | How humans, clients, APIs, config, reports, or tools interact with it. |
|
|
204
|
+
| `architecture.md` | Internal shape, boundaries, data flow, contracts, and tradeoffs. |
|
|
205
|
+
| `testing.md` | Test strategy, automated/manual coverage, test data, and release gates. |
|
|
206
|
+
| `delivery.md` | CI/CD, build, deployment, environment promotion, and release toggles. |
|
|
207
|
+
| `infrastructure.md` | IaC, resources, environment shape, networking, identity, storage, and secrets. |
|
|
208
|
+
| `operations.md` | Optional. Use only for actionable runtime, support, observability, rollback, or repair context. |
|
|
209
|
+
| `decisions/ADR-*.md` | Why an important choice was made. |
|
|
210
|
+
| `brief.html` | Optional human-friendly presentation layer. |
|
|
211
|
+
|
|
212
|
+
## Carrying Context Forward
|
|
213
|
+
|
|
214
|
+
When an initiative produces context that needs to survive after the release:
|
|
215
|
+
|
|
216
|
+
- Move multi-release strategy, roadmap, and durable decisions into
|
|
217
|
+
`Development/programs/<program-slug>/`.
|
|
218
|
+
- Move scoped future delivery slices into
|
|
219
|
+
`Development/programs/<program-slug>/planned-initiatives/<initiative-slug>/`.
|
|
220
|
+
- Move isolated deferred work into
|
|
221
|
+
`Development/backlog/items/<originating-initiative-slug>--<item-slug>.md`.
|
|
222
|
+
- Keep release-scoped plans, implementation history, and final release notes
|
|
223
|
+
inside the original initiative.
|
|
224
|
+
|
|
225
|
+
## Changing The Current Release
|
|
226
|
+
|
|
227
|
+
Changing `Development/current.md` is a release transition, not just a line
|
|
228
|
+
edit. Use `Development/_templates/release-transition.md` as the checklist.
|
|
229
|
+
Create missing release folders from `Development/_templates/release-context/`.
|
|
230
|
+
|
|
231
|
+
When setting a release as current, agents should scan all program planned
|
|
232
|
+
initiatives for matching `Target release:` metadata and promote matching items
|
|
233
|
+
into `Development/releases/<version>/initiatives/`.
|
|
234
|
+
|
|
235
|
+
The promotion rule is:
|
|
236
|
+
|
|
237
|
+
> Planned initiatives are promoted, not moved silently.
|
|
238
|
+
|
|
239
|
+
## Agent Workflow
|
|
240
|
+
|
|
241
|
+
When changing behavior, agents should:
|
|
242
|
+
|
|
243
|
+
1. Read the local `AGENTS.md`.
|
|
244
|
+
2. Open `Development/current.md`.
|
|
245
|
+
3. Check the current release's initiatives for matching context.
|
|
246
|
+
4. Use `plan.md` for live alignment, open questions, and rough thinking.
|
|
247
|
+
Promote settled conclusions into the stable initiative files.
|
|
248
|
+
5. Update the matching initiative when the change affects its scope.
|
|
249
|
+
6. Create a new initiative from `_templates/initiative/` for non-trivial
|
|
250
|
+
behavior changes that do not belong to an existing initiative.
|
|
251
|
+
7. Create or update a program planned initiative when future scoped work is
|
|
252
|
+
clear but belongs outside the current release.
|
|
253
|
+
8. Record future product-doc impact in `release-doc-notes.md`, not in
|
|
254
|
+
`Documentation/`, unless a human explicitly asks for documentation refresh.
|
|
255
|
+
|
|
256
|
+
The key rule for planning is:
|
|
257
|
+
|
|
258
|
+
> `plan.md` is allowed to be messy, but it must not become the only place where
|
|
259
|
+
> settled truth lives.
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Backlog Item Title
|
|
2
|
+
|
|
3
|
+
Status: Candidate
|
|
4
|
+
Originating initiative: `Development/releases/v0_1_0/initiatives/<initiative-slug>/`
|
|
5
|
+
Originating release: `v0_1_0`
|
|
6
|
+
Area: TBD
|
|
7
|
+
Reason deferred: TBD
|
|
8
|
+
Created: YYYY-MM-DD
|
|
9
|
+
|
|
10
|
+
## Summary
|
|
11
|
+
|
|
12
|
+
Briefly describe the deferred work.
|
|
13
|
+
|
|
14
|
+
## Why It Was Deferred
|
|
15
|
+
|
|
16
|
+
Explain the scope, risk, timing, dependency, or procedure that moved this
|
|
17
|
+
out of the originating initiative.
|
|
18
|
+
|
|
19
|
+
## Future Value
|
|
20
|
+
|
|
21
|
+
Explain why this is worth preserving for later.
|
|
22
|
+
|
|
23
|
+
## Re-Entry Criteria
|
|
24
|
+
|
|
25
|
+
Describe what would make this worth picking up later.
|
|
26
|
+
|
|
27
|
+
## Notes
|
|
28
|
+
|
|
29
|
+
Capture useful implementation, design, test, operational, or support notes.
|
|
30
|
+
|
|
31
|
+
## Promotion
|
|
32
|
+
|
|
33
|
+
Status remains `Candidate` until it is picked up. When promoted, update this
|
|
34
|
+
section and leave the item as a historical record.
|
|
35
|
+
|
|
36
|
+
```md
|
|
37
|
+
Status: Promoted
|
|
38
|
+
Promoted to: `Development/releases/<version>/initiatives/<initiative-slug>/`
|
|
39
|
+
```
|
|
40
|
+
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# Initiative Title
|
|
2
|
+
|
|
3
|
+
Status: Draft
|
|
4
|
+
Release: v0_1_0
|
|
5
|
+
Primary area: TBD
|
|
6
|
+
Program: None
|
|
7
|
+
|
|
8
|
+
## Summary
|
|
9
|
+
|
|
10
|
+
Briefly describe the change, why it exists, and what outcome it should
|
|
11
|
+
produce.
|
|
12
|
+
|
|
13
|
+
## Touched Areas
|
|
14
|
+
|
|
15
|
+
- `src/<area>/...`
|
|
16
|
+
- `deploy/...`
|
|
17
|
+
- `automation/...`
|
|
18
|
+
|
|
19
|
+
Remove entries that do not apply and add the real paths.
|
|
20
|
+
|
|
21
|
+
## Current Source Of Truth
|
|
22
|
+
|
|
23
|
+
- `plan.md`
|
|
24
|
+
- `spec.md`
|
|
25
|
+
- `interface.md`
|
|
26
|
+
- `architecture.md`
|
|
27
|
+
- `testing.md`
|
|
28
|
+
- `delivery.md`
|
|
29
|
+
- `infrastructure.md`
|
|
30
|
+
- `operations.md` when actionable
|
|
31
|
+
- `backlog.md`
|
|
32
|
+
- `release-doc-notes.md`
|
|
33
|
+
|
|
34
|
+
Mark files as not applicable if they do not matter for this initiative.
|
|
35
|
+
Create or keep `operations.md` only when there is actionable runtime,
|
|
36
|
+
support, observability, rollback, or repair context.
|
|
37
|
+
|
|
38
|
+
## Carry-Forward Context
|
|
39
|
+
|
|
40
|
+
- Program: None
|
|
41
|
+
- Deferred backlog items: None
|
|
42
|
+
|
|
43
|
+
## Open Questions
|
|
44
|
+
|
|
45
|
+
- None yet.
|
|
46
|
+
|
|
47
|
+
## Implementation Status
|
|
48
|
+
|
|
49
|
+
- Not started.
|
|
50
|
+
|
|
51
|
+
## Agent Notes
|
|
52
|
+
|
|
53
|
+
- Keep initiative knowledge in this folder.
|
|
54
|
+
- Use `plan.md` for live alignment, questions, options, and rough thinking.
|
|
55
|
+
Promote settled conclusions into the stable initiative files.
|
|
56
|
+
- Update `release-doc-notes.md` when shipped behavior or product-facing
|
|
57
|
+
behavior changes.
|
|
58
|
+
- Do not update `Documentation/` from this initiative unless a human
|
|
59
|
+
explicitly asks for release documentation work.
|