What is the difference between /audit-docs and /plan-docs?

/audit-docs assesses existing documentation to find gaps and quality issues, while /plan-docs switches to design mode to help you map out what documentation a new feature needs.

Where are the documentation audit reports saved?

Reports are automatically saved to structured directories such as audit-reports/ or planning-docs/ within your repository for easy access and version control.

Can it evaluate specific API documentation details?

Yes, it includes a dedicated framework to review endpoint descriptions, request/response examples, authentication, error codes, and versioning documentation.

Does Ezra Docs write the actual code for my project?

No, Ezra Docs acts as a consultant and focuses exclusively on analysis, auditing, and planning documentation; it provides findings and recommendations rather than implementation code.

Ezra Docs Consultant

Name: Ezra Docs Consultant
Author: christopheraaronhogg

bychristopheraaronhogg

학습 및 문서화

Conducts professional documentation audits and strategic planning to improve codebase maintainability and developer onboarding.

소개

Ezra Docs acts as a senior technical writing consultant for your development environment, providing deep analysis of documentation coverage, quality, and accuracy without modifying source code. It evaluates everything from README files and API references to inline comments and architecture guides, delivering executive-ready reports that identify critical gaps and prioritize improvements. Whether you are preparing for a new release or streamlining developer onboarding, this skill offers a structured framework for assessing documentation health and planning future content deliverables.

주요 기능

0 GitHub stars
API documentation quality and consistency review
Strategic documentation planning and design for new features
Comprehensive documentation inventory and coverage analysis
Automated generation of executive-level documentation audit reports
Inline code comment and docblock assessment

사용 사례

Reviewing API documentation for accuracy, versioning, and endpoint descriptions
Auditing a legacy codebase to identify missing setup and maintenance guides
Planning the documentation strategy for a major new feature before development begins

소개

주요 기능

0 GitHub stars
API documentation quality and consistency review
Strategic documentation planning and design for new features
Comprehensive documentation inventory and coverage analysis
Automated generation of executive-level documentation audit reports
Inline code comment and docblock assessment

사용 사례

Reviewing API documentation for accuracy, versioning, and endpoint descriptions
Auditing a legacy codebase to identify missing setup and maintenance guides
Planning the documentation strategy for a major new feature before development begins