documentation-expert

Audit technical documentation for structure, cohesion, audience clarity, and navigation.

Updated Apr 9, 2024
One-click install
npx skills add https://github.com/nhonvo/Powershell --skill documentation-expert-nhonvo
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-expert
Source: https://github.com/nhonvo/Powershell/tree/main/antigrafity-config/.agent/skills/documentation-expert
Command: npx skills add https://github.com/nhonvo/Powershell --skill documentation-expert-nhonvo

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation structure, cohesion, audience targeting, and navigation challenges hinder readability, consistency, and reuse across technical content.

Core Features & Use Cases

  • Proactively assess documentation quality across structure, flow, audience clarity, and information architecture.
  • Recommend and apply IA patterns (Diátaxis, hub-and-spoke) and taxonomy to improve discoverability and maintainability.
  • Detect documentation anti-patterns, duplicates, and navigation gaps, delivering actionable guidance for editors and teams.

Quick Start

Run a documentation audit and generate an improvement plan addressing structure, navigation, and audience clarity.

Frequently Asked Questions about documentation-expert

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I audit technical documentation for structure and readability issues?

A documentation audit assesses structure, cohesion, audience clarity, and navigation to detect anti-patterns and gaps. It delivers an actionable improvement plan applying metadata standards and information architecture patterns.

What is the Diátaxis framework and how does it organize technical content?

Diátaxis is an information architecture pattern used to organize technical documentation by purpose, improving discoverability and maintainability. It structures content to adapt effectively across multiple audience levels.

How do I improve API reference navigation and audience clarity?

Improve API reference navigation by applying hub-and-spoke information architecture patterns, enforcing audience tagging, and adding navigation aids. This adapts technical content appropriately to multiple audience levels.

Can I apply documentation quality assurance to onboarding tutorials and product guides?

Yes, documentation quality assurance applies to product guides, API references, tutorials, and onboarding materials. It proactively assesses flow and structure to deliver actionable guidance for editors and teams.

What is the best way to detect duplicate content and navigation gaps in technical docs?

Run a documentation audit evaluating structure and information architecture to detect duplicates and navigation gaps. This identifies anti-patterns and delivers actionable maintenance guidance for editors.

When should I use hub-and-spoke information architecture for technical documentation?

Use hub-and-spoke information architecture when technical documentation requires improved discoverability and ongoing maintenance checks. It structures complex content relationships and enforces taxonomy across audience levels.