Skip to main content

Documentation Review Workflow Guide

Status: Active
Version: 1.0.0
Last Updated: 2025-12-06
Epic: Epic 5 - Documentation Management and Maintenance
Story: Story 2 - Documentation Quality Assurance
Task: E5:S02:T02 - Implement documentation review workflows

Executive Summary​

This guide explains how to use the documentation review workflow tools to conduct systematic documentation reviews based on review cadences. The workflow supports review assignment, tracking, and task creation.

Key Tools:

  • documentation-review-workflow.py - Review workflow automation script
  • Review cadences (Weekly/Monthly/Quarterly/Annual)
  • Review assignment and tracking
  • Kanban task creation

Quick Start​

Generate Review Schedule​

# Generate monthly review schedule
python3 scripts/documentation/documentation-review-workflow.py \
  --cadence monthly \
  --path docs/

# Generate weekly review schedule with assignments
python3 scripts/documentation/documentation-review-workflow.py \
  --cadence weekly \
  --path docs/ \
  --assign

Track Review Status​

# Track review status for all documentation
python3 scripts/documentation/documentation-review-workflow.py \
  --path docs/ \
  --track

Review Workflow Process​

1. Review Planning​

Identify Documentation to Review:

  • Check review cadence schedule
  • Identify documentation by type
  • Determine review scope
  • Prepare review checklist

Review Assignment:

  • Assign reviews to documentation owners
  • Set review deadlines
  • Create review tasks in Kanban
  • Track review assignments

2. Review Execution​

Conduct Review:

  • Use appropriate review checklist
  • Check accuracy, consistency, completeness
  • Verify currency and clarity
  • Validate format and links

Document Findings:

  • Record issues identified
  • Categorize by severity
  • Prioritize fixes
  • Document recommendations

3. Review Completion​

Update Documentation:

  • Fix critical issues immediately
  • Schedule high-priority fixes
  • Plan medium/low priority improvements
  • Update last reviewed date

Track Outcomes:

  • Mark review complete
  • Update review status
  • Document improvements made
  • Schedule next review

Review Workflow Script​

Script Features​

Review Schedule Generation:

  • Identifies documentation needing review
  • Classifies documentation by type
  • Determines review cadence
  • Generates review schedule

Review Assignment:

  • Assigns reviews to owners
  • Sets review deadlines
  • Creates Kanban tasks
  • Tracks assignments

Review Tracking:

  • Tracks review status
  • Monitors last review dates
  • Identifies overdue reviews
  • Reports review coverage

Usage Examples​

Generate Monthly Review Schedule:

python3 scripts/documentation/documentation-review-workflow.py \
  --cadence monthly \
  --path docs/ \
  --output monthly-review-schedule.json

Assign Weekly Reviews:

python3 scripts/documentation/documentation-review-workflow.py \
  --cadence weekly \
  --path docs/ \
  --assign \
  --output weekly-review-assignments.json

Track All Review Status:

python3 scripts/documentation/documentation-review-workflow.py \
  --path docs/ \
  --track \
  --output review-status.json

Review Workflow Integration​

Kanban Integration​

Task Creation:

  • Review tasks created automatically
  • Assigned to documentation owners
  • Tracked in Kanban board
  • Completed via Kanban workflow

Task Tracking:

  • Review status in Kanban
  • Review assignments tracked
  • Review completion verified
  • Review outcomes documented

Release Workflow Integration​

RW Step 6-7:

  • Documentation updates during release
  • Review documentation changes
  • Validate documentation accuracy
  • Update review schedules

Review Workflow Templates​

Weekly Critical Documentation Review​

Schedule: Every Monday Duration: 1-2 hours Scope: Critical documentation only

Workflow:

  1. Generate weekly review schedule
  2. Assign reviews to owners
  3. Conduct reviews using checklist
  4. Document findings and create action items
  5. Update review status and schedule

Monthly High-Priority Documentation Review​

Schedule: First Monday of month Duration: 2-4 hours Scope: High-priority documentation

Workflow:

  1. Generate monthly review schedule
  2. Assign reviews to owners
  3. Conduct reviews using checklist
  4. Document findings and create action items
  5. Update review status and schedule

Review Metrics​

Key Metrics​

Review Coverage:

  • Percentage of documentation reviewed on schedule
  • Average time since last review
  • Review completion rate

Review Quality:

  • Issues identified per review
  • Fix completion rate
  • Review effectiveness score

Review Efficiency:

  • Average review time
  • Reviews per reviewer
  • Action item resolution time

Reporting​

Monthly Review Report:

  • Reviews completed
  • Issues identified
  • Fixes completed
  • Coverage statistics

References​

  • Documentation Review Cadences: docs/architecture/standards-and-adrs/documentation-review-cadences.md
  • Documentation Maintenance Policy: docs/architecture/standards-and-adrs/documentation-maintenance-policy.md
  • Epic 5: docs/project-management/kanban/epics/Epic-5/Epic-5.md
  • Story 2: docs/project-management/kanban/epics/Epic-5/Story-002-documentation-quality-assurance.md

Decision Record​

Decision: Implement documentation review workflow automation with schedule generation, assignment, and tracking.

Rationale:

  • Automates review schedule generation
  • Supports review assignment and tracking
  • Integrates with Kanban for task management
  • Enables systematic review execution
  • Tracks review outcomes and improvements