Skip to content

Commit 262d498

Browse files
committed
CIP-0002: add backlog tasks for material review
Create initial tasks for inventories, snippet freshness reporting, chapter cross-checking, and reusable tooling.
1 parent 2832621 commit 262d498

4 files changed

Lines changed: 147 additions & 0 deletions
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
category: documentation
3+
created: "2026-01-28"
4+
id: 2026-01-28_execed-material-review-chapter-crosscheck
5+
last_updated: "2026-01-28"
6+
owner: Neil D. Lawrence
7+
priority: Medium
8+
related_cips:
9+
- "0002"
10+
status: Proposed
11+
tags:
12+
- execed
13+
- material-review
14+
- atomic-human
15+
title: "Material review: cross-check sessions vs book chapters"
16+
---
17+
18+
# Task: Material review — cross-check sessions vs book chapters
19+
20+
## Description
21+
22+
Cross-check the ExecEd session framing against `~/lawrennd/the-atomic-human/_chapters/`:
23+
24+
- For each session (1–7), list intended chapter anchors and confirm key takeaways are represented.
25+
- Identify gaps (chapter ideas relevant to a session but missing in the lecture/snippets).
26+
- Identify redundancies (same chapter point repeated across sessions without purpose).
27+
28+
## Acceptance Criteria
29+
30+
- [ ] A session-by-session table exists: session → chapter anchors → “covered / partial / missing”.
31+
- [ ] A short list of “highest value additions” exists (by session).
32+
- [ ] Proposed changes are expressed as candidate snippet swaps/additions (not lecture edits yet).
33+
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
category: documentation
3+
created: "2026-01-28"
4+
id: 2026-01-28_execed-material-review-inventory
5+
last_updated: "2026-01-28"
6+
owner: Neil D. Lawrence
7+
priority: High
8+
related_cips:
9+
- "0002"
10+
status: Proposed
11+
tags:
12+
- execed
13+
- material-review
14+
- snippets
15+
title: "Material review: build inventories (lectures, talks, snippets)"
16+
---
17+
18+
# Task: Material review — build inventories (lectures, talks, snippets)
19+
20+
## Description
21+
22+
Create the repeatable “inventory layer” for CIP-0002:
23+
24+
- Parse `execed/_lamd/*.md` to extract `\include{...}` usage per session.
25+
- Parse recent talks (at least `~/lawrennd/talks/_atomic-human/`, `_business/`, `_policy/`, `_economics/`) to extract snippet usage since a cutoff date (default `2024-06-01`).
26+
- Produce machine-readable outputs (JSON/CSV) suitable for reuse in future reviews.
27+
28+
## Acceptance Criteria
29+
30+
- [ ] We can answer “which snippets does ExecEd use?” (session → includes, include → sessions).
31+
- [ ] We can answer “which talks use these snippets since 2024-06-01?” (include → talks, talk → includes).
32+
- [ ] Outputs are written to a deterministic location (e.g. `backlog/artifacts/` or similar) and can be regenerated.
33+
34+
## Notes
35+
36+
- Backlog items should link to CIPs (HOW), not requirements (WHAT).
37+
- This task is intentionally “inventory only” — recommendations and refresh proposals come in follow-on tasks.
38+
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
category: documentation
3+
created: "2026-01-28"
4+
id: 2026-01-28_execed-material-review-snippet-freshness
5+
last_updated: "2026-01-28"
6+
owner: Neil D. Lawrence
7+
priority: High
8+
related_cips:
9+
- "0002"
10+
status: Proposed
11+
tags:
12+
- execed
13+
- material-review
14+
- snippets
15+
- git
16+
title: "Material review: snippet freshness report (git-based)"
17+
---
18+
19+
# Task: Material review — snippet freshness report (git-based)
20+
21+
## Description
22+
23+
Using the inventories from CIP-0002, compute snippet “freshness”:
24+
25+
- For each referenced snippet, find last-change date (git history) and last commit message.
26+
- Flag stale snippets (e.g. older than a configurable threshold such as 12 months) and high-churn snippets (recently changing frequently).
27+
- Produce a ranked list combining **usage frequency** (ExecEd + recent talks) with **staleness/churn** so we can prioritise refresh work.
28+
29+
## Acceptance Criteria
30+
31+
- [ ] A report exists listing snippet path → last updated date → last commit message.
32+
- [ ] A “top candidates for refresh” list exists with rationale (high-impact + stale, or high-impact + unstable).
33+
- [ ] Results are reproducible (one command/script regenerates them).
34+
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
category: features
3+
created: "2026-01-28"
4+
id: 2026-01-28_execed-material-review-tooling
5+
last_updated: "2026-01-28"
6+
owner: Neil D. Lawrence
7+
priority: Medium
8+
related_cips:
9+
- "0002"
10+
status: Proposed
11+
tags:
12+
- execed
13+
- material-review
14+
- tooling
15+
- lamd
16+
title: "Material review tooling: scripts now, upstream to lamd later"
17+
---
18+
19+
# Task: Material review tooling — scripts now, upstream to `lamd` later
20+
21+
## Description
22+
23+
Create reusable tooling to run the CIP-0002 inventories repeatedly and share them with others.
24+
25+
Phase 1 (ExecEd-local):
26+
27+
- Add scripts under `execed/scripts/` that generate:
28+
- snippet usage inventory for a target directory (lectures, talks)
29+
- snippet freshness report from git history
30+
- a markdown summary report + JSON/CSV artifacts
31+
32+
Phase 2 (Upstream design):
33+
34+
- Identify which commands should become `lamd` tooling (e.g. a subcommand or helper CLI).
35+
- Draft the interface (inputs, outputs, flags like `--since`, `--scope`, `--format json/csv/md`).
36+
37+
## Acceptance Criteria
38+
39+
- [ ] A new script entrypoint exists for running the inventories end-to-end.
40+
- [ ] Outputs are stable and suitable for long-term reuse (machine-readable + human report).
41+
- [ ] A short upstream proposal is written (what should land in `lamd`, with CLI shape).
42+

0 commit comments

Comments
 (0)