Does this skill automatically modify my documentation files?

No, the Documentation Auditor is designed to report discrepancies only. It provides a detailed list of what needs to be changed without modifying your files directly.

Does it check for broken links or just content accuracy?

Its primary focus is content accuracy and consistency between code logic and written descriptions, though it can often identify broken internal references during the audit.

Can I use this for large-scale refactors?

Yes, it is particularly effective during refactors to ensure that every code change is reflected in the corresponding documentation before the code is merged.

What types of documentation can it review?

It is optimized for Markdown files, READMEs, API guides, and other text-based documentation commonly found in software repositories.

How does this improve developer productivity?

It eliminates the manual effort of cross-referencing files, allowing developers to quickly identify and fix documentation debt before it impacts users.

Documentation Auditor

Name: Documentation Auditor
Author: doodledood

bydoodledood

•

학습 및 문서화

Audits project documentation for accuracy against recent code changes and generates detailed discrepancy reports.

소개

The Documentation Auditor skill automates the essential but often overlooked task of keeping project documentation in sync with evolving codebases. By launching a specialized docs-reviewer agent, this skill cross-references your READMEs, API guides, and technical manuals against actual code modifications to identify outdated examples, missing parameters, or broken logic. It provides a comprehensive report of what needs updating without making any direct modifications to your files, ensuring your documentation remains a reliable source of truth during rapid development cycles or major refactors.

주요 기능

Support for READMEs, API documentation, and technical guides
Agentic workflow optimization for rapid doc reviews
Detailed reporting of discrepancies and outdated content
8 GitHub stars
Automated documentation-to-code consistency audits
Read-only analysis that preserves file integrity

사용 사례

Verifying API documentation accuracy after backend refactoring
Auditing README installation steps against updated dependencies
Identifying undocumented features or parameters before a major release

소개

주요 기능

Support for READMEs, API documentation, and technical guides
Agentic workflow optimization for rapid doc reviews
Detailed reporting of discrepancies and outdated content
8 GitHub stars
Automated documentation-to-code consistency audits
Read-only analysis that preserves file integrity

사용 사례

Verifying API documentation accuracy after backend refactoring
Auditing README installation steps against updated dependencies
Identifying undocumented features or parameters before a major release