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,44 @@
|
|
|
1
|
+
# Architecture
|
|
2
|
+
|
|
3
|
+
## Context
|
|
4
|
+
|
|
5
|
+
Describe the internal shape of the solution and the existing boundaries this
|
|
6
|
+
initiative must respect.
|
|
7
|
+
|
|
8
|
+
## Components
|
|
9
|
+
|
|
10
|
+
| Component | Responsibility |
|
|
11
|
+
| --- | --- |
|
|
12
|
+
| TBD | TBD |
|
|
13
|
+
|
|
14
|
+
## Flow
|
|
15
|
+
|
|
16
|
+
Use Mermaid when the relationship between moving parts is easier to show than
|
|
17
|
+
explain. Mermaid is valuable here because it stays readable as Markdown for
|
|
18
|
+
agents while rendering as a visible diagram for humans.
|
|
19
|
+
|
|
20
|
+
```mermaid
|
|
21
|
+
flowchart LR
|
|
22
|
+
User[User or caller] -->|request| Entry[Entry point]
|
|
23
|
+
Entry -->|uses| Service[Service]
|
|
24
|
+
Service -->|reads/writes| Store[(Store)]
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Data And Contracts
|
|
28
|
+
|
|
29
|
+
Describe entities, DTOs, events, messages, config, migrations, or external
|
|
30
|
+
contracts affected by the initiative.
|
|
31
|
+
|
|
32
|
+
## Boundaries
|
|
33
|
+
|
|
34
|
+
Describe ownership boundaries, shared layers, external dependencies, and
|
|
35
|
+
what this initiative must not take over.
|
|
36
|
+
|
|
37
|
+
## Security And Compliance
|
|
38
|
+
|
|
39
|
+
Capture authentication, authorization, data residency, audit, privacy,
|
|
40
|
+
secret handling, and abuse cases.
|
|
41
|
+
|
|
42
|
+
## Test Strategy
|
|
43
|
+
|
|
44
|
+
List the tests or verification paths needed for confidence.
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Backlog
|
|
2
|
+
|
|
3
|
+
## Status Legend
|
|
4
|
+
|
|
5
|
+
- `Todo`
|
|
6
|
+
- `In Progress`
|
|
7
|
+
- `Blocked`
|
|
8
|
+
- `Done`
|
|
9
|
+
- `Deferred`
|
|
10
|
+
|
|
11
|
+
## Work Items
|
|
12
|
+
|
|
13
|
+
| Status | Item | Area | Notes |
|
|
14
|
+
| --- | --- | --- | --- |
|
|
15
|
+
| Todo | Define first slice | TBD | TBD |
|
|
16
|
+
|
|
17
|
+
## Deferred
|
|
18
|
+
|
|
19
|
+
Use this section only for work deferred within the active initiative.
|
|
20
|
+
|
|
21
|
+
If a deferred item should outlive this initiative as future isolated work,
|
|
22
|
+
create a backlog item from `Development/_templates/backlog-item.md` under:
|
|
23
|
+
|
|
24
|
+
```text
|
|
25
|
+
Development/backlog/items/<originating-initiative-slug>--<item-slug>.md
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
- None yet.
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
<!doctype html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
6
|
+
<title>Initiative Brief</title>
|
|
7
|
+
<style>
|
|
8
|
+
body {
|
|
9
|
+
font-family: Arial, sans-serif;
|
|
10
|
+
margin: 2rem;
|
|
11
|
+
line-height: 1.5;
|
|
12
|
+
color: #1f2933;
|
|
13
|
+
background: #ffffff;
|
|
14
|
+
}
|
|
15
|
+
main {
|
|
16
|
+
max-width: 960px;
|
|
17
|
+
margin: 0 auto;
|
|
18
|
+
}
|
|
19
|
+
h1, h2 {
|
|
20
|
+
line-height: 1.2;
|
|
21
|
+
}
|
|
22
|
+
table {
|
|
23
|
+
border-collapse: collapse;
|
|
24
|
+
width: 100%;
|
|
25
|
+
}
|
|
26
|
+
th, td {
|
|
27
|
+
border: 1px solid #d5dce3;
|
|
28
|
+
padding: 0.5rem;
|
|
29
|
+
text-align: left;
|
|
30
|
+
vertical-align: top;
|
|
31
|
+
}
|
|
32
|
+
</style>
|
|
33
|
+
</head>
|
|
34
|
+
<body>
|
|
35
|
+
<main>
|
|
36
|
+
<h1>Initiative Brief</h1>
|
|
37
|
+
<p>Use this optional page when a concise human-readable summary is useful.</p>
|
|
38
|
+
|
|
39
|
+
<h2>Outcome</h2>
|
|
40
|
+
<p>TBD</p>
|
|
41
|
+
|
|
42
|
+
<h2>Scope</h2>
|
|
43
|
+
<table>
|
|
44
|
+
<tr>
|
|
45
|
+
<th>In</th>
|
|
46
|
+
<th>Out</th>
|
|
47
|
+
</tr>
|
|
48
|
+
<tr>
|
|
49
|
+
<td>TBD</td>
|
|
50
|
+
<td>TBD</td>
|
|
51
|
+
</tr>
|
|
52
|
+
</table>
|
|
53
|
+
</main>
|
|
54
|
+
</body>
|
|
55
|
+
</html>
|
|
56
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# ADR-0000: Decision Title
|
|
2
|
+
|
|
3
|
+
Status: Proposed
|
|
4
|
+
Date: YYYY-MM-DD
|
|
5
|
+
|
|
6
|
+
## Context
|
|
7
|
+
|
|
8
|
+
Describe the problem, constraints, forces, and options that make this
|
|
9
|
+
decision necessary.
|
|
10
|
+
|
|
11
|
+
## Decision
|
|
12
|
+
|
|
13
|
+
State the decision clearly.
|
|
14
|
+
|
|
15
|
+
## Consequences
|
|
16
|
+
|
|
17
|
+
Positive:
|
|
18
|
+
|
|
19
|
+
- Consequence 1
|
|
20
|
+
|
|
21
|
+
Negative or tradeoffs:
|
|
22
|
+
|
|
23
|
+
- Tradeoff 1
|
|
24
|
+
|
|
25
|
+
## Alternatives Considered
|
|
26
|
+
|
|
27
|
+
| Alternative | Why not |
|
|
28
|
+
| --- | --- |
|
|
29
|
+
| TBD | TBD |
|
|
30
|
+
|
|
31
|
+
## Links
|
|
32
|
+
|
|
33
|
+
- Related specs, PRs, tickets, discussions, or code paths.
|
|
34
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Delivery
|
|
2
|
+
|
|
3
|
+
Use this file for CI/CD, build, release, and environment-promotion behavior.
|
|
4
|
+
Name the concern, not the tool. Pipeline definitions, workflow files,
|
|
5
|
+
deployment scripts, release toggles, and gates can all appear here when
|
|
6
|
+
relevant.
|
|
7
|
+
|
|
8
|
+
## Pipeline Impact
|
|
9
|
+
|
|
10
|
+
Describe pipeline, workflow, build, packaging, or artifact changes.
|
|
11
|
+
|
|
12
|
+
## Build And Release Gates
|
|
13
|
+
|
|
14
|
+
List checks that must pass before merge, deployment, promotion, or release.
|
|
15
|
+
|
|
16
|
+
| Gate | Applies to | Notes |
|
|
17
|
+
| --- | --- | --- |
|
|
18
|
+
| TBD | TBD | TBD |
|
|
19
|
+
|
|
20
|
+
## Deployment Flow
|
|
21
|
+
|
|
22
|
+
Describe deployment order, environment promotion, release windows, approvals,
|
|
23
|
+
and any sequencing constraints.
|
|
24
|
+
|
|
25
|
+
## Feature Flags And Toggles
|
|
26
|
+
|
|
27
|
+
List release flags, kill switches, configuration toggles, or staged rollout
|
|
28
|
+
controls.
|
|
29
|
+
|
|
30
|
+
## Delivery Automation
|
|
31
|
+
|
|
32
|
+
Capture scripts, commands, CLIs, jobs, or approved automation integrations
|
|
33
|
+
that agents or engineers can use to act on delivery.
|
|
34
|
+
|
|
35
|
+
## Rollout Notes
|
|
36
|
+
|
|
37
|
+
Describe staged rollout, canary behavior, compatibility windows, or release
|
|
38
|
+
coordination.
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Infrastructure
|
|
2
|
+
|
|
3
|
+
Use this file for environment shape and infrastructure dependencies. Name the
|
|
4
|
+
concern, not the tool. Infrastructure modules, resource templates, manifests,
|
|
5
|
+
or manual environment steps can all appear here when relevant.
|
|
6
|
+
|
|
7
|
+
## Environment Shape
|
|
8
|
+
|
|
9
|
+
Describe new or changed resources, services, networks, identity boundaries,
|
|
10
|
+
storage, compute, queues, topics, or runtime hosts.
|
|
11
|
+
|
|
12
|
+
## Infrastructure As Code
|
|
13
|
+
|
|
14
|
+
List IaC modules, manifests, templates, parameters, or state changes.
|
|
15
|
+
|
|
16
|
+
| Resource or module | Change | Location | Status |
|
|
17
|
+
| --- | --- | --- | --- |
|
|
18
|
+
| TBD | TBD | TBD | Todo |
|
|
19
|
+
|
|
20
|
+
## Configuration And Secrets
|
|
21
|
+
|
|
22
|
+
List environment variables, app settings, feature flags, secrets, certificates,
|
|
23
|
+
secret manager references, or secret-rotation needs.
|
|
24
|
+
|
|
25
|
+
## Environment Dependencies
|
|
26
|
+
|
|
27
|
+
Capture dependencies between environments, regions, tenants, subscriptions,
|
|
28
|
+
clusters, accounts, or shared services.
|
|
29
|
+
|
|
30
|
+
## Compatibility And Migration
|
|
31
|
+
|
|
32
|
+
Describe infrastructure compatibility windows, provisioning order, migration
|
|
33
|
+
constraints, or cleanup work.
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Interface
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
Describe how humans, clients, APIs, configuration, reports, or tools
|
|
6
|
+
interact with this initiative.
|
|
7
|
+
|
|
8
|
+
## Surfaces
|
|
9
|
+
|
|
10
|
+
- UI:
|
|
11
|
+
- API:
|
|
12
|
+
- CLI or scripts:
|
|
13
|
+
- Configuration:
|
|
14
|
+
- Reports or exports:
|
|
15
|
+
|
|
16
|
+
Remove surfaces that do not apply.
|
|
17
|
+
|
|
18
|
+
## Workflows
|
|
19
|
+
|
|
20
|
+
Describe the user, operator, support, or integration workflows.
|
|
21
|
+
|
|
22
|
+
## Inputs And Outputs
|
|
23
|
+
|
|
24
|
+
| Surface | Inputs | Outputs |
|
|
25
|
+
| --- | --- | --- |
|
|
26
|
+
| TBD | TBD | TBD |
|
|
27
|
+
|
|
28
|
+
## States And Feedback
|
|
29
|
+
|
|
30
|
+
Capture loading, empty, success, validation, warning, and error states when
|
|
31
|
+
they apply.
|
|
32
|
+
|
|
33
|
+
## Permissions
|
|
34
|
+
|
|
35
|
+
Describe who can see, change, trigger, approve, or audit the behavior.
|
|
36
|
+
|
|
37
|
+
## Terminology
|
|
38
|
+
|
|
39
|
+
Record terms that must stay consistent across UI, API, docs, logs, and
|
|
40
|
+
support language.
|
|
41
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Operations
|
|
2
|
+
|
|
3
|
+
Use this file only when the initiative has actionable runtime, support,
|
|
4
|
+
observability, rollback, or repair implications.
|
|
5
|
+
|
|
6
|
+
If there is nothing concrete for an agent or engineer to act on, omit this
|
|
7
|
+
file after copying the template or mark it as not applicable. Delivery belongs
|
|
8
|
+
in `delivery.md`; environment shape and IaC belong in `infrastructure.md`.
|
|
9
|
+
|
|
10
|
+
## Runtime Behavior
|
|
11
|
+
|
|
12
|
+
Describe how the live system behaves after the initiative ships, especially
|
|
13
|
+
jobs, schedules, queues, topics, subscriptions, retries, degraded modes, or
|
|
14
|
+
runtime compatibility constraints.
|
|
15
|
+
|
|
16
|
+
## Observability And Support Signals
|
|
17
|
+
|
|
18
|
+
Capture logs, metrics, traces, dashboards, alerts, health checks, support
|
|
19
|
+
signals, and customer-visible symptoms.
|
|
20
|
+
|
|
21
|
+
## Failure Modes
|
|
22
|
+
|
|
23
|
+
Describe expected failures, retries, poison-message behavior, timeouts,
|
|
24
|
+
partial outages, degraded modes, and support signals.
|
|
25
|
+
|
|
26
|
+
## Rollback And Recovery
|
|
27
|
+
|
|
28
|
+
Describe how to recover from bad runtime behavior. Include whether rollback is
|
|
29
|
+
safe, whether roll-forward is required, and what state must be repaired.
|
|
30
|
+
|
|
31
|
+
## Data Operations And Repair
|
|
32
|
+
|
|
33
|
+
Capture migrations, backfills, cleanups, retention, repair scripts, manual
|
|
34
|
+
support procedures, and validation queries.
|
|
35
|
+
|
|
36
|
+
## Actionable Tooling
|
|
37
|
+
|
|
38
|
+
List CLIs, scripts, dashboards-as-code, alerts-as-code, or other approved
|
|
39
|
+
automation integrations that agents or engineers can use. If none exists, say
|
|
40
|
+
so explicitly.
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# Plan
|
|
2
|
+
|
|
3
|
+
Use this file as the working alignment space for humans and agents. It may
|
|
4
|
+
contain rough thinking, questions, options, partial plans, and notes from
|
|
5
|
+
collaboration sessions.
|
|
6
|
+
|
|
7
|
+
`plan.md` is allowed to be messy, but it must not become the only place where
|
|
8
|
+
settled truth lives. Promote stable conclusions into the appropriate
|
|
9
|
+
initiative files:
|
|
10
|
+
|
|
11
|
+
- `spec.md` for settled behavior and acceptance criteria
|
|
12
|
+
- `interface.md` for settled UI, API, config, or human workflow details
|
|
13
|
+
- `architecture.md` for settled internal shape, boundaries, flows, and data
|
|
14
|
+
- `testing.md` for settled verification strategy, coverage, and release gates
|
|
15
|
+
- `delivery.md` for settled CI/CD, build, deployment, and promotion behavior
|
|
16
|
+
- `infrastructure.md` for settled environment shape, IaC, and dependencies
|
|
17
|
+
- `operations.md` only for actionable runtime, support, failure, rollback, and
|
|
18
|
+
repair notes
|
|
19
|
+
- `backlog.md` for executable work items
|
|
20
|
+
- `decisions/ADR-*.md` for durable decisions
|
|
21
|
+
- `release-doc-notes.md` for future product-documentation impact
|
|
22
|
+
|
|
23
|
+
## Current Alignment
|
|
24
|
+
|
|
25
|
+
Describe the current agreed direction.
|
|
26
|
+
|
|
27
|
+
## Working Notes
|
|
28
|
+
|
|
29
|
+
- Note 1
|
|
30
|
+
|
|
31
|
+
## Open Questions
|
|
32
|
+
|
|
33
|
+
- Question 1
|
|
34
|
+
|
|
35
|
+
## Options Considered
|
|
36
|
+
|
|
37
|
+
| Option | Pros | Cons | Status |
|
|
38
|
+
| --- | --- | --- | --- |
|
|
39
|
+
| TBD | TBD | TBD | Open |
|
|
40
|
+
|
|
41
|
+
## Notes To Promote
|
|
42
|
+
|
|
43
|
+
Use this section as a short queue of stable points that should be moved into
|
|
44
|
+
the canonical initiative files.
|
|
45
|
+
|
|
46
|
+
- [ ] Move settled behavior into `spec.md`
|
|
47
|
+
- [ ] Move settled interface details into `interface.md`
|
|
48
|
+
- [ ] Move settled technical shape into `architecture.md`
|
|
49
|
+
- [ ] Move settled verification strategy into `testing.md`
|
|
50
|
+
- [ ] Move settled delivery and pipeline behavior into `delivery.md`
|
|
51
|
+
- [ ] Move settled environment and IaC context into `infrastructure.md`
|
|
52
|
+
- [ ] Move actionable runtime/support concerns into `operations.md`
|
|
53
|
+
- [ ] Move executable work into `backlog.md`
|
|
54
|
+
- [ ] Move multi-release context into `Development/programs/`
|
|
55
|
+
- [ ] Move isolated deferred work into `Development/backlog/items/`
|
|
56
|
+
- [ ] Move durable decisions into `decisions/`
|
|
57
|
+
- [ ] Move product-documentation impact into `release-doc-notes.md`
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# Release Documentation Notes
|
|
2
|
+
|
|
3
|
+
Use this file to capture product-documentation impact while development is
|
|
4
|
+
in progress. At release time, these notes help refresh `Documentation/`
|
|
5
|
+
against the final shipped behavior.
|
|
6
|
+
|
|
7
|
+
Do not edit `Documentation/` from normal development work unless a human
|
|
8
|
+
explicitly asks for a documentation refresh or a specific documentation fix.
|
|
9
|
+
|
|
10
|
+
## Product Behavior Changes
|
|
11
|
+
|
|
12
|
+
- None yet.
|
|
13
|
+
|
|
14
|
+
## Candidate Documentation Areas
|
|
15
|
+
|
|
16
|
+
- `Documentation/<Area>/README.md`
|
|
17
|
+
- `Documentation/<Area>/features/<feature>.md`
|
|
18
|
+
|
|
19
|
+
## QA Or Support Notes
|
|
20
|
+
|
|
21
|
+
- None yet.
|
|
22
|
+
|
|
23
|
+
## Exclusions
|
|
24
|
+
|
|
25
|
+
Record details that were considered but should not be documented because
|
|
26
|
+
they are internal implementation details, temporary scaffolding, or did not
|
|
27
|
+
ship.
|
|
28
|
+
|
|
29
|
+
## Release-Time Checklist
|
|
30
|
+
|
|
31
|
+
- [ ] Compare this initiative against the final shipped code.
|
|
32
|
+
- [ ] Update the relevant product documentation only after release-doc work
|
|
33
|
+
is explicitly requested.
|
|
34
|
+
- [ ] Add the release row if the documentation workflow requires it.
|
|
35
|
+
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# Spec
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
Describe what the system should do and why this behavior matters.
|
|
6
|
+
|
|
7
|
+
## Goals
|
|
8
|
+
|
|
9
|
+
- Goal 1
|
|
10
|
+
- Goal 2
|
|
11
|
+
|
|
12
|
+
## Non-Goals
|
|
13
|
+
|
|
14
|
+
- Non-goal 1
|
|
15
|
+
|
|
16
|
+
## Behavior
|
|
17
|
+
|
|
18
|
+
Describe the expected behavior in product or domain language. Include:
|
|
19
|
+
|
|
20
|
+
- Normal flow
|
|
21
|
+
- Permission rules
|
|
22
|
+
- Data rules
|
|
23
|
+
- Validation rules
|
|
24
|
+
- Error behavior
|
|
25
|
+
- Edge cases
|
|
26
|
+
|
|
27
|
+
## Acceptance Criteria
|
|
28
|
+
|
|
29
|
+
- [ ] Criterion 1
|
|
30
|
+
- [ ] Criterion 2
|
|
31
|
+
|
|
32
|
+
## Dependencies
|
|
33
|
+
|
|
34
|
+
- Related initiatives, systems, teams, services, or decisions.
|
|
35
|
+
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Testing
|
|
2
|
+
|
|
3
|
+
Use this file for the initiative's verification strategy. Name the concern,
|
|
4
|
+
not the tool. Specific test runners, unit test frameworks, contract tests, or
|
|
5
|
+
manual scripts can all appear here when they are relevant.
|
|
6
|
+
|
|
7
|
+
## Test Strategy
|
|
8
|
+
|
|
9
|
+
Describe what must be proven before this initiative can ship.
|
|
10
|
+
|
|
11
|
+
## Automated Coverage
|
|
12
|
+
|
|
13
|
+
List unit, integration, contract, e2e, smoke, regression, or performance tests
|
|
14
|
+
that should be added or updated.
|
|
15
|
+
|
|
16
|
+
| Area | Coverage | Tool or location | Status |
|
|
17
|
+
| --- | --- | --- | --- |
|
|
18
|
+
| TBD | TBD | TBD | Todo |
|
|
19
|
+
|
|
20
|
+
## Manual Verification
|
|
21
|
+
|
|
22
|
+
List any human verification that remains necessary.
|
|
23
|
+
|
|
24
|
+
- None identified yet.
|
|
25
|
+
|
|
26
|
+
## Test Data And Environments
|
|
27
|
+
|
|
28
|
+
Capture required accounts, seeded data, fixtures, environment assumptions, or
|
|
29
|
+
data cleanup needs.
|
|
30
|
+
|
|
31
|
+
## Release Gates
|
|
32
|
+
|
|
33
|
+
List the checks that must pass before release.
|
|
34
|
+
|
|
35
|
+
- Existing CI test suite passes.
|
|
36
|
+
|
|
37
|
+
## Known Gaps
|
|
38
|
+
|
|
39
|
+
List accepted test gaps, why they are acceptable, and what would close them.
|
|
40
|
+
|
|
41
|
+
- None identified yet.
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# Planned Initiative Title
|
|
2
|
+
|
|
3
|
+
Status: Planned
|
|
4
|
+
Target release: vNEXT
|
|
5
|
+
Program: `Development/programs/<program-slug>/`
|
|
6
|
+
Promotion target: `Development/releases/vNEXT/initiatives/<initiative-slug>/`
|
|
7
|
+
Promoted to: None
|
|
8
|
+
Promoted on: None
|
|
9
|
+
|
|
10
|
+
## Summary
|
|
11
|
+
|
|
12
|
+
Briefly describe the future delivery slice, why it belongs to the program,
|
|
13
|
+
and what outcome it should produce.
|
|
14
|
+
|
|
15
|
+
## Touched Areas
|
|
16
|
+
|
|
17
|
+
- `src/<area>/...`
|
|
18
|
+
- `deploy/...`
|
|
19
|
+
- `automation/...`
|
|
20
|
+
|
|
21
|
+
Remove entries that do not apply and add the real paths.
|
|
22
|
+
|
|
23
|
+
## Current Source Of Truth
|
|
24
|
+
|
|
25
|
+
- `plan.md`
|
|
26
|
+
- `spec.md`
|
|
27
|
+
- `interface.md`
|
|
28
|
+
- `architecture.md`
|
|
29
|
+
- `testing.md`
|
|
30
|
+
- `delivery.md`
|
|
31
|
+
- `infrastructure.md`
|
|
32
|
+
- `operations.md` when actionable
|
|
33
|
+
- `backlog.md`
|
|
34
|
+
- `release-doc-notes.md`
|
|
35
|
+
|
|
36
|
+
Mark files as not applicable if they do not matter for this planned
|
|
37
|
+
initiative. Create or keep `operations.md` only when there is actionable
|
|
38
|
+
runtime, support, observability, rollback, or repair context.
|
|
39
|
+
|
|
40
|
+
## Promotion Notes
|
|
41
|
+
|
|
42
|
+
When the target release becomes current, promote this planned initiative into
|
|
43
|
+
the target release initiative folder. Do not delete this planned initiative;
|
|
44
|
+
leave it as the historical planning record and update the promotion metadata.
|
|
45
|
+
|
|
46
|
+
## Open Questions
|
|
47
|
+
|
|
48
|
+
- None yet.
|
|
49
|
+
|
|
50
|
+
## Agent Notes
|
|
51
|
+
|
|
52
|
+
- Use this folder when future scope is known well enough to preserve as a
|
|
53
|
+
scoped delivery slice, but the target release is not current yet.
|
|
54
|
+
- Keep durable cross-release strategy in the parent program.
|
|
55
|
+
- Keep active implementation work in the release initiative after promotion.
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Architecture
|
|
2
|
+
|
|
3
|
+
## Context
|
|
4
|
+
|
|
5
|
+
Describe the internal shape of the future delivery slice and the existing
|
|
6
|
+
boundaries it must respect.
|
|
7
|
+
|
|
8
|
+
## Components
|
|
9
|
+
|
|
10
|
+
| Component | Responsibility |
|
|
11
|
+
| --- | --- |
|
|
12
|
+
| TBD | TBD |
|
|
13
|
+
|
|
14
|
+
## Flow
|
|
15
|
+
|
|
16
|
+
Use Mermaid when the relationship between moving parts is easier to show than
|
|
17
|
+
explain. Mermaid is valuable here because it stays readable as Markdown for
|
|
18
|
+
agents while rendering as a visible diagram for humans.
|
|
19
|
+
|
|
20
|
+
```mermaid
|
|
21
|
+
flowchart LR
|
|
22
|
+
User[User or caller] -->|request| Entry[Entry point]
|
|
23
|
+
Entry -->|uses| Service[Service]
|
|
24
|
+
Service -->|reads/writes| Store[(Store)]
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Data And Contracts
|
|
28
|
+
|
|
29
|
+
Describe entities, DTOs, events, messages, config, migrations, or external
|
|
30
|
+
contracts expected to be affected.
|
|
31
|
+
|
|
32
|
+
## Boundaries
|
|
33
|
+
|
|
34
|
+
Describe ownership boundaries, shared layers, external dependencies, and
|
|
35
|
+
what this planned initiative must not take over.
|
|
36
|
+
|
|
37
|
+
## Security And Compliance
|
|
38
|
+
|
|
39
|
+
Capture authentication, authorization, data residency, audit, privacy,
|
|
40
|
+
secret handling, and abuse cases.
|
|
41
|
+
|
|
42
|
+
## Test Strategy
|
|
43
|
+
|
|
44
|
+
List the tests or verification paths expected to provide confidence.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Backlog
|
|
2
|
+
|
|
3
|
+
## Status Legend
|
|
4
|
+
|
|
5
|
+
- `Todo`
|
|
6
|
+
- `In Progress`
|
|
7
|
+
- `Blocked`
|
|
8
|
+
- `Done`
|
|
9
|
+
- `Deferred`
|
|
10
|
+
|
|
11
|
+
## Work Items
|
|
12
|
+
|
|
13
|
+
| Status | Item | Area | Notes |
|
|
14
|
+
| --- | --- | --- | --- |
|
|
15
|
+
| Todo | Define first slice | TBD | TBD |
|
|
16
|
+
|
|
17
|
+
## Promotion Readiness
|
|
18
|
+
|
|
19
|
+
- [ ] Target release is still accurate.
|
|
20
|
+
- [ ] Parent program links to this planned initiative.
|
|
21
|
+
- [ ] Dependencies from earlier phases are captured.
|
|
22
|
+
- [ ] Release initiative promotion target is accurate.
|
|
23
|
+
|
|
24
|
+
## Deferred
|
|
25
|
+
|
|
26
|
+
- None yet.
|
|
27
|
+
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# ADR-0000: Decision Title
|
|
2
|
+
|
|
3
|
+
Status: Proposed
|
|
4
|
+
Date: YYYY-MM-DD
|
|
5
|
+
|
|
6
|
+
## Context
|
|
7
|
+
|
|
8
|
+
Describe the future-scope decision, constraints, forces, and options that
|
|
9
|
+
make this decision necessary.
|
|
10
|
+
|
|
11
|
+
## Decision
|
|
12
|
+
|
|
13
|
+
State the decision clearly.
|
|
14
|
+
|
|
15
|
+
## Consequences
|
|
16
|
+
|
|
17
|
+
Positive:
|
|
18
|
+
|
|
19
|
+
- Consequence 1
|
|
20
|
+
|
|
21
|
+
Negative or tradeoffs:
|
|
22
|
+
|
|
23
|
+
- Tradeoff 1
|
|
24
|
+
|
|
25
|
+
## Alternatives Considered
|
|
26
|
+
|
|
27
|
+
| Alternative | Why not |
|
|
28
|
+
| --- | --- |
|
|
29
|
+
| TBD | TBD |
|
|
30
|
+
|
|
31
|
+
## Links
|
|
32
|
+
|
|
33
|
+
- Related program files, release initiatives, backlog items, PRs, tickets,
|
|
34
|
+
or discussions.
|
|
35
|
+
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Delivery
|
|
2
|
+
|
|
3
|
+
Use this file for future CI/CD, build, release, and environment-promotion
|
|
4
|
+
behavior that is already clear enough to preserve.
|
|
5
|
+
|
|
6
|
+
## Pipeline Impact
|
|
7
|
+
|
|
8
|
+
Describe expected pipeline, workflow, build, packaging, or artifact changes.
|
|
9
|
+
|
|
10
|
+
## Build And Release Gates
|
|
11
|
+
|
|
12
|
+
| Gate | Applies to | Notes |
|
|
13
|
+
| --- | --- | --- |
|
|
14
|
+
| TBD | TBD | TBD |
|
|
15
|
+
|
|
16
|
+
## Deployment Flow
|
|
17
|
+
|
|
18
|
+
Describe expected deployment order, environment promotion, approvals, or
|
|
19
|
+
sequencing constraints.
|
|
20
|
+
|
|
21
|
+
## Feature Flags And Toggles
|
|
22
|
+
|
|
23
|
+
List expected release flags, kill switches, configuration toggles, or staged
|
|
24
|
+
rollout controls.
|
|
25
|
+
|
|
26
|
+
## Delivery Automation
|
|
27
|
+
|
|
28
|
+
Capture scripts, commands, CLIs, jobs, or approved automation integrations
|
|
29
|
+
that may be needed.
|
|
30
|
+
|
|
31
|
+
## Rollout Notes
|
|
32
|
+
|
|
33
|
+
Describe staged rollout, compatibility windows, or release coordination.
|