Generate How-To Skeletons From Signatures, Then Gate README Promises With a Lane File

Description and use

The workflow creates a JSON inventory of public functions, the model drafts only skeletons, and a human signs environment claims via a lane file, ensuring the README contains only verifiable information.

Problem

Drafting models often insert unverified promises into README how‑to docs, leading readers to accept unsupported claims such as incorrect install commands, unsupported extras, or fabricated output examples.

Outcome

The workflow produces README how‑to docs that are free of unverified promises, reducing misinformation and installation errors.

Workflow

• 1. Run a script to walk the source tree and extract public functions, their signatures, and docstring presence into a JSON inventory.
• 2. Commit the inventory file to git and hash it for reference in future README diffs.
• 3. Feed the inventory to the LLM to generate section outlines, parameter tables, and procedure skeletons, leaving TODO(human) markers for steps that require execution.
• 4. Review the draft, identify any claim classes that the inventory cannot prove (e.g., install commands, extras, sample output).
• 5. Use a lane file to forbid the model from filling those claim classes; only human‑signed claims are allowed.
• 6. Sign the required environment claims beside the inventory hash, producing a gated README that contains only verifiable information.

Evidence

An AST walk of public functions can prove names, argument lists, defaults, annotations, and docstring presence.

Source

The fix is not a better prompt. The fix is a lane file that forbids the model from filling claim classes the inventory cannot support.

Source