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.
Files changed (68) hide show
  1. package/.agents/skills/README.md +13 -0
  2. package/.agents/skills/development-initiative-context/SKILL.md +209 -0
  3. package/AGENTS.md +52 -0
  4. package/Development/AGENTS.md +46 -0
  5. package/Development/README.md +259 -0
  6. package/Development/_templates/backlog-item.md +40 -0
  7. package/Development/_templates/initiative/README.md +59 -0
  8. package/Development/_templates/initiative/architecture.md +44 -0
  9. package/Development/_templates/initiative/backlog.md +28 -0
  10. package/Development/_templates/initiative/brief.html +56 -0
  11. package/Development/_templates/initiative/decisions/ADR-0000-template.md +34 -0
  12. package/Development/_templates/initiative/delivery.md +38 -0
  13. package/Development/_templates/initiative/infrastructure.md +33 -0
  14. package/Development/_templates/initiative/interface.md +41 -0
  15. package/Development/_templates/initiative/operations.md +40 -0
  16. package/Development/_templates/initiative/plan.md +57 -0
  17. package/Development/_templates/initiative/release-doc-notes.md +35 -0
  18. package/Development/_templates/initiative/spec.md +35 -0
  19. package/Development/_templates/initiative/testing.md +41 -0
  20. package/Development/_templates/planned-initiative/README.md +55 -0
  21. package/Development/_templates/planned-initiative/architecture.md +44 -0
  22. package/Development/_templates/planned-initiative/backlog.md +27 -0
  23. package/Development/_templates/planned-initiative/decisions/ADR-0000-template.md +35 -0
  24. package/Development/_templates/planned-initiative/delivery.md +33 -0
  25. package/Development/_templates/planned-initiative/infrastructure.md +30 -0
  26. package/Development/_templates/planned-initiative/interface.md +41 -0
  27. package/Development/_templates/planned-initiative/operations.md +41 -0
  28. package/Development/_templates/planned-initiative/plan.md +40 -0
  29. package/Development/_templates/planned-initiative/release-doc-notes.md +28 -0
  30. package/Development/_templates/planned-initiative/spec.md +37 -0
  31. package/Development/_templates/planned-initiative/testing.md +30 -0
  32. package/Development/_templates/program/README.md +63 -0
  33. package/Development/_templates/program/backlog.md +26 -0
  34. package/Development/_templates/program/context.md +25 -0
  35. package/Development/_templates/program/decisions/ADR-0000-template.md +34 -0
  36. package/Development/_templates/program/planned-initiatives/.gitkeep +1 -0
  37. package/Development/_templates/program/releases/v0_1_0.md +32 -0
  38. package/Development/_templates/program/roadmap.md +27 -0
  39. package/Development/_templates/release-context/README.md +33 -0
  40. package/Development/_templates/release-context/backlog.md +14 -0
  41. package/Development/_templates/release-context/initiatives/.gitkeep +1 -0
  42. package/Development/_templates/release-transition.md +39 -0
  43. package/Development/backlog/README.md +17 -0
  44. package/Development/backlog/items/.gitkeep +0 -0
  45. package/Development/code-anchored-context-structure.md +132 -0
  46. package/Development/code-anchored-context-why.md +80 -0
  47. package/Development/code-anchored-context.html +830 -0
  48. package/Development/current.md +32 -0
  49. package/Development/giving-ai-agents-context-around-code.md +496 -0
  50. package/Development/programs/README.md +27 -0
  51. package/Development/releases/v0_1_0/README.md +33 -0
  52. package/Development/releases/v0_1_0/backlog.md +15 -0
  53. package/Development/releases/v0_1_0/initiatives/.gitkeep +1 -0
  54. package/Development/terminology.md +120 -0
  55. package/Documentation/.order +2 -0
  56. package/Documentation/Welcome.md +43 -0
  57. package/Documentation/_authoring/README.md +45 -0
  58. package/Documentation/_authoring/areas/README.md +16 -0
  59. package/Documentation/_authoring/areas/_template.md +51 -0
  60. package/Documentation/_authoring/terminology.md +40 -0
  61. package/Documentation/_authoring/workflow.md +123 -0
  62. package/Documentation/_templates/area/README.md +20 -0
  63. package/Documentation/_templates/area/features/feature-template.md +29 -0
  64. package/Documentation/releases/index.md +18 -0
  65. package/LICENSE +21 -0
  66. package/README.md +85 -0
  67. package/bin/code-anchored-context.js +558 -0
  68. package/package.json +45 -0
@@ -0,0 +1,30 @@
1
+ # Infrastructure
2
+
3
+ Use this file for future environment shape and infrastructure dependencies
4
+ that are already clear enough to preserve.
5
+
6
+ ## Environment Shape
7
+
8
+ Describe expected resources, services, networks, identity boundaries, storage,
9
+ compute, queues, topics, or runtime hosts.
10
+
11
+ ## Infrastructure As Code
12
+
13
+ | Resource or module | Change | Location | Notes |
14
+ | --- | --- | --- | --- |
15
+ | TBD | TBD | TBD | TBD |
16
+
17
+ ## Configuration And Secrets
18
+
19
+ List expected environment variables, app settings, feature flags, secrets,
20
+ certificates, secret manager references, or secret-rotation needs.
21
+
22
+ ## Environment Dependencies
23
+
24
+ Capture expected dependencies between environments, regions, tenants,
25
+ subscriptions, clusters, accounts, or shared services.
26
+
27
+ ## Compatibility And Migration
28
+
29
+ Describe expected infrastructure compatibility windows, provisioning order,
30
+ migration constraints, or cleanup work.
@@ -0,0 +1,41 @@
1
+ # Interface
2
+
3
+ ## Purpose
4
+
5
+ Describe how humans, clients, APIs, configuration, reports, or tools should
6
+ interact with this future delivery slice.
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,41 @@
1
+ # Operations
2
+
3
+ Use this file only when the planned initiative has actionable runtime,
4
+ support, observability, rollback, or repair implications that are already
5
+ clear enough to preserve.
6
+
7
+ If there is nothing concrete for an agent or engineer to act on, omit this
8
+ file after copying the template or mark it as not applicable. Delivery belongs
9
+ in `delivery.md`; environment shape and IaC belong in `infrastructure.md`.
10
+
11
+ ## Runtime Behavior
12
+
13
+ Describe expected live-system behavior, especially jobs, schedules, queues,
14
+ topics, subscriptions, retries, degraded modes, or runtime compatibility
15
+ constraints.
16
+
17
+ ## Observability And Support Signals
18
+
19
+ Capture expected logs, metrics, traces, dashboards, alerts, health checks,
20
+ support signals, and customer-visible symptoms.
21
+
22
+ ## Failure Modes
23
+
24
+ Describe expected failures, retries, poison-message behavior, timeouts,
25
+ partial outages, degraded modes, and support signals.
26
+
27
+ ## Rollback And Recovery
28
+
29
+ Describe expected recovery constraints. Include whether rollback is likely to
30
+ be safe, whether roll-forward is required, and what state might need repair.
31
+
32
+ ## Data Operations And Repair
33
+
34
+ Capture expected migrations, backfills, cleanups, retention, repair scripts,
35
+ manual support procedures, and validation queries.
36
+
37
+ ## Actionable Tooling
38
+
39
+ List CLIs, scripts, dashboards-as-code, alerts-as-code, or other approved
40
+ automation integrations that agents or engineers may need. If none exists, say
41
+ so explicitly.
@@ -0,0 +1,40 @@
1
+ # Plan
2
+
3
+ Use this file as the working alignment space for future scoped work. 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 planned
9
+ initiative files before the target release becomes current.
10
+
11
+ ## Current Alignment
12
+
13
+ Describe the current agreed future direction.
14
+
15
+ ## Working Notes
16
+
17
+ - Note 1
18
+
19
+ ## Open Questions
20
+
21
+ - Question 1
22
+
23
+ ## Options Considered
24
+
25
+ | Option | Pros | Cons | Status |
26
+ | --- | --- | --- | --- |
27
+ | TBD | TBD | TBD | Open |
28
+
29
+ ## Notes To Promote
30
+
31
+ - [ ] Move settled behavior into `spec.md`
32
+ - [ ] Move settled interface details into `interface.md`
33
+ - [ ] Move settled technical shape into `architecture.md`
34
+ - [ ] Move settled verification strategy into `testing.md`
35
+ - [ ] Move settled delivery and pipeline behavior into `delivery.md`
36
+ - [ ] Move settled environment and IaC context into `infrastructure.md`
37
+ - [ ] Move actionable runtime/support concerns into `operations.md`
38
+ - [ ] Move executable future work into `backlog.md`
39
+ - [ ] Move durable program decisions into the parent program's `decisions/`
40
+ - [ ] Move product-documentation impact into `release-doc-notes.md`
@@ -0,0 +1,28 @@
1
+ # Release Documentation Notes
2
+
3
+ Use this file to capture expected product-documentation impact while future
4
+ work is being planned. When the planned initiative is promoted and later
5
+ implemented, compare these notes 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
+ ## Expected 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 might not
27
+ ship.
28
+
@@ -0,0 +1,37 @@
1
+ # Spec
2
+
3
+ ## Purpose
4
+
5
+ Describe what the future delivery slice should do and why this behavior
6
+ matters.
7
+
8
+ ## Goals
9
+
10
+ - Goal 1
11
+ - Goal 2
12
+
13
+ ## Non-Goals
14
+
15
+ - Non-goal 1
16
+
17
+ ## Behavior
18
+
19
+ Describe the expected behavior in product or domain language. Include:
20
+
21
+ - Normal flow
22
+ - Permission rules
23
+ - Data rules
24
+ - Validation rules
25
+ - Error behavior
26
+ - Edge cases
27
+
28
+ ## Acceptance Criteria
29
+
30
+ - [ ] Criterion 1
31
+ - [ ] Criterion 2
32
+
33
+ ## Dependencies
34
+
35
+ - Related program context, earlier release initiatives, systems, teams,
36
+ services, or decisions.
37
+
@@ -0,0 +1,30 @@
1
+ # Testing
2
+
3
+ Use this file for future verification strategy that is already clear enough to
4
+ preserve before the target release becomes current.
5
+
6
+ ## Test Strategy
7
+
8
+ Describe what the future release initiative will need to prove.
9
+
10
+ ## Automated Coverage
11
+
12
+ | Area | Coverage | Tool or location | Notes |
13
+ | --- | --- | --- | --- |
14
+ | TBD | TBD | TBD | TBD |
15
+
16
+ ## Manual Verification
17
+
18
+ - None identified yet.
19
+
20
+ ## Test Data And Environments
21
+
22
+ Capture required data, fixtures, accounts, or environment assumptions.
23
+
24
+ ## Release Gates
25
+
26
+ - TBD
27
+
28
+ ## Known Gaps
29
+
30
+ - None identified yet.
@@ -0,0 +1,63 @@
1
+ # Program Title
2
+
3
+ Status: Candidate
4
+ Primary area: TBD
5
+
6
+ ## Summary
7
+
8
+ Describe the durable effort, why it exists, and what outcome it is moving
9
+ toward across releases.
10
+
11
+ ## Scope
12
+
13
+ In scope:
14
+
15
+ - TBD
16
+
17
+ Out of scope:
18
+
19
+ - TBD
20
+
21
+ ## Durable Context
22
+
23
+ - `context.md`
24
+ - `roadmap.md`
25
+ - `backlog.md`
26
+ - `decisions/`
27
+ - `planned-initiatives/`
28
+ - `releases/`
29
+
30
+ Optional concern files when they span multiple releases:
31
+
32
+ - `architecture.md`
33
+ - `testing.md`
34
+ - `delivery.md`
35
+ - `infrastructure.md`
36
+ - `operations.md` only when actionable runtime, support, observability,
37
+ rollback, or repair context spans releases.
38
+
39
+ ## Related Release Initiatives
40
+
41
+ | Release | Initiative | Role |
42
+ | --- | --- | --- |
43
+ | `v0_1_0` | TBD | TBD |
44
+
45
+ ## Current State
46
+
47
+ Describe the current status of the program and the next expected release
48
+ slice.
49
+
50
+ ## Planned Initiatives
51
+
52
+ Use `planned-initiatives/` for scoped future delivery slices that belong to
53
+ this program but are not in the current release yet.
54
+
55
+ ## Agent Notes
56
+
57
+ - Keep durable multi-release context here.
58
+ - Use `planned-initiatives/` when future scope is clear enough to preserve as
59
+ a scoped delivery slice before the target release becomes current.
60
+ - Keep release-scoped implementation history in the relevant release
61
+ initiative.
62
+ - Use `Development/backlog/items/` for isolated deferred items that do not
63
+ need a program.
@@ -0,0 +1,26 @@
1
+ # Program Backlog
2
+
3
+ This backlog holds future work that belongs to the program as a durable
4
+ multi-release effort.
5
+
6
+ Use `Development/backlog/items/` instead for isolated deferred work that does
7
+ not need program-level context.
8
+
9
+ Use `planned-initiatives/` instead when future work is already clear enough
10
+ to preserve as a scoped delivery slice for a target release.
11
+
12
+ ## Candidates
13
+
14
+ | Status | Item | Notes |
15
+ | --- | --- | --- |
16
+ | Candidate | TBD | TBD |
17
+
18
+ ## Deferred
19
+
20
+ - None yet.
21
+
22
+ ## Promoted To Release Initiatives
23
+
24
+ | Item | Release initiative | Notes |
25
+ | --- | --- | --- |
26
+ | TBD | TBD | TBD |
@@ -0,0 +1,25 @@
1
+ # Context
2
+
3
+ ## Problem
4
+
5
+ Describe the durable problem or opportunity this program addresses.
6
+
7
+ ## Background
8
+
9
+ Capture history, constraints, previous attempts, related initiatives, and
10
+ important product or technical context.
11
+
12
+ ## Stakeholders And Areas
13
+
14
+ | Area or stakeholder | Relevance |
15
+ | --- | --- |
16
+ | TBD | TBD |
17
+
18
+ ## Durable Principles
19
+
20
+ - Principle 1
21
+
22
+ ## Links
23
+
24
+ - Related initiatives, backlog items, ADRs, PRs, tickets, or discussions.
25
+
@@ -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 durable program-level problem, constraints, and options.
9
+
10
+ ## Decision
11
+
12
+ State the decision clearly.
13
+
14
+ ## Consequences
15
+
16
+ Positive:
17
+
18
+ - Consequence 1
19
+
20
+ Negative or tradeoffs:
21
+
22
+ - Tradeoff 1
23
+
24
+ ## Alternatives Considered
25
+
26
+ | Alternative | Why not |
27
+ | --- | --- |
28
+ | TBD | TBD |
29
+
30
+ ## Links
31
+
32
+ - Related program files, release initiatives, backlog items, PRs, tickets,
33
+ or discussions.
34
+
@@ -0,0 +1,32 @@
1
+ # v0.1.0 Program Slice
2
+
3
+ ## Release Initiative
4
+
5
+ Link to the release-scoped initiative when one exists:
6
+
7
+ ```text
8
+ Development/releases/v0_1_0/initiatives/<initiative-slug>/
9
+ ```
10
+
11
+ ## Scope
12
+
13
+ Describe the slice of the program intended for this release.
14
+
15
+ ## Outcome
16
+
17
+ Describe what shipped, what was deferred, and what should carry forward.
18
+
19
+ ## Planned Initiatives Promoted
20
+
21
+ List planned initiatives from this program that were promoted into this
22
+ release.
23
+
24
+ | Planned initiative | Release initiative | Notes |
25
+ | --- | --- | --- |
26
+ | TBD | TBD | TBD |
27
+
28
+ ## Links
29
+
30
+ - Initiative:
31
+ - Backlog items:
32
+ - ADRs:
@@ -0,0 +1,27 @@
1
+ # Roadmap
2
+
3
+ This roadmap describes expected phases across releases. It is directional,
4
+ not a promise that every phase will ship exactly as written.
5
+
6
+ ## Phases
7
+
8
+ | Phase | Target release | Outcome | Status |
9
+ | --- | --- | --- | --- |
10
+ | Phase 1 | TBD | TBD | Candidate |
11
+ | Phase 2 | TBD | TBD | Candidate |
12
+
13
+ ## Release Slices
14
+
15
+ | Release | Initiative | Scope | Notes |
16
+ | --- | --- | --- | --- |
17
+ | `v0_1_0` | TBD | TBD | TBD |
18
+
19
+ ## Planned Initiatives
20
+
21
+ | Target release | Planned initiative | Scope | Status |
22
+ | --- | --- | --- | --- |
23
+ | TBD | TBD | TBD | Planned |
24
+
25
+ ## Risks And Dependencies
26
+
27
+ - Risk or dependency 1
@@ -0,0 +1,33 @@
1
+ # vNEXT Development Context
2
+
3
+ This folder contains development context for the `vNEXT` release.
4
+
5
+ ## Navigation
6
+
7
+ - `backlog.md` tracks release-level work that has not yet been moved into
8
+ an initiative or that summarizes initiative progress.
9
+ - `initiatives/` contains initiative folders.
10
+
11
+ ## Initiative Rule
12
+
13
+ Create an initiative when work is non-trivial, behavior-changing,
14
+ cross-project, release-significant, or likely to need future product
15
+ documentation.
16
+
17
+ Use `Development/_templates/initiative/` as the starting point.
18
+
19
+ ## Carry-Forward Rule
20
+
21
+ If an initiative is part of a larger phased effort, link it to a program
22
+ under `Development/programs/`.
23
+
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
26
+ originating initiative.
27
+
28
+ ## Planned Initiative Promotion
29
+
30
+ When this release becomes current, promote matching planned initiatives from
31
+ `Development/programs/*/planned-initiatives/` into this release's
32
+ `initiatives/` folder. Leave the planned initiative in place as historical
33
+ planning context and update its status to `Promoted`.
@@ -0,0 +1,14 @@
1
+ # vNEXT Backlog
2
+
3
+ This file tracks release-level development context that is not yet captured
4
+ by an initiative, plus a short summary of initiative progress once
5
+ initiatives exist.
6
+
7
+ ## Loose Candidates
8
+
9
+ No backlog items recorded yet.
10
+
11
+ ## Initiative Summary
12
+
13
+ No initiatives registered yet.
14
+
@@ -0,0 +1,39 @@
1
+ # Release Transition Checklist
2
+
3
+ Use this checklist when changing `Development/current.md` to a new current
4
+ release.
5
+
6
+ Target release: vNEXT
7
+
8
+ ## Steps
9
+
10
+ - [ ] Update `Development/current.md` to the target release.
11
+ - [ ] Create `Development/releases/<target-release>/` from
12
+ `Development/_templates/release-context/` if it does not exist.
13
+ - [ ] Create `README.md`, `backlog.md`, and `initiatives/` for the target
14
+ release if missing.
15
+ - [ ] Scan `Development/programs/*/planned-initiatives/*/README.md` for
16
+ `Target release: <target-release>`.
17
+ - [ ] For each matching planned initiative, materialize it into:
18
+
19
+ ```text
20
+ Development/releases/<target-release>/initiatives/<initiative-slug>/
21
+ ```
22
+
23
+ - [ ] Update the promoted release initiative so it links back to the parent
24
+ program and planned initiative.
25
+ - [ ] Update the planned initiative metadata:
26
+
27
+ ```md
28
+ Status: Promoted
29
+ Promoted to: `Development/releases/<target-release>/initiatives/<initiative-slug>/`
30
+ Promoted on: YYYY-MM-DD
31
+ ```
32
+
33
+ - [ ] Update the parent program `README.md`, `roadmap.md`, `backlog.md`, or
34
+ `releases/<target-release>.md` as needed.
35
+ - [ ] Leave the planned initiative in place as historical planning context.
36
+
37
+ ## Rule
38
+
39
+ Planned initiatives are promoted, not moved silently.
@@ -0,0 +1,17 @@
1
+ # Development Backlog
2
+
3
+ This folder stores isolated deferred work that was cut from a release
4
+ initiative but should remain discoverable.
5
+
6
+ Use a backlog item when:
7
+
8
+ - the work came from a real initiative or implementation discussion
9
+ - it is useful enough to preserve
10
+ - it does not need durable program-level context
11
+ - it is not active in the current release
12
+
13
+ Create items from `Development/_templates/backlog-item.md` and place them in
14
+ `Development/backlog/items/`.
15
+
16
+ When a backlog item is picked up later, do not move or rewrite the original
17
+ item. Mark it as `Promoted` and link to the new release initiative.
File without changes