Skip to content

bounded-loop.md

Latest commit

 

History

History
30 lines (22 loc) · 1.03 KB

bounded-loop.md

File metadata and controls

30 lines (22 loc) · 1.03 KB
Raw

Example: Bounded Documentation Loop

Goal

Make a CLI quick start executable by a new contributor.

Contract

  • Inputs: README, install script, and current CLI help.
  • Non-goals: package publishing, dependency upgrades, and release tagging.
  • Verifier: run every documented quick-start command in a temporary directory.
  • State: one short iteration record in the working note.
  • Stop: pass, three iterations, or two no-progress failures.
  • Approval boundary: credentials, package registry writes, or changes outside the repo.

Iteration

objective: executable quick start
iteration: 1
changed: corrected the install target and added the missing list command
verification: temp install passed; example invocation failed because the documented skill name was stale
failed_or_weak: example name mismatch
next: update the example and rerun the same verifier
blockers: none

Completion

The loop ends only when the documented commands run successfully from a clean temporary directory. A Markdown review alone is not the verifier.