auditing-docs-metrics

What problem does it solve?

This Skill addresses the challenge of objectively measuring the effectiveness and quality of developer documentation by providing a framework for auditing key performance indicators (KPIs).

Core Features & Use Cases

• KPI Definition & Measurement: Establishes metrics like Time to First Success (TTFS), Search-to-Click Ratio, Zero-Result Rate, Bounce Rate, and Deflection Rate.
• Usability Testing Protocols: Outlines structured methods for conducting usability tests, including Foraging, Instructional, and Troubleshooting tasks, along with the NASA-TLX scale for cognitive load assessment.
• Audit Process Guidance: Provides a step-by-step guide for inventorying data, computing KPIs, rating performance, identifying issues, and recommending further testing.
• Use Case: A documentation team can use this Skill to conduct a quarterly audit of their API reference documentation, identifying specific areas where users struggle to find information or complete tasks, and prioritizing improvements based on data.

Quick Start

Run an audit of the documentation metrics using the available data sources.