47 lines
1.6 KiB
Markdown
47 lines
1.6 KiB
Markdown
|
{{ conventions }}
|
||
|
|
|
||
|
|
## Task
|
||
|
|
|
||
|
|
Make `SCOPE.md` true, then measure it against `INTENT.md`.
|
||
|
|
|
||
|
|
### 1. Establish what the repo can actually do
|
||
|
|
|
||
|
|
Do not infer capability from documentation. Run the tests. Exercise the entry
|
||
|
|
points. Where the repo claims a capability, verify it and note how you verified
|
||
|
|
it. Where it claims one you cannot demonstrate, that is a finding.
|
||
|
|
|
||
|
|
### 2. Rewrite SCOPE.md to match
|
||
|
|
|
||
|
|
`SCOPE.md` describes the repo as it is, not as intended. Cover what is in scope,
|
||
|
|
what is deliberately out of scope with the reason, the current state including
|
||
|
|
test counts and what is verified, and how a newcomer runs it.
|
||
|
|
|
||
|
|
Delete claims you could not verify. A scope document that overstates is worse
|
||
|
|
than one that is terse.
|
||
|
|
|
||
|
|
### 3. Assess scope against intent
|
||
|
|
|
||
|
|
Read `INTENT.md`, including its success criteria if it has them, and check each
|
||
|
|
one empirically rather than by assertion. For every gap, record:
|
||
|
|
|
||
|
|
- what intent promises;
|
||
|
|
- what the repo currently does;
|
||
|
|
- whether the gap is a defect, an unbuilt feature, or a deliberate boundary;
|
||
|
|
- what closing it would take.
|
||
|
|
|
||
|
|
A deliberate boundary is not a gap. Say so where intent has been consciously
|
||
|
|
narrowed, and do not pad the list to look thorough.
|
||
|
|
|
||
|
|
### 4. File the assessment
|
||
|
|
|
||
|
|
Write the assessment to `{{ history_dir }}/<YYYY-MM-DD>-scope-assessment.md` —
|
||
|
|
timestamp prefix first, so the directory sorts chronologically. Include the date,
|
||
|
|
the commit assessed, the method used for each verification, and the gap table.
|
||
|
|
|
||
|
|
This file is a dated observation, not a living document. Later audits add new
|
||
|
|
files; they do not edit this one.
|
||
|
|
|
||
|
|
### 5. Report
|
||
|
|
|
||
|
|
Summarize the gaps most worth acting on and why, then commit and sync.
|