documentation-expert

Audit technical documentation by analyzing hierarchy, wordiness, terminology consistency, and link integrity to identify quality issues. The process evaluates audience alignment and navigation flow to surface targeted improvements for user guides and API references.

Improve navigation in user guides by applying hub-and-spoke structures and Diátaxis-inspired patterns. These templates provide audience indicators and cross-link strategies to enhance content discovery and comprehension across onboarding materials.

A documentation health check evaluates audience clarity by assessing prerequisite knowledge tailoring and audience indicators. It identifies misalignment between content and reader personas to ensure technical docs meet specific user comprehension needs.

Yes, you can fix terminology consistency issues in API references through a structured documentation audit. The analysis surfaces inconsistent terminology and structure gaps, providing targeted improvements without requiring external tools.

Restructure documentation using a hub-and-spoke pattern when audits reveal navigation flow issues and structure gaps. This approach improves content discovery and comprehension by organizing information architecture into clear, navigable hierarchies.

For complex onboarding materials, ensure the audit evaluates prerequisite knowledge tailoring for each reader persona. The health check must analyze audience clarity and structure gaps to surface targeted improvements effectively.