Skip to main content

Documentation Review Checklist

Use this checklist to ensure user documentation is clear, consistent, accurate, compliant, accessible, ready for localization, properly reviewed, and finalized.

Audience & clarity​

  • Suits the target user's skill level.
  • Instructions are clear and logically ordered.

Consistency​

  • Consistent terminology and formatting.
  • UI references match the actual product.

Technical accuracy​

  • All links and screenshots are current.
  • Tasks work as described.

Compliance​

  • Content adheres to any safety, regulatory compliance.
  • Cyber Security User Doc Guidelines*

Accessibility​

  • Correct heading structure and alt text.
  • Clear, descriptive link text.

Localization readiness​

  • Neutral, clear language.
  • No puns or jokes in text.

Review process​

  • Peer-reviewed early enough for changes.
  • Usability prioritized over grammar.

Final touches​

Owner: Documentation Management Team