diff --git a/labs/12-product-engineering-loop/boatstack-distribution/README.md b/labs/12-product-engineering-loop/boatstack-distribution/README.md index a3f972342..8a70e76e6 100644 --- a/labs/12-product-engineering-loop/boatstack-distribution/README.md +++ b/labs/12-product-engineering-loop/boatstack-distribution/README.md @@ -8,24 +8,48 @@

Build freely. Prove it. Ship.

-## A delivery harness for AI coding agents +## Keep your software delivery process when you change coding agents -An AI coding agent will guess a product decision, call the work "done" on one green check, and lose the reasoning the moment you change tools. Boatstack connects the work from an idea to a reviewed PR so none of that slips: the plan, decisions, gaps, tests, review findings, and project context stay connected along the way. Keep using Cursor, Codex, Claude Code, or Gemini CLI, with the models and specialist skills that fit the work. +Boatstack is a repository-local delivery harness for Cursor, Codex, Claude Code, and Gemini CLI. -The agent remains free to build. Before it says the work is done, Boatstack asks for the approval, tests, review, and recorded evidence appropriate to the change. +AI coding agents can write code quickly, but each tool brings its own planning flow, session state, and definition of “done.” Change agents and your delivery process often disappears with the chat. -**Your product development flow stays with the repository—not the coding agent.** Change tools without rebuilding how you ship or redefining what “done” means. Boatstack carries the workflow and saved project state—not an agent's private chat history or a command already in progress. +Boatstack keeps the delivery process in the repository. Plans, product decisions, tests, review findings, accepted gaps, and completion evidence stay connected from idea to pull request, regardless of which agent or model performs the work. Use Cursor, Codex, Claude Code, or Gemini CLI. Boatstack keeps the same approval, testing, review, and shipping boundaries across them. + +**Your product development flow stays with the repository, not the coding agent.** Change agents, models, or specialist skills without rebuilding how your team plans, verifies, reviews, and ships software. + +The coding agent executes the work. Boatstack supervises the delivery. Your repository owns the policy and evidence.

Change the tools, keep the flow: coding agents, models, and specialist skills feed one repository-owned Boatstack flow that produces a reviewed pull request and useful context for the next feature

-| You change | Boatstack keeps | +| You change | You keep | |---|---| -| Cursor, Codex, Claude Code, or Gemini CLI | The same path from planning through PR preparation | -| Lower-cost, general, or frontier model | The same approval, testing, and review requirements | -| React guidance, gstack, Spec Kit, or another skill | Human approval and evidence remain authoritative | -| Session, worktree, or feature | Durable decisions, gaps, evidence, and code state in the repository | +| Cursor, Codex, Claude Code, or Gemini CLI | The same path from approved plan to reviewed PR | +| Lower-cost, general, or frontier model | The same definition of done and proof requirements | +| React guidance, gstack, Spec Kit, or another skill | Human product decisions remain authoritative | +| Session, worktree, or feature | Decisions, open gaps, evidence, and verified delivery state | + +## How it works + +1. Save a plan in your coding agent. +2. Boatstack validates the plan and pauses for material product decisions. +3. The agent builds freely inside the approved scope. +4. Boatstack checks the promised outcomes against tests and evidence. +5. Review findings, risks, and accepted gaps become a focused PR brief. +6. The resulting context stays in the repository for the next feature. + +## Each delivery makes the next one easier + +Boatstack does not preserve an agent's private reasoning or replay old chats. It keeps the durable parts of delivery: +- approved product decisions +- unresolved gaps +- validation evidence +- review findings +- verified repository state + +That means the next feature starts from recorded project knowledge instead of reconstructing intent from another agent session. ## Install with your coding agent @@ -76,7 +100,16 @@ Invoke `/repair` in Claude Code, Cursor, or Gemini CLI, or `$boatstack repair` i Receipts remain as history; published corrections become linked deliveries. -## Features +## What you get + +- **Change coding agents without changing how you ship.** +- **Resume work without reconstructing the previous chat.** +- **Stop agents from guessing material product decisions.** +- **Require evidence for every outcome the change claims to deliver.** +- **Create reviewer-ready PRs from the actual scope, changes, risks, and validation.** + +
+Technical Features - **A guided path from idea to PR.** `/auto-plan` starts a one-action-at-a-time delivery flow. - **Instant orientation after a break.** `boatstack next` reconstructs the verified stage without treating chat or a running process as workflow evidence, so you resume in seconds instead of re-reading history. @@ -90,6 +123,8 @@ Receipts remain as history; published corrections become linked deliveries. - **Portable across your AI stack.** Hosts, models, and skills share one repository-owned delivery contract. - **Repository-friendly maintenance.** Worktrees restore runtime; updates stay in separate infrastructure PRs. +
+ ### Optional changelog It is disabled by default. Enable it in `.boatstack-project.json`: @@ -123,9 +158,9 @@ Boatstack is a repository-local delivery harness. This does not mean every model performs equally. [See the evidence and paired evaluation design](docs/why-these-steps.md#model-choice-and-budget). -## Why these steps? +## Built from failures observed in real coding work -They derive from coding failures observed in benchmark and product work—not guesses. Each link explains what happened, what Boatstack does, and whether that behavior has actually been tested. +They derive from coding failures observed in benchmark and product work—not guesses. When a failure reveals a reusable delivery problem rather than a project-specific mistake, Boatstack turns it into a boundary future runs can enforce. Each link explains what happened, what Boatstack does, and whether that behavior has actually been tested. | What happened | What Boatstack does | Current evidence | |---|---|---| diff --git a/labs/12-product-engineering-loop/boatstack-distribution/release-notes/2026-07-21-value-translation-readme.md b/labs/12-product-engineering-loop/boatstack-distribution/release-notes/2026-07-21-value-translation-readme.md new file mode 100644 index 000000000..f4c2e207e --- /dev/null +++ b/labs/12-product-engineering-loop/boatstack-distribution/release-notes/2026-07-21-value-translation-readme.md @@ -0,0 +1,6 @@ +### Restructure README for faster value comprehension + +- **Outcome-focused hero:** Replaces mechanism-first opening with a clear explanation of what happens to a delivery process when coding agents change. +- **Portability consequences:** Updates the portability table to describe retained operational value (e.g., "The same path from approved plan to reviewed PR") instead of just artifacts. +- **Explicit compounding:** Adds a section explaining how retained durable artifacts make the next feature easier to start without reconstructing intent from chat. +- **Reordered content:** Moves technical feature lists and installation instructions below the primary outcomes to respect evaluator attention. diff --git a/labs/12-product-engineering-loop/tests/test_product_loop.py b/labs/12-product-engineering-loop/tests/test_product_loop.py index 27f003ffa..ae57996e7 100644 --- a/labs/12-product-engineering-loop/tests/test_product_loop.py +++ b/labs/12-product-engineering-loop/tests/test_product_loop.py @@ -678,13 +678,13 @@ def test_boatstack_is_a_reproducible_upstream_projection(self) -> None: readme = (repo / "README.md").read_text() self.assertEqual(readme, (DISTRIBUTION / "README.md").read_text()) self.assertIn("Build freely. Prove it. Ship.", readme) - self.assertIn("A delivery harness for AI coding agents", readme) - self.assertIn("Your product development flow stays with the repository", readme) - self.assertIn("Change tools without rebuilding how you ship", readme) - self.assertIn("The agent remains free to build", readme) + self.assertIn("Keep your software delivery process when you change coding agents", readme) + self.assertIn("Your product development flow stays with the repository, not the coding agent.", readme) + self.assertIn("Change agents, models, or specialist skills without rebuilding how your team plans", readme) + self.assertIn("Boatstack keeps the delivery process in the repository.", readme) self.assertIn("coding failures observed", readme) self.assertIn("whether that behavior has actually been tested", readme) - self.assertLessEqual(len(readme.split()), 1700) + self.assertLessEqual(len(readme.split()), 2000) self.assertNotRegex(readme, r"\{\{[A-Z][A-Z0-9_]*\}\}") self.assertLess( readme.index("assets/boatstack-portability.svg"), @@ -700,11 +700,11 @@ def test_boatstack_is_a_reproducible_upstream_projection(self) -> None: ) self.assertLess( readme.index("assets/boatstack-journey.svg"), - readme.index("## Features"), + readme.index("## What you get"), ) self.assertLess( - readme.index("## Features"), - readme.index("## Why these steps?"), + readme.index("## What you get"), + readme.index("## Built from failures observed in real coding work"), ) agent_prompt = ( "Install Boatstack in this repository from " @@ -740,8 +740,8 @@ def test_boatstack_is_a_reproducible_upstream_projection(self) -> None: self.assertIn("Quality uplift evaluation in progress", readme) self.assertIn("does not mean every model performs equally", readme.lower()) self.assertIn("same model, task, and budget", readme) - self.assertIn("not an agent's private chat history", readme) - self.assertIn("a command already in progress", readme) + self.assertIn("preserve an agent's private reasoning or replay old chats", readme) + self.assertIn("keeps the durable parts of delivery", readme) self.assertNotIn("seamless", readme.lower()) self.assertNotRegex(readme.lower(), r"\b(proven|optimal|guaranteed)\b") self.assertNotIn("lower-cost models perform as well", readme.lower())