- name
- documentation-refactor-review
- description
- Review and refactor documentation to reduce drift, duplication, and navigation friction.
- metadata
- {"metadata-version":"1.0.0","title":"Documentation Refactor Review","document-type":"skill","repository":"vc.Agentic","language":"Standard Technical English","updated":"2026-11-08","collection":"optional"}
# Documentation Refactor Review
Agent reviews documentation for drift, duplication, and clarity.
## Objectives
Agent aligns documentation with current repository structure.
Agent reduces duplicate or conflicting guidance.
Agent preserves one canonical document per topic.
Agent improves navigation and task-focused readability.
## Workflow
| Step | Agent Action | Output |
|---|---|---|
| 1. Inventory | Agent lists documentation areas and source-of-truth code artifacts. | Scope inventory |
| 2. Detect | Agent identifies drift, redundancy, stale paths, and missing coverage. | Findings list |
| 3. Plan | Agent selects canonical files and consolidation actions. | Refactor plan |
| 4. Apply | Agent updates, consolidates, retires, or relinks documentation. | Refactored docs |
| 5. Validate | Agent checks references, placement, front matter, and navigation. | Validation results |
## Canonicalization Rules
| Topic | Canonical Home |
|---|---|
| Onboarding and quick reference | `docs/start-here/**`, `docs/ref/**` |
| Operations | `docs/operations/**`, `docs/ops/**` |
| Architecture and decisions | `docs/architecture/**`, `docs/adr/**` |
| Plans and findings | `.sandbox/**` |
| Copilot assets | `.agents/**` |
## Quality Gate
| Check | Test | Pass Criteria |
|---|---|---|
| Duplicate guidance | Compare related documents for repeated procedures. | One canonical procedure remains for each topic. |
| Drift | Validate paths, project names, scripts, routes, and config keys against repository files. | No known stale references remain in changed scope. |
| Navigation | Review index files and cross-links after consolidation. | Readers reach canonical docs from prior entry points. |
| Front matter and links | Run front matter validation and link review when tooling exists. | Zero validation errors and zero broken local links remain in changed files. |
## Additional source coverage
The selected version is the preferred starting point by the recorded date/context basis. Distinct source coverage is retained in the scoped references; do not apply superseded or conflicting defaults automatically.
- [documentation-refactor-review-alternative-1](references/contexts/documentation-refactor-review-alternative-1/guide.md)
- [documentation-refactor-review-alternative-2](references/contexts/documentation-refactor-review-alternative-2/guide.md)
- [documentation-refactor-review-alternative-3](references/contexts/documentation-refactor-review-alternative-3/guide.md)
View on GitHub