Skip to content

[Audit] Documentation Consolidation - Reduce Duplication Across Docs #651

@ashleyshaw

Description

@ashleyshaw

Overview

Audit of 40+ documentation files across docs/ to identify duplication, overlap, and opportunities for consolidation.

Current Problems

  1. Multiple files document similar topics (e.g., 3-4 files on PR creation)
  2. Files reference each other with inconsistent linking patterns
  3. Some documentation is in docs/, some in .github/, some in instructions/
  4. Duplication makes updates difficult and creates sync/consistency issues
  5. Documentation index (docs/index.md) is incomplete or outdated

Areas to Audit

See child issues for detailed audits of:

  • Issue creation documentation (4+ files involved)
  • PR creation documentation (3+ files involved)
  • Labeling documentation (3+ files involved)
  • Automation governance documentation (2+ files involved)
  • File organization and folder structure alignment
  • Documentation index and cross-referencing

Acceptance Criteria

  • All docs audited and duplication mapped
  • Consolidation strategy created
  • Obsolete files identified for archival
  • Updated cross-reference links documented

Related Files

  • docs/ (all .md files)
  • docs/index.md
  • .github/README.md
  • README.md (root)
  • Various .instructions.md files in instructions/
  • .github/ISSUE_TEMPLATE/README.md
  • .github/PULL_REQUEST_TEMPLATE/README.md

Related Documentation


Definition of Ready (DoR)

  • Audit scope, checklist, and goals defined
  • Areas/components listed
  • Dependencies and standards mapped

Definition of Done (DoD)

  • Audit performed and findings documented
  • Remediation actions assigned
  • Documentation/changelog updated (if applicable)
  • PR uses correct branch prefix (audit/)

Metadata

Metadata

Assignees

Type

Priority

Medium

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions