Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- **`git cas agent vault rotate`** — added a machine-facing vault passphrase rotation flow so Relay can rotate encrypted vault state with explicit commit, KDF, and rotated/skipped-entry results.
- **`git cas agent vault init|remove`** — added machine-facing vault lifecycle commands so Relay can initialize encrypted or plaintext vaults and remove entries without scraping human CLI output.
- **Docs maintainer checklist** — added [docs/DOCS_CHECKLIST.md](./docs/DOCS_CHECKLIST.md) as the short pre-review pass for doc-heavy branches, covering boundary clarity, canonical-source links, index hygiene, and empty-state wording discipline.
- **Planning-index consistency review** — added an explicit planning-surface review to [docs/DOCS_CHECKLIST.md](./docs/DOCS_CHECKLIST.md) and [WORKFLOW.md](./WORKFLOW.md), defining when to verify backlog, design, archive, and legend alignment.
- **Benchmark baselines doc** — added [docs/BENCHMARKS.md](./docs/BENCHMARKS.md) with the first published chunking baseline, including fixed-size versus CDC throughput, dedupe reuse results, and refresh instructions.
- **Threat model doc** — added [docs/THREAT_MODEL.md](./docs/THREAT_MODEL.md) as the canonical statement of attacker models, trust boundaries, exposed metadata, and explicit non-goals.
- **Workflow model** — added [WORKFLOW.md](./WORKFLOW.md), explicit legends/backlog/invariants directories, and a cycle-first planning model for fresh work.
Expand Down
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,9 @@ If the answer is unclear, the work probably belongs in
Before opening a doc-heavy pull request, run the short maintainer pass in
[docs/DOCS_CHECKLIST.md](./docs/DOCS_CHECKLIST.md).

If the branch touches planning surfaces, include the planning-index review in
that checklist pass.

## Directory Model

New planning work uses:
Expand Down
22 changes: 22 additions & 0 deletions WORKFLOW.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,28 @@ of the workflow, not optional cleanup.

If a file moves lifecycle state, update the relevant indexes in the same change.

### Planning Index Consistency Review

Run a planning-index consistency review whenever a branch:

- changes backlog, design, archive, or legend indexes
- moves a backlog card between live and archived state
- closes a cycle and prepares the merged post-merge truth state
- discovers drift on `main`

This does not need a fixed calendar cadence. Run it when planning surfaces
change and as a Truth maintenance pass when drift is found.

The minimum review must confirm:

- the live backlog only lists pending, in-cycle, or unresolved follow-on work
- landed cycle docs are represented in `docs/design/`
- archived backlog history matches delivered or retired cards
- legend summaries agree with the current backlog and design surfaces
- empty-state wording stays consistent with the existing house style, such as
`- none currently` in [docs/design/README.md](./docs/design/README.md),
instead of inventing a new empty-list phrase for the same condition

## Cycle Workflow

1. Design docs first, using the human and agent IBM Design Thinking passes.
Expand Down
1 change: 0 additions & 1 deletion docs/BACKLOG/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ Current backlog items:
- [TR-007 — Security Doc Discoverability Audit](./TR-007-security-doc-discoverability-audit.md)
- [TR-008 — Empty-State Phrasing Consistency](./TR-008-empty-state-phrasing-consistency.md)
- [TR-009 — Pre-PR Doc Cross-Link Audit](./TR-009-pre-pr-doc-cross-link-audit.md)
- [TR-010 — Planning Index Consistency Review](./TR-010-planning-index-consistency-review.md)
- [TR-011 — Streaming Encrypted Restore](./TR-011-streaming-encrypted-restore.md)

Archived delivered backlog items:
Expand Down
23 changes: 22 additions & 1 deletion docs/DOCS_CHECKLIST.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,25 @@ truth and discoverability failures that keep surfacing late in review.
If a summary doc repeats claims that are already maintained elsewhere, reduce
it to a short summary plus a link instead of maintaining two full narratives.

## Planning Index Review

Run this extra pass whenever a branch changes:

- `docs/BACKLOG/README.md`
- `docs/design/README.md`
- `docs/archive/BACKLOG/README.md`
- a legend's current-cycle summary
- a backlog card's lifecycle state

Confirm all of the following before review:

- live backlog entries are still pending, in cycle, or carrying unresolved
follow-on work
- landed cycle docs are represented in `docs/design/`
- archived backlog history reflects moved or retired backlog cards
- legend summaries agree with the current backlog and design surfaces
- empty-state wording does not introduce a new house style accidentally

## Use It On These Files

This checklist is most useful when a change touches files like:
Expand All @@ -42,7 +61,9 @@ This checklist is most useful when a change touches files like:
- [docs/THREAT_MODEL.md](./THREAT_MODEL.md)
- [docs/BENCHMARKS.md](./BENCHMARKS.md)
- planning indexes under [`docs/BACKLOG/`](./BACKLOG/README.md),
[`docs/design/`](./design/README.md), and [`docs/legends/`](./legends/README.md)
[`docs/design/`](./design/README.md),
[`docs/archive/BACKLOG/`](./archive/BACKLOG/README.md), and
[`docs/legends/`](./legends/README.md)

## Exit Criteria

Expand Down
2 changes: 2 additions & 0 deletions docs/archive/BACKLOG/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,5 @@ Landed archived backlog items:
- landed as [TR-004 — Truth: Design Doc Lifecycle](../../design/TR-004-design-doc-lifecycle.md)
- [TR-006 — Docs Maintainer Checklist](./TR-006-docs-maintainer-checklist.md)
- landed as [TR-006 — Truth: Docs Maintainer Checklist](../../design/TR-006-docs-maintainer-checklist.md)
- [TR-010 — Planning Index Consistency Review](./TR-010-planning-index-consistency-review.md)
- landed as [TR-010 — Truth: Planning Index Consistency Review](../../design/TR-010-planning-index-consistency-review.md)
4 changes: 2 additions & 2 deletions docs/archive/BACKLOG/TR-006-docs-maintainer-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Legend

- [TR — Truth](../legends/TR-truth.md)
- [TR — Truth](../../legends/TR-truth.md)

## Why This Exists

Expand Down Expand Up @@ -31,7 +31,7 @@ same doc review hazards from comments.

## Linked Invariants

- [I-001 — Determinism, Trust, And Explicit Surfaces](../invariants/I-001-determinism-trust-and-explicit-surfaces.md)
- [I-001 — Determinism, Trust, And Explicit Surfaces](../../invariants/I-001-determinism-trust-and-explicit-surfaces.md)

## Notes

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Legend

- [TR — Truth](../legends/TR-truth.md)
- [TR — Truth](../../legends/TR-truth.md)

## Why This Exists

Expand All @@ -29,7 +29,7 @@ instead of inferring around index drift.

## Linked Invariants

- [I-001 — Determinism, Trust, And Explicit Surfaces](../invariants/I-001-determinism-trust-and-explicit-surfaces.md)
- [I-001 — Determinism, Trust, And Explicit Surfaces](../../invariants/I-001-determinism-trust-and-explicit-surfaces.md)

## Notes

Expand Down
1 change: 1 addition & 0 deletions docs/design/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ Landed cycle docs:
- [TR-003 — Truth: Benchmark Baselines](./TR-003-benchmark-baselines.md)
- [TR-004 — Truth: Design Doc Lifecycle](./TR-004-design-doc-lifecycle.md)
- [TR-006 — Truth: Docs Maintainer Checklist](./TR-006-docs-maintainer-checklist.md)
- [TR-010 — Truth: Planning Index Consistency Review](./TR-010-planning-index-consistency-review.md)

Archived or retired cycle docs:

Expand Down
157 changes: 157 additions & 0 deletions docs/design/TR-010-planning-index-consistency-review.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
# TR-010 — Truth: Planning Index Consistency Review

## Status

Landed

## Linked Legend

- [TR — Truth](../legends/TR-truth.md)

## Linked Invariants

- [I-001 — Determinism, Trust, And Explicit Surfaces](../invariants/I-001-determinism-trust-and-explicit-surfaces.md)

## Context

The planning model now spans several linked surfaces:

- the live backlog
- landed design history
- archived backlog history
- legend summaries

Those files can drift even when the underlying work is correct. The failure
mode is usually small but costly:

- a landed cycle stays listed in the live backlog
- a legend summary lags the current design surface
- archive state and design state stop matching

The repo already says indexes are part of the workflow. This cycle makes the
review pass explicit enough to run reliably.

## Human Users, Jobs, And Hills

### Users

- maintainers
- contributors closing cycles or moving planning artifacts
- reviewers checking whether planning docs tell the truth

### Jobs

- verify that planning surfaces agree before opening or merging a PR
- catch backlog, design, archive, and legend drift without manual spelunking
- keep the planning model trustworthy without adding ceremony for its own sake

### Hill

A maintainer can run one short planning-index review and know that the backlog,
design, archive, and legend surfaces agree with the real lifecycle state.

## Agent Users, Jobs, And Hills

### Users

- coding agents
- documentation agents
- review agents

### Jobs

- check planning-surface alignment explicitly instead of inferring around drift
- know when a planning-index review is required
- distinguish live work from landed history and archived intent reliably

### Hill

An agent can treat the planning surfaces as one coherent system because the repo
defines both the review triggers and the minimum consistency checks.

## Human Playback

- Is it obvious when a planning-index review must run?
- Does the review stay short enough to use on every cycle-closing PR?
- Does it say exactly what must match across backlog, design, archive, and
legends?

## Agent Playback

- Can an agent tell when a branch must review planning-index consistency?
- Can it enumerate the minimum alignment checks without inventing its own list?
- Does the doctrine stay pragmatic instead of turning into calendar-driven
ceremony?

## Explicit Non-Goals

- no attempt to build automated linting for every planning surface in this cycle
- no requirement for a fixed calendar schedule
- no broad rewrite of unrelated legacy planning artifacts

## Decisions

### Use The Existing Docs Checklist

The planning-index review should live inside
[docs/DOCS_CHECKLIST.md](../DOCS_CHECKLIST.md), not as a separate maintainer
ritual disconnected from the normal docs review pass.

### Define Trigger Conditions In Workflow

[WORKFLOW.md](../../WORKFLOW.md) should say when the planning-index review is
required:

- when a branch changes backlog, design, archive, or legend indexes
- when a backlog card moves lifecycle state
- when a cycle-closing PR is preparing the post-merge truth state
- when drift is discovered on `main`

### Define The Minimum Alignment Matrix

The review should verify, at minimum:

- live backlog items are still pending, in cycle, or carrying unresolved
follow-on work
- landed cycle docs appear in `docs/design/`
- archived backlog history matches landed or retired cards
- legend current-cycle summaries agree with the backlog and design surfaces
- empty-state wording does not invent a new house style accidentally

## Implementation Outline

1. Add this cycle doc.
2. Extend [docs/DOCS_CHECKLIST.md](../DOCS_CHECKLIST.md) with a planning-index
review section and the minimum alignment checks.
3. Update [WORKFLOW.md](../../WORKFLOW.md) and
[CONTRIBUTING.md](../../CONTRIBUTING.md) so the planning-index review is
both required and discoverable from tracked doctrine.
4. Archive the consumed backlog card, update the Truth indexes, and record the
cycle in [CHANGELOG.md](../../CHANGELOG.md).

## Tests To Write First

No new executable tests.

This is a documentation-truth cycle. Verification is:

- direct cross-check of backlog, design, archive, and legend surfaces after the
edits
- formatting validation for touched Markdown files
- whitespace and diff validation

## Risks And Unknowns

- a manual review can still be skipped if contributors ignore the doctrine
- the repo may eventually want automated linting for some of these checks
- legacy historical docs outside the legends model can still drift without
violating this cycle directly

## Retrospective

This is the right follow-through after the earlier Truth cycles.

The workflow already said indexes mattered. What was missing was a clear,
repeatable pass for keeping those indexes aligned when real branches land. The
small drift that showed up on `main` after the previous cycle was exactly the
kind of failure this review is meant to catch quickly.
5 changes: 3 additions & 2 deletions docs/legends/TR-truth.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,14 +76,14 @@ Current Truth design docs:
- [TR-003 — Truth: Benchmark Baselines](../design/TR-003-benchmark-baselines.md)
- [TR-004 — Truth: Design Doc Lifecycle](../design/TR-004-design-doc-lifecycle.md)
- [TR-006 — Truth: Docs Maintainer Checklist](../design/TR-006-docs-maintainer-checklist.md)
- [TR-010 — Truth: Planning Index Consistency Review](../design/TR-010-planning-index-consistency-review.md)

Current Truth backlog items:

- [TR-005 — CasService Decomposition Plan](../BACKLOG/TR-005-casservice-decomposition-plan.md)
- [TR-007 — Security Doc Discoverability Audit](../BACKLOG/TR-007-security-doc-discoverability-audit.md)
- [TR-008 — Empty-State Phrasing Consistency](../BACKLOG/TR-008-empty-state-phrasing-consistency.md)
- [TR-009 — Pre-PR Doc Cross-Link Audit](../BACKLOG/TR-009-pre-pr-doc-cross-link-audit.md)
- [TR-010 — Planning Index Consistency Review](../BACKLOG/TR-010-planning-index-consistency-review.md)
- [TR-011 — Streaming Encrypted Restore](../BACKLOG/TR-011-streaming-encrypted-restore.md)

Truth work under this legend is currently focused on:
Expand All @@ -95,7 +95,8 @@ Truth work under this legend is currently focused on:
- evaluating service decomposition where the current boundary is under strain
- improving documentation review hygiene through a shared maintainer checklist
- improving cross-link discoverability
- keeping planning indexes and empty-state language consistent over time
- running planning-index consistency reviews and keeping empty-state language
consistent over time
- investigating lower-memory restore paths for encrypted and compressed assets

## Explicit Non-Goals
Expand Down
Loading