Agent-Skills.md

Agent Skills: doc-brd-fixer

Automated fix skill that reads review reports and applies fixes to BRD documents - handles broken links, element IDs, missing files, and iterative improvement

UncategorizedID: vladm3105/aidoc-flow-framework/doc-brd-fixer
93

Install this agent skill to your local

pnpm dlx add-skill https://github.com/vladm3105/aidoc-flow-framework/tree/HEAD/platforms/claude-code-plugin/skills/doc-brd-fixer

Skill Files

Browse the full folder contents for doc-brd-fixer.

Download Skill

Loading file tree…

platforms/claude-code-plugin/skills/doc-brd-fixer/SKILL.md

Skill Metadata

Name
doc-brd-fixer
Description
Apply fixes to a BRD from the latest doc-brd-audit report - structure, links, element IDs, content, references, and upstream drift. Use after an audit reports issues.

doc-brd-fixer

Purpose

Read the latest audit report and apply fixes to a BRD, bridging ../doc-brd-audit/SKILL.md and a passing BRD so the audit↔fix cycle can converge.

Layer: 1 (BRD quality improvement). Upstream: the BRD document + BRD-NN.A_audit_report_vNNN.md. Downstream: the fixed BRD + BRD-NN.F_fix_report_vNNN.md.

When to Use

After doc-brd-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 BRD (use ../doc-brd/SKILL.md / ../doc-brd-autopilot/SKILL.md).

Input Contract

Consume the latest audit report from .aidoc/audit/01_BRD-audit.md (the .aidoc/ provenance tier). Back up the BRD before editing (tmp/backup/BRD-NN_<ts>/); on error, restore. Element-ID standards come from ${CLAUDE_PLUGIN_ROOT}/framework/governance/ID_NAMING_STANDARDS.md; structure rules from ${CLAUDE_PLUGIN_ROOT}/framework/layers/01_BRD/BRD-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)

  1. Read the audit report at .aidoc/audit/01_BRD-audit.md AND, when present, the synthesizer's verdict.json + per-persona slots at .aidoc/review/01_BRD/<BRD-id>/ (where <BRD-id> is the short artifact ID, e.g. BRD-01).
    • Prefer verdict.json for the blocking-findings count and coverage summary — it is the deterministic JSON written by the synthesizer (agents/synthesizer.md).
    • Prefer the per-persona slots for the structured findings — stable ids, priorities, locations, recommendations.
    • Slots and verdict.json are optional — when absent (e.g. single_pass run produced no synthesizer output), fall back to parsing the audit report's Findings sections directly.
  2. Resolve responsible lenses per finding. Each blocking finding (P0 + P1) carries a personas array in the synthesizer's reduced form (see verdict.json:findings[*].personas) OR can be inferred from per-lens slot membership. Dispatch rules:
    • Single-lens finding (1 persona): dispatch that lens.
    • Multi-lens finding (2+ personas, e.g. an architect+business_analyst contradiction): dispatch all listed lenses in parallel. Each writes its own <persona>.fix_<N>.json slot. 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 BRD crew's author lens (per REVIEW_CREWS.yaml: business_analyst for BRD) as the default responsible reviewer. Falling back to author-lens rather than skipping ensures every blocking finding gets at least one validation pass. P2/P3 are advisory — apply deterministically without lens validation.
  3. Propose and apply a patch per blocking finding. Fix Phases 0–7 below describe the patch shapes; the catalogue is the same in both modes. Back up first per the existing Input Contract.
  4. Validate non-regression. For each responsible lens identified in step 2, dispatch one Task subagent in patch-validation mode: subagent_type=<mapped agent>; brief = the patched region + the original finding + the patch diff; output = a fresh persona-output record (lens_score for the patched region + any new findings). Persist each lens's output as .aidoc/review/01_BRD/<BRD-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>.
  5. Revert regressions. If any lens returns new P0/P1 on the patch, revert that patch and flag manual_required for the original finding. Never silently keep a regressing fix.
  6. Dispatch the synthesizer once, after all patches are validated, to emit the unified fix report. Persist .aidoc/remediation/01_BRD-fix.md with both the Fixes Applied table AND a Validation Slots index.

single_pass mode (fallback)

Apply Phase 0–7 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-brd-autopilot (or directly), this skill reads and updates the saga journal at .aidoc/review/01_BRD/<BRD-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/01_BRD/<BRD-id>/ && date +%s > .aidoc/review/01_BRD/<BRD-id>/.skill-start.fixer

If .aidoc/review/01_BRD/<BRD-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 multi-lens validation (team mode)

For each blocking finding (P0/P1) that requires lens validation:

  1. 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>"}. Update branches[<lens>].status to "BRANCH_COMPENSATING". Append an entry to compensation_actions[]: {"ts": "<now>", "branch": "<lens>", "reason": "<finding_id>: <message>", "action": "retry"}.
  2. After the validation Task subagent returns:
    • If patch validated (no regression): transition back to BRANCH_COMPLETED. Update compensation_actions[] last entry with the validation result.
    • If patch regresses (lens flags new P0/P1 on patched region): transition to BRANCH_FAILED. Set compensation_actions[] last entry's action to "escalate". The finding becomes manual_required.

Break-circuit checkpoint (between multi-lens validation dispatches)

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/01_BRD/<BRD-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 (their fix_N.json slots remain durable). Set current_phase: "fixer" so the resume invocation knows to continue the remaining validations.
  • Update updated_at. Write saga.json. Exit cleanly.

The remaining validations resume on next invocation per doc-brd-autopilot's §3.4 resume logic.

After all blocking-finding patches validated

  • 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 be re-review).
  • Update updated_at. Write saga.json.

When invoked standalone (no saga.json on entry)

If .aidoc/review/01_BRD/<BRD-id>/saga.json does NOT exist (user runs /aidoc-flow:doc-brd-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: between multi-lens validation dispatches (per the table in REVIEW_SAGA.md). 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 §"Break-circuit checkpoint" 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 BRD into docs/01_BRD/BRD-NN_{slug}/; rename folder to match ID; fix relative links after the move | | 1 — Missing files | referenced-but-absent | create glossary / GAP / reference placeholders from templates | | 2 — Links | broken/abs paths | recompute relative paths; convert absolute → relative | | 3 — Element IDs | legacy/invalid IDs | re-derive BRD.NN.SS.xxxx (section number + content hash); drop legacy BRD.NN.xxxx, numeric type-codes, FR-XXX/BO-XXX prefixes | | 4 — Content | placeholders, missing subsections | fill template dates; normalize MVP subsection headings in place; safe sibling renumbering; flag [TODO]/[TBD] for manual completion | | 5 — References | traceability | add missing @ref: tags; fix cross-BRD paths; update the traceability matrix | | 6 — Upstream | metadata + drift | fix deliverable_type/document_type/upstream_mode; when upstream_mode: "ref", apply tiered drift merge (below) | | 7 — Style | STY01 banned phrases, STY02/03 oversized prose, FM01 frontmatter mismatch | substitute filler (in order to → to; drop the fact that, it should be noted, please note, as a matter of fact); replace flagged superlatives (amazing, seamless, cutting-edge, state-of-the-art); collapse paragraph (≥ 3 banned phrases in one section) to bullets; reconcile frontmatter ↔ Document Control ↔ revision-history rows (mirror frontmatter as the source of truth); STY02/03 — auto-split sections > 300 words at the first natural subheading, or mark manual_required. Authority: ${CLAUDE_PLUGIN_ROOT}/framework/governance/AUTHORING_STYLE.md |

Element ID re-derivation: key = "{doc_id}:{section_id}:{title}:{description}"; ID = BRD.{doc_id}.{section_id}.<first 4 hex of SHA256(key)> (extend to 8 on collision). Document-level refs (SPEC-NN, ADR-NN, IPLAN-NN) stay in dash form.

Tiered upstream drift (only when upstream_mode: "ref"): <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, header normalize, ID conversion) | | auto-assisted | template insertion with partial assumptions (scaffolded tables/subsections) | | manual-required | domain content cannot be inferred (unresolved TODO/TBD, strategy rationale) |

Content-Preservation Rules

  • Never delete existing business content; insert template blocks only where a section is missing or below minimum structure.
  • Normalize equivalent headings in place rather than duplicating sections.
  • Renumber only within the same section file; 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 BRD-NN.F_fix_report_vNNN.md with: Summary (issues in / fixed / remaining; files created / modified) · Fixes Applied (code, issue, fix, file, confidence) · Manual-Review Queue · Validation After Fix (score/errors/warnings before→after) · Cleanup Summary (delete superseded fix reports) · Next Steps (re-run doc-brd-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-brd-audit/SKILL.md · Create: ../doc-brd/SKILL.md
  • Orchestration: ../doc-brd-autopilot/SKILL.md · IDs: ../doc-naming/SKILL.md
  • Authority: ${CLAUDE_PLUGIN_ROOT}/framework/layers/01_BRD/BRD-TEMPLATE.yaml, ${CLAUDE_PLUGIN_ROOT}/framework/governance/ID_NAMING_STANDARDS.md