@sabaiway/agent-workflow-engine 1.4.0 → 1.5.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/CHANGELOG.md CHANGED
@@ -4,6 +4,23 @@ All notable changes to the methodology engine. Versions are this **package's** n
4
4
  they are distinct from the **deployment-lineage** stamp written into a project's `docs/ai/`
5
5
  (which tracks the shared `agent-workflow` lineage, head `1.3.0`).
6
6
 
7
+ ## 1.5.0 — Right-altitude & code-grounded folds in the canon
8
+
9
+ A **feature** release. The planning canon (`references/planning.md`, read **live** by the composition
10
+ root) gains a `## 9. Right-altitude & code-grounded folds` section + a §8 self-review bullet; the
11
+ activity-procedures canon (`references/procedures.md`) weaves a terse §9 review-lens pointer into the
12
+ rendered Self-review steps of **both** activities (binding to §9, not restating it). Two guards pin the
13
+ disciplines: a new `test/planning-canon.test.mjs` and an extended `test/procedures-canon.test.mjs`. The
14
+ deployment-lineage head stays **`1.3.0`** (no `docs/ai` structural change); the npm package version is a
15
+ separate axis.
16
+
17
+ - **Right altitude.** A plan pins intent + architecture + invariants + acceptance criteria; fine
18
+ code-mechanics are resolved at Execute, not spelled out in prose.
19
+ - **Fold by code, not prose.** Before folding a code-touching finding, read the cited `file:line` and cite it.
20
+ - **Convergence heuristic.** A stable architecture + recurring code-mechanism findings ⇒ raise the
21
+ altitude or hand the mechanics to Execute.
22
+ - The procedures lens stays a terse pointer (the terseness invariant holds: `procedures.md` < `planning.md`).
23
+
7
24
  ## 1.4.0 — Durable session contracts in the canon: read-at-start, Definition of Done, communication
8
25
 
9
26
  A **feature** release. The activity-procedures canon (`references/procedures.md`, read **live** by the
package/SKILL.md CHANGED
@@ -3,7 +3,7 @@ name: agent-workflow-engine
3
3
  description: Canonical home of the agent-workflow planning methodology — the Plan→Phase→Step→Substep vocabulary, plan lifecycle, queue.md series index, mandatory Cleanup phase, the bounded methodology slot fragment, the orchestration-recipe vocabulary (Solo / Reviewed / Council / Delegated), and the activity-procedures canon (plan-authoring / plan-execution, with typed recipe slots). A published, installable npm package (available:true) that *provides* the methodology text; it mutates nothing. The composition root (agent-workflow-kit) reads this canon LIVE from the installed engine and injects the bounded slots from it — one source of truth, no bundled mirror; `npx @sabaiway/agent-workflow-kit@latest init` installs the engine.
4
4
  disable-model-invocation: true
5
5
  metadata:
6
- version: '1.4.0'
6
+ version: '1.5.0'
7
7
  ---
8
8
 
9
9
  # agent-workflow-engine
package/capability.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "schema": 1,
4
4
  "name": "agent-workflow-engine",
5
5
  "kind": "methodology-engine",
6
- "version": "1.4.0",
6
+ "version": "1.5.0",
7
7
  "available": true,
8
8
  "provides": ["plan"],
9
9
  "roles": {},
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sabaiway/agent-workflow-engine",
3
- "version": "1.4.0",
3
+ "version": "1.5.0",
4
4
  "description": "Canonical home of the agent-workflow planning methodology — the Plan→Phase→Step vocabulary, plan lifecycle, queue.md series index, and mandatory Cleanup phase, consumed by the kit (composition root). The methodology engine of the agent-workflow family.",
5
5
  "keywords": [
6
6
  "ai-agents",
@@ -103,3 +103,14 @@ The volume trigger above (files / LoC / tokens) is necessary but not sufficient.
103
103
  - Vocabulary is strict (§1); the Plan ends with **Phase N: Cleanup** (§4).
104
104
  - If part of a series: `queue.md` is initialised / updated (§3).
105
105
  - No `git add <plan>` and no "commit the plan" wording in the final report.
106
+ - Every code-touching decision cites the `file:line` it is grounded in; the plan stays at intent / invariant / acceptance altitude, leaving fine code-mechanics to Execute (§9).
107
+
108
+ ## 9. Right-altitude & code-grounded folds
109
+
110
+ Two disciplines keep a plan converging instead of churning. They govern authoring, every review round, and execution.
111
+
112
+ **Right altitude.** A plan pins *intent + architecture + invariants + acceptance criteria* — the named tests that must stay green and the new tests that must pass. It does NOT spell out fine code-mechanics in prose: those are resolved in code at Execute (against the real files + the per-Step review + the gates), where prose cannot diverge from reality. Most "blockers" that resurface across review rounds are code-level details that never belonged in a prose plan.
113
+
114
+ **Fold by code, not prose.** Before folding any code-touching finding into the plan, READ the cited `file:line`; the fold cites it. A fold grounded in prose alone drifts from the code and seeds the next bug.
115
+
116
+ **Convergence heuristic.** When a review round keeps finding code-mechanism issues on a stable architecture, STOP refining prose — either raise the spec to invariant + acceptance altitude, or hand the mechanics to Execute. Do not re-litigate code mechanics in the plan.
@@ -48,6 +48,8 @@ Produce a self-contained, cold-readable plan, reviewed to the configured depth b
48
48
  with exact paths and commands per Step. Bind to that structure; do not restate it here.
49
49
  3. **Self-review** — run the [`planning.md`](planning.md) §8 checklist (exact paths/commands, strict
50
50
  vocabulary, every out-of-plan recommendation folded into a Step, `queue.md` updated for a series).
51
+ Apply the [`planning.md`](planning.md) §9 lens — fold by code (read and cite the `file:line`), and
52
+ hold the right altitude.
51
53
  4. **review {recipe}** — review the draft at the depth the resolved `review` recipe selects: Solo
52
54
  (self-review only), Reviewed (one backend reviews), or Council (both backends review, you
53
55
  synthesize). The kit resolves the effective recipe from `docs/ai/orchestration.json` + readiness.
@@ -74,7 +76,9 @@ Execute an approved plan Step by Step; each Step is one logical commit.
74
76
  directly.
75
77
  3. **Implement / integrate** — apply the change (your own edits, or the reviewed delegated diff),
76
78
  following the project's reuse + clean-code rules.
77
- 4. **Self-review** — run the [`planning.md`](planning.md) §8 self-review on the change.
79
+ 4. **Self-review** — run the [`planning.md`](planning.md) §8 self-review on the change, applying the
80
+ [`planning.md`](planning.md) §9 lens — fold by code (read and cite the `file:line`), and hold the
81
+ right altitude.
78
82
  5. **review {recipe}** — review the result at the resolved `review` depth (Solo / Reviewed / Council),
79
83
  exactly as in plan-authoring.
80
84
  6. **Gates** — run the project's verification gate (tests + checks) to green before committing.