review-docs

Analyze markdown documentation against source code repositories for accuracy and completeness.

Updated May 9, 2026

Search Tags:#quality assurance #documentation #review #content analysis #code verification

Ready to run

npx skills add https://github.com/aidotters/project-template-for-codex --skill review-docs-aidotters

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: review-docs
Source: https://github.com/aidotters/project-template-for-codex/tree/main/.codex/skills/review-docs
Command: npx skills add https://github.com/aidotters/project-template-for-codex --skill review-docs-aidotters

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill addresses the challenge of ensuring documentation quality, completeness, and alignment with actual code by automating comprehensive reviews.

Core Features & Use Cases

Document Inspection: Automatically analyze markdown files like AGENTS.md, README.md, and architecture documents to identify inconsistencies and omissions.
Change Tracking: Detect updates between code and documentation to verify timeliness and accuracy.
Use Case: When maintaining complex software repositories, use this Skill to routinely audit that all modules and APIs are correctly documented and up-to-date, reducing manual oversight.

Quick Start

Use the review-docs skill to evaluate the current documentation quality of the project after initial setup.

Frequently Asked Questions about review-docs

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

FAQPage Schema

How do I check if my markdown documentation is consistent with my source code?▼

To check documentation consistency, you can parse markdown files like README.md and compare them against your source code repository to identify inaccuracies and omissions. This evaluates accuracy, completeness, and alignment with actual code.

What is the best way to automate quality assurance for technical writing in software projects?▼

Automating technical writing quality assurance involves evaluating markdown documents for accuracy, completeness, and consistency. By parsing files with YAML frontmatter and analyzing content, you can routinely audit modules and APIs to reduce manual oversight.

Can I detect updates between code changes and my existing architecture documents?▼

You can detect updates between code and documentation to verify timeliness and accuracy. This change tracking helps ensure that all modules and APIs in complex software repositories are correctly documented and up-to-date.

Do I need YAML frontmatter in my markdown files to perform a documentation review?▼

YAML frontmatter is utilized during the documentation review process when parsing markdown files. The content analysis relies on this structure to evaluate technical writing and verify code documentation workflows effectively.

When should I use an automated documentation review process instead of manual oversight?▼

Use automated documentation review when maintaining complex software repositories requiring routine audits. It streamlines verifying that all modules and APIs are correctly documented and up-to-date, significantly reducing manual oversight.