skills.rest
nishio-n0522
nishio-n0522COMMUNITY
Explore all skills by this author →
GitHub

review-ai-doc

Review .claude/ directory documentation for AI readability and clarity.

Updated Aug 23, 2026
Search Tags:#code review#prompt engineering#documentation quality#skill review#ai documentation#ai readability
One-click install
npx skills add https://github.com/nishio-n0522/test_updated_sdd --skill review-ai-doc
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: review-ai-doc
Source: https://github.com/nishio-n0522/test_updated_sdd/tree/main/.claude/skills/review-ai-doc
Command: npx skills add https://github.com/nishio-n0522/test_updated_sdd --skill review-ai-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires gitpython, pyyaml, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill addresses the challenge of ensuring AI-generated or AI-focused documentation is clear, consistent, and efficient for AI consumption, preventing misinterpretations and improving AI performance.

Core Features & Use Cases

  • AI Document Review: Analyzes .claude/ directory files (SKILL.md, agents/.md, commands/.md) for clarity, consistency, and context efficiency.
  • Quality Assurance: Identifies ambiguities, structural inconsistencies, and potential execution errors in AI-facing documentation.
  • Use Case: Before deploying a new AI agent, use this Skill to review its agent.md file to ensure the AI understands its instructions precisely and avoids common pitfalls.

Quick Start

Review all unstaged AI documentation files in the .claude directory.

Frequently Asked Questions about review-ai-doc

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

FAQPage Schema
How do I review AI documentation for clarity and context token efficiency?▼

AI documentation review analyzes .claude/ directory files, including SKILL.md and agents/*.md, to assess AI readability, structural consistency, and context token efficiency, returning a PASS, NEEDS_IMPROVEMENT, or FAIL assessment.

What is AI readability and why does it matter for agent instructions?▼

AI readability ensures AI-facing documentation communicates instructions without ambiguity, preventing misinterpretations and improving AI performance by verifying scope clarity, contradiction detection, and error handling.

How do I check .claude directory files for structural consistency and execution errors?▼

Checking .claude directory files for execution errors involves analyzing SKILL.md, agents/*.md, and commands/*.md files to identify ambiguities, structural inconsistencies, and potential execution errors in AI-facing documentation.

Can I use GitPython to review unstaged AI documentation files?▼

GitPython is a supported dependency for reviewing unstaged AI documentation files in the .claude directory, verifying AI readability, clarity, and contextual efficiency before deployment.

What are the limitations of automated prompt engineering documentation review?▼

Automated AI documentation review is limited to assessing instruction ambiguity, contradiction detection, and error handling within .claude/ directory files, and cannot dynamically execute the agent to verify real-time behavioral outcomes.

Related Skills

Explore More Software Engineering Skills→
bbsbotbbsbot
1

ln-003-push-all

Commit and push all staged, unstaged, and untracked changes to the remote repository.

Community
Intermediate
broomvabroomva
3

unhobble

Audit agent context files for token density, directive polarity, and contradictions.

Community
Advanced
Dokkabei97Dokkabei97
3

flow-validation

Validate Claude Code plugin components against flow validation rules.

Community
Advanced
ReidondReidond

review-prompts

Review AI prompt templates for structure, domain alignment, and LLM best practices.

Community
Advanced