Imported from vladm3105/aidoc-flow-framework (
platforms/claude-code-plugin/skills/doc-spec-fixer/SKILL.md). Install upstream withnpx skills add vladm3105/aidoc-flow-framework --skill doc-spec-fixer. Copyright stays with the author.
doc-spec-fixer
Purpose
Read the latest audit report and apply fixes to a SPEC, bridging
../doc-spec-audit/SKILL.md and a passing SPEC so the audit↔fix cycle can
converge.
Layer: 6 (SPEC quality improvement).
Upstream: the SPEC document + .aidoc/audit/06_SPEC-audit.md.
Downstream: the fixed SPEC + SPEC-NN.F_fix_report_vNNN.md.
When to Use
After doc-spec-audit returns FAIL, as part of an Audit → Fix → Audit loop.
Do not use without an audit report (run the audit first) or to create a new
SPEC (use ../doc-spec/SKILL.md / ../doc-spec-autopilot/SKILL.md).
Input Contract
Consume the .aidoc/audit/06_SPEC-audit.md report. Back up the SPEC before
editing (tmp/backup/SPEC-NN_<ts>/); on error, restore. ID standards come from
${CLAUDE_PLUGIN_ROOT}/framework/governance/ID_NAMING_STANDARDS.md; structure rules from
${CLAUDE_PLUGIN_ROOT}/framework/layers/06_SPEC/SPEC-TEMPLATE.yaml and README.md.
Remediate Mode
Resolve review_mode from .aidoc/profile.yaml; if unset, fall through
to the framework default team per the precedence chain in
${CLAUDE_PLUGIN_ROOT}/framework/governance/ADAPTATION.md. Same
fallback applies to other adaptation knobs (section_toggles).
team mode (per REVIEW_TEAM.md §Operations §Remediate)
-
Read the audit report at
.aidoc/audit/06_SPEC-audit.mdAND, when present, the per-persona slots under.aidoc/review/06_SPEC/<SPEC-id>/(where<SPEC-id>is the short artifact ID, e.g.SPEC-01).- Prefer the per-persona slots for the structured findings — stable ids, priorities, locations, recommendations.
- Slots are optional — when absent (e.g. single_pass run produced no synthesizer output), fall back to parsing the audit report's Findings sections directly.
-
Resolve responsible lenses per finding. Each blocking finding (P0 + P1) carries a
personasarray in the synthesizer's reduced form OR can be inferred from per-lens slot membership. Dispatch rules:- Single-lens finding (1 persona): dispatch that lens.
- Multi-lens finding (2+ personas): dispatch all listed
lenses in parallel. Each writes its own
<persona>.fix_<N>.jsonslot. The fix is accepted only when every dispatched lens returns no new P0/P1 (any one lens regressing reverts the patch). - No-persona / orphan finding (empty or missing
personas): dispatch the SPEC crew's author lens (perREVIEW_CREWS.yaml:architectfor SPEC) as the default responsible reviewer.
Lens → agent map for SPEC:
Lens Agent architectaidoc-flow:solutions-architecttech_leadaidoc-flow:solutions-architectintegration_leadaidoc-flow:solutions-architectchaos_engineeraidoc-flow:chaos-engineersecurity_engineeraidoc-flow:security-engineerFor the three lenses bound to
aidoc-flow:solutions-architect(architect/tech_lead/integration_lead), the validation brief must specify which lens to apply at Task dispatch time so the agent scopes its validation to that lens.SPEC crew weights:
{architect: 30, tech_lead: 30, integration_lead: 20, chaos_engineer: 10, security_engineer: 10}.P2/P3 are advisory — apply deterministically without lens validation.
-
Propose and apply a patch per blocking finding. Fix Phases 0–8 below describe the patch shapes; the catalogue is the same in both modes. Back up first per the existing Input Contract.
-
Validate non-regression. For each responsible lens identified in step 2, dispatch one
Tasksubagent in patch-validation mode:subagent_type=<mapped agent>; brief = the patched region + the original finding + the patch diff; the lens MUST NOT read, cite, or weight any author self-assessment score (*_ready_score/*_score/readiness_score/audit_score) when forming itslens_score(REVIEW_TEAM.mdGD-05); output = a fresh persona-output record (lens_score for the patched region + any new findings). Persist each lens's output as.aidoc/review/06_SPEC/<SPEC-id>/<persona>.fix_<N>.json(<N>= sequential fix-iteration counter, starting at 1). Multi-lens findings produce one slot file per responsible lens for the same<N>. -
Revert regressions. If any lens returns new P0/P1 on the patch, revert that patch and flag
manual_requiredfor the original finding. Never silently keep a regressing fix. -
Dispatch the synthesizer once (
subagent_type=aidoc-flow:synthesizer), after all patches are validated, to emit the unified fix report. PersistSPEC-NN.F_fix_report_vNNN.mdwith both the Fixes Applied table AND a Validation Slots index.
single_pass mode (fallback)
Apply Phase 0–8 directly, single-handed, no lens validation. Unchanged
legacy behaviour — required when the profile says so, when Task subagent
dispatch is unavailable, or when no slots are present.
In both modes, P2/P3 advisory findings are applied without lens validation; only blocking findings (P0/P1) go through the patch-validation loop in team mode.
Saga interaction
When invoked by doc-spec-autopilot (or directly), this skill reads
and updates the saga journal at
.aidoc/review/06_SPEC/<SPEC-id>/saga.json per
${CLAUDE_PLUGIN_ROOT}/framework/governance/REVIEW_SAGA.md. The fixer
acts as the remediation stage of the saga: it transitions
branches to BRANCH_COMPENSATING during patch validation, then back
to BRANCH_COMPLETED (validated) or BRANCH_FAILED (regression
detected).
On entry
At entry, write the fixer's start epoch:
Bash: mkdir -p .aidoc/review/06_SPEC/<SPEC-id>/ && date +%s > .aidoc/review/06_SPEC/<SPEC-id>/.skill-start.fixer
If .aidoc/review/06_SPEC/<SPEC-id>/saga.json exists, read it. Validate
that current saga status is FANIN_REDUCED (post-audit) or
BRANCH_FAILED (re-entering after a prior fixer regression). If
status is something else, log a warning and proceed.
During patch validation (team mode)
For each blocking finding (P0/P1) that requires lens validation:
- Before dispatching the responsible lens validator(s): for each
lens in the finding's
personas[]list, append a transition:{"ts": "<now>", "from": "BRANCH_COMPLETED", "to": "BRANCH_COMPENSATING", "scope": "branch:<lens>"}. Updatebranches[<lens>].statusto"BRANCH_COMPENSATING". Append an entry tocompensation_actions[]:{"ts": "<now>", "branch": "<lens>", "reason": "<finding_id>: <message>", "action": "retry"}. - After the validation Task subagent returns:
- If patch validated (no regression): transition back to
BRANCH_COMPLETED. Updatecompensation_actions[]last entry with the validation result. - If patch regresses (lens flags new P0/P1 on patched region):
transition to
BRANCH_FAILED. Setcompensation_actions[]last entry'sactionto"escalate". The finding becomesmanual_required.
- If patch validated (no regression): transition back to
Before synthesizer dispatch
Per REVIEW_SAGA.md §"Break-circuit policy" — the fixer's
checkpoint boundary is between multi-lens validation dispatches
(each blocking finding's per-lens validation is one boundary).
Before dispatching the next validation:
Bash: echo $(( $(date +%s) - $(cat .aidoc/review/06_SPEC/<SPEC-id>/.skill-start.fixer) ))
If elapsed > SOFT_DEADLINE (1500s):
- Append transition:
{"ts": "<now>", "from": "BRANCH_COMPENSATING", "to": "PARTIAL_TIMEOUT", "scope": "run"}. - Set saga
status: "PARTIAL_TIMEOUT". Preserve all completed validations (theirfix_N.jsonslots remain durable). Setcurrent_phase: "fixer"so the resume invocation knows to continue the remaining validations. - Update
updated_at. Writesaga.json. Exit cleanly.
The remaining validations resume on next invocation per
doc-spec-autopilot's §3.4 resume logic.
After synthesizer reduce
- Append transition:
{"ts": "<now>", "from": "BRANCH_COMPENSATING", "to": "BRANCH_COMPLETED", "scope": "run"}(run-level: fixer pass complete). - Update saga
status: "BRANCH_COMPLETED"(autopilot's next phase will bere-review). - Update
updated_at. Writesaga.json.
When invoked standalone (no saga.json on entry)
If .aidoc/review/06_SPEC/<SPEC-id>/saga.json does NOT exist (user
runs /aidoc-flow:doc-spec-fixer directly outside the autopilot
loop), do NOT initialize the full saga schema. Log saga.json not present; running fixer without saga journal (standalone mode). Run
the fix phases as usual; write the fix report; skip all saga.json
transitions. Backward-compatible with direct skill invocation.
When invoked in single_pass mode
If review_mode: single_pass is active, the fixer applies patches
deterministically without lens validation and without writing
saga.json. Existing behavior preserved.
Break-circuit policy
Per ${CLAUDE_PLUGIN_ROOT}/framework/governance/REVIEW_SAGA.md
§"Break-circuit policy", this skill checks elapsed wall-clock at one
checkpoint boundary: after all per-finding patches return and before
invoking the synthesizer. The SOFT_DEADLINE is 1500s
(ORCHESTRATOR_TIMEOUT=1800s minus 300s buffer).
If the soft deadline has been crossed, exit cleanly with saga
status: "PARTIAL_TIMEOUT" per §"Before synthesizer dispatch" above.
The fixer's partial progress (fix_N.json slots already written) is
durable; resumed invocation continues from where the break-circuit
fired.
Fix Phases
Run in order; later phases assume the earlier ones succeeded.
| Phase | Scope | Representative actions |
|---|---|---|
| 0 — Structure | nested-folder rule | move SPEC into docs/06_SPEC/SPEC-NN_{slug}/; rename folder to match ID; fix relative links after the move |
| 1 — YAML | malformed YAML | repair indentation/quoting, remove duplicate keys, fix types so the SPEC parses |
| 2 — Missing files | referenced-but-absent | create index / reference placeholders from templates |
| 3 — Links | broken/abs paths | recompute relative paths; convert absolute → relative |
| 4 — IDs | invalid/legacy IDs | enforce dash-form SPEC-NN at the document level; correct upstream element refs to TYPE.NN.SS.xxxx; drop legacy STEP-XXX/IF-XXX/DM-XXX, 3-digit SPEC-NNN, numeric type codes |
| 5 — Content | placeholders, thresholds | fill template dates; replace hardcoded numbers with @threshold: references; flag [TODO]/[TBD] for manual completion |
| 6 — References | traceability | add tags missing from this layer's required_tags (per LAYER_REGISTRY.yaml necessary-upstream contract — SPEC requires @ears @bdd @adr) and the downstream @tdd: TDD-NN; fix upstream paths; update the traceability matrix |
| 7 — Upstream | metadata + drift | fix deliverable_type/document_type; apply tiered drift merge against upstream ADR/BDD (below) |
| 8 — Style | STY01 banned phrases, STY02/03 oversized prose, FM01 frontmatter mismatch | substitute filler; replace flagged superlatives; collapse paragraph (≥ 3 banned phrases in one section) to bullets; reconcile frontmatter ↔ Document Control rows; STY02/03 — split oversized Behavior / Interfaces sections at the next contract boundary, or mark manual_required. Authority: ${CLAUDE_PLUGIN_ROOT}/framework/governance/AUTHORING_STYLE.md |
ID rules: SPEC is referenced at the document level in dash form
SPEC-NN — never a dotted SPEC element ID. Upstream hierarchical refs use the
4-segment element form TYPE.NN.SS.xxxx (e.g. BDD.01.03.8f4c); document-level
@adr: ADR-NN.
Tiered upstream drift (against the referenced ADR/BDD): <5% change → Tier 1
auto-merge (patch bump); 5–15% → Tier 2 auto-merge + detailed changelog (minor
bump); >15% → Tier 3 archive current + regenerate via autopilot (major bump).
Never delete upstream-removed content — mark [DEPRECATED] and retain for
traceability. Record results in .drift_cache.json.
Confidence Classification
Tag every applied fix and surface counts in the report:
| Confidence | Meaning |
|---|---|
auto-safe |
deterministic, low semantic risk (link/path, YAML reindent, ID conversion, threshold tagging) |
auto-assisted |
template insertion with partial assumptions (scaffolded sections/interface stubs) |
manual-required |
domain content cannot be inferred (interface signatures, behavior logic, unresolved TODO/TBD) |
Content-Preservation Rules
- Never delete existing interface definitions, data-model schemas, or behavior logic; insert template blocks only where a section is missing or below minimum structure.
- Normalize equivalent YAML keys/headings in place rather than duplicating sections; preserve YAML comments.
- Renumber only within the same section; flag if a cross-reference anchor would break.
Fix Report Format
Table-pipe escape (MD056)
When emitting markdown table cells that contain code spans with shell
pipes (e.g. `docker compose ps | grep 'Up'`), the unescaped |
inside the code span is parsed by markdownlint as a column separator,
tripping MD056 (column-count mismatch). Two fixes:
- Preferred: escape the pipe inside the code span as
\|— renders as|in markdown viewers but doesn't break the table. Example row:| OP-02 | ... | `docker compose ps \| grep 'Up'` | ... | - Alternative: move the code span out of the table cell and reference it as a footnote or paragraph below the table. The cell then carries plain prose like "shell readiness gate (see below)".
Apply to every report row that emits a shell-pipe code span inside a table cell. Cascade-output that trips MD056 is a SKILL bug, not a markdownlint over-strictness — fix here, not by lint-ignoring.
Write SPEC-NN.F_fix_report_vNNN.md with: Summary (issues in / fixed /
remaining; files created / modified; YAML blocks repaired) · Fixes Applied
(code, issue, fix, file, confidence) · Manual-Review Queue · Upstream
Drift Summary · Validation After Fix (score/errors/warnings before→after)
· Cleanup Summary (delete superseded fix reports) · Next Steps (re-run
doc-spec-audit). Loop until score ≥ threshold or max iterations reached.
Adaptation
Before applying fixes, read the project adaptation profile
(.aidoc/profile.yaml). Honor section_toggles: do not reintroduce an
optional section the project has toggled off. Ignore any unknown or
out-of-surface key.
Authority: ${CLAUDE_PLUGIN_ROOT}/framework/governance/ADAPTATION.md.
Related Resources
- Audit (input):
../doc-spec-audit/SKILL.md· Create:../doc-spec/SKILL.md - Orchestration:
../doc-spec-autopilot/SKILL.md· IDs:../doc-naming/SKILL.md - Authority:
${CLAUDE_PLUGIN_ROOT}/framework/layers/06_SPEC/SPEC-TEMPLATE.yaml,${CLAUDE_PLUGIN_ROOT}/framework/governance/ID_NAMING_STANDARDS.md