ezra-docs

Audits documentation artifacts for gaps, inconsistencies, and quality issues.

Updated Feb 28, 2025
One-click install
npx skills add https://github.com/christopheraaronhogg/codehogg --skill ezra-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ezra-docs
Source: https://github.com/christopheraaronhogg/codehogg/tree/main/templates/skills/ezra-docs
Command: npx skills add https://github.com/christopheraaronhogg/codehogg --skill ezra-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill provides expert documentation analysis, API docs review, and knowledge-management assessment to help teams improve documentation quality without writing code.

Core Features & Use Cases

  • Documentation audit and review of READMEs, API docs, architecture docs, and knowledge bases.
  • Production of consultant-style reports with findings and prioritized recommendations.
  • Support for planning and strategy adjustments to improve onboarding and knowledge sharing.

Quick Start

Audit my project's README, API docs, and knowledge management for coverage and quality.

Frequently Asked Questions about ezra-docs

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

FAQPage Schema
How do I audit my project's documentation for coverage and quality?

To audit documentation, submit your README, API docs, architecture docs, and knowledge bases for review. The analysis identifies gaps, inconsistencies, and quality issues, producing prioritized recommendations to improve your technical writing without generating code.

What is a docs audit and when do I need one?

A docs audit is a comprehensive assessment of technical writing artifacts like API references and onboarding guides. You need one when documentation lacks coverage, contains inconsistencies, or requires structured reporting to improve knowledge management across codebases.

Can I review API docs and architecture documentation for large codebases?

Yes, documentation audits apply to codebases and knowledge bases of varying sizes. The review process evaluates API reference sections and architecture docs to deliver executive-ready recommendations tailored to large-scale documentation environments.

What's the best way to identify gaps in a technical README?

The best way to identify README gaps is through a consultant-style review that analyzes documentation artifacts for coverage issues. This process yields structured reports with prioritized actions to resolve inconsistencies and enhance onboarding quality.

Does the documentation review process generate new code or content?

No, the documentation review process operates under non-code-generation constraints. It focuses entirely on analyzing existing artifacts and delivering consultant-style findings with actionable recommendations, rather than writing new code or generating documentation content.