documentation-evaluator

Audit codebase documentation and generate concrete improvement proposals.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/databio/ai-sandbox --skill documentation-evaluator
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-evaluator
Source: https://github.com/databio/ai-sandbox/tree/main/workspaces/refgenie/.claude/skills/documentation-evaluator
Command: npx skills add https://github.com/databio/ai-sandbox --skill documentation-evaluator

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Identifies gaps between code, navigation, and documentation; surfaces actionable proposals to improve clarity, coverage, and usability of a documentation site.

Core Features & Use Cases

  • Inventory code features and audience analysis.
  • Evaluate site organization using the nav/config and audience insights.
  • Review individual pages for type consistency, coverage, and usefulness.
  • Synthesize concrete improvement proposals and roadmaps for documentation.

Quick Start

Run the documentation-evaluator workflow on your codebase and docs directory to generate a phased assessment with concrete proposals.

Frequently Asked Questions about documentation-evaluator

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

FAQPage Schema
How do I audit documentation quality across a codebase?

Auditing documentation quality involves inventorying code features, assessing navigation structure, and reviewing individual pages for consistency and coverage. This process surfaces concrete proposals to improve clarity and usability across the documentation site.

What is the best way to evaluate site organization for technical docs?

Evaluating site organization requires analyzing the navigation config alongside audience insights and code inventory. This approach identifies gaps between code features and documentation structure, generating actionable recommendations for better content navigation.

How do I identify gaps between code and documentation?

Identifying gaps between code and documentation requires cross-phase code inventory and audience analysis. By comparing implemented features against existing pages, the process surfaces missing coverage and generates concrete improvement proposals for the documentation site.

Can I generate improvement proposals for individual documentation pages?

Yes, generating improvement proposals for individual documentation pages is possible by reviewing each page for type consistency, coverage, and usefulness. The process synthesizes these page reviews into actionable plans and roadmaps for comprehensive documentation elevation.

Does this documentation audit work on projects with both code and docs?

Yes, this documentation audit is applicable to projects containing both code and docs directories. It performs cross-phase code inventory and site evaluation to produce a phased assessment with concrete proposals tailored to the combined codebase environment.