Does this skill check the validity of code snippets?

Yes, it specifically reviews code examples for validity and accuracy to ensure they are functional and follow best practices.

What documentation files are prioritized by this skill?

The skill focuses on high-impact project entry points, including README.md, CLAUDE.md, getting-started guides, and API documentation.

How does it handle version-specific documentation?

The skill accommodates version-specific content as long as the versioning is clearly noted within the document, ensuring historical docs aren't incorrectly flagged as outdated.

Does it flag placeholder values as errors?

No, the skill is programmed to recognize and ignore intentional placeholders such as 'your-api-key' or 'example.com' to prevent false positives.

Documentation Quality Reviewer

Name: Documentation Quality Reviewer
Author: JesseNaranjo

byJesseNaranjo

•

学习与文档

Audits and improves technical documentation and AI instruction files for accuracy, clarity, and structural consistency.

This skill automates the rigorous evaluation of technical documentation, ensuring that project READMEs, API guides, and AI-specific instruction files like CLAUDE.md are accurate, complete, and up-to-date. It validates code examples, identifies structural gaps, and standardizes AI configuration files across various formats to enhance developer onboarding and AI-agent performance. By prioritizing high-impact entry points, it helps maintain a high standard of communication for both human contributors and AI assistants.

主要功能

01Comprehensive audit of documentation accuracy, clarity, and completeness

021 GitHub stars

03Validation of code example integrity and technical correctness

04Structural organization checks for README.md and API guides

05Intelligent filtering to ignore intentional placeholders and pseudocode

06Standardization of AI instruction files like CLAUDE.md and .ai/AI-AGENT-INSTRUCTIONS.md

使用场景

01Standardizing AI assistant behavior across multiple repositories using consistent instruction templates

02Auditing project documentation for accuracy before a major release or public launch

03Onboarding new developers by ensuring 'Getting Started' guides are error-free and logically structured

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add jessenaranjo/ai-setup reviewing-documentation

For use in Claude.ai and ChatGPT

Download Skill