Context

The system is fairly large, and maintained/developed by an internationally distributed and highly heterogeneous, diverse and volatile development team.

Trigger

Users refer to technical documentation to understand technical details or troubleshoot issues.

Acceptance Criteria

  • Documentation provides coherent and intelligible explanations and instructions
  • At least 90% of system-specific terms used in documentation are defined in glossary section accessible within same document or via direct links
  • Readability score of documentation, as measured by Flesch-Kincaid Readability Test, is between 60 to 70 (8th to 9th-grade reading level)
  • Documentation is easily understandable by average dev-team member