Doc Health Fix
# Doc Health — Apply Fixes
## Routing note
- If the latest report points to broad roadmap resequencing or scope reshaping instead of concrete doc fixes, stop and switch to `prompts/7-roadmap-review/01-roadmap-review.md`.
You are in “Doc Health Apply” mode.
Goal:
Apply the fixes from the latest doc health report, with minimal diffs and zero meaning drift. No important info should live only in chat.
Inputs:
1) Find the most recent report in docs/health/ named DOC_HEALTH_<date>.md.
2) Treat its “Patch list (copy-paste ready)” as the primary guidance.
3) If the report proposes uncertain changes, do NOT apply them automatically. Flag them as “Needs human confirm”.
Rules (strict):
- Make minimal edits. Prefer adding small sections over rewriting.
- Do not change product intent/spec scope unless explicitly required for accuracy.
- If a change is not strongly supported by repo reality (scripts, code, CI configs, slice artifacts), do not apply it.
- If multiple docs repeat the same content, update the canonical one and link from others rather than duplicating.
- Keep ROADMAP high-level (milestones + status only).
- ADRs are append-only. Create new ADRs when clearly justified, do not rewrite old ADRs (except typos).
Steps:
1) Read the latest DOC_HEALTH report.
2) For each High-risk gap:
- Apply the suggested patch to the specified file/section.
3) For each Medium-risk gap:
- Apply if the patch is concrete and supported by repo evidence.
- Otherwise mark as “Needs confirm” in the report.
4) For Low-risk gaps:
- Apply only if trivial (typo, broken link, obvious missing link).
5) If ADRs are recommended:
- Create new ADR files in docs/adr/ with the next number.
- ADR format: Context, Decision, Alternatives, Consequences.
6) Update the doc health report itself:
- Add a section at the bottom: “## Applied on <YYYY-MM-DD>”
- Include a checklist of every patch applied and every item deferred (“Needs confirm”).
Output (chat):
- List files changed (paths)
- Confirm the report was updated with an “Applied” section
- List any “Needs confirm” items (max 5)
Now apply the latest doc health report.when to use it
Community prompt sourced from the open-source GitHub repo kylehuirevvision/repo-rails (MIT). A "Doc Health Fix" style prompt — adapt the placeholders and specifics to your task. Imported as-is and not independently retested here, so check the output before relying on it.
tags
lifestylecommunitygeneral
source
kylehuirevvision/repo-rails · MIT