Skip to content

Step 3 - Understand the draft ​

Goal: judge the draft. The agent drafted it, the check validated its shape - but only you know your repo, so only you can say whether it describes the right things at the right grain.

The questions only you can answer ​

Put them to the agent as a conversation - "explain what you will document and at what level of detail" - and test the answers against what you know:

  • Is it documenting at the right level? A unit is a thing that deserves its own doc. A unit (or a small set of units) per microservice is a reasonable rule of thumb. One unit spanning three services is too coarse; a unit per file is too fine.
  • Is anything missing or extra? Scan the unit list for the things you would expect a new teammate to need a doc for, and for entries that are really scripts, sandboxes, or vendored code.
  • Do the exclusions convince you? Each one carries a rationale written for a reviewer who wants to disagree. If you can disagree from the rationale alone, it is a good exclusion; if it is an apology or restates the path, push back.

What the machinery means, briefly ​

Kinds are claims. A kind (service, lib, ...) fixes the doc shape and the rule pack, and claims every member is the same sort of thing. A kind whose definition needs an "or" to span two populations is a bundle - two kinds quietly swept into one. The classic failure: one frontend kind holding domain SDKs, infra packages, and leftovers while reporting itself complete. If the draft bundled, the report should have flagged it; step 4 is where it splits.

The coverage: line is the honesty check. Every source element lands in one of three states: EXTRACTED (a rule pack reaches it), EXCLUDED (a recorded decision with a rationale), or UNKNOWN (nobody has decided). UNKNOWN is remaining work - the mechanism that stops a directory nobody decided about from being silently missed while the corpus reports itself complete.

The grain trades off. A member grain (one unit per workspace package) is precise on identity but drops non-members; a coarser glob grain catches what the member grain drops, at some precision cost. The report's coverage delta tells you exactly what each grain costs - and it is the decision that shapes everything the campaign documents later.

When you know what you want changed, say it - that is step 4.

E11 Alloy - knowledge as a build artifact.