docs-review

Review repository documentation and agent-context files for duplication and modular structure.

Updated Jul 11, 2022
One-click install
npx skills add https://github.com/kvnxiao/.dotfiles --skill docs-review-kvnxiao
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-review
Source: https://github.com/kvnxiao/.dotfiles/tree/main/claude/skills/docs-review
Command: npx skills add https://github.com/kvnxiao/.dotfiles --skill docs-review-kvnxiao

SYSTEM DOCUMENTATION & REQUIREMENTS

## What problem does it solve? This skill reviews and improves repository documentation for both human-readable docs and AI agent context files to ensure clarity, minimize duplication, and promote modular structure across docs/, README.md, CLAUDE.md, CODEX.md, AGENTS.md, and related agent-context files.

## Core Features & Use Cases

  • Audit documentation across human docs and agent-context files (CLAUDE.md, CODEX.md, AGENTS.md, .cursorrules, etc.) to identify duplication, gaps, and inconsistencies.
  • Propose and implement modularization and a three-layer structure (standards, human docs, agent rules) to improve maintainability.
  • Provide actionable migration plans and references to align with repository conventions and onboarding of new contributors.

### Quick Start Run the docs-review skill to analyze this repository and generate a structured review with recommended documentation architecture and a migration plan.

Frequently Asked Questions about docs-review

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

FAQPage Schema
How do I audit repository documentation for duplication and inconsistencies?

To audit repository documentation, run a docs-review to analyze human docs and agent-context files like CLAUDE.md or AGENTS.md, identifying duplication, gaps, and inconsistencies while generating a structured review with actionable migration steps.

What is a three-layer documentation structure for repositories?

A three-layer documentation structure separates repository content into standards, human-readable docs, and agent rules. This modularization improves maintainability and reduces duplication across files like README.md and CLAUDE.md during refactoring.

How do I consolidate scattered CLAUDE.md and agent-context files during a refactor?

To consolidate scattered agent-context files during a refactor, apply a structured review to align naming conventions and implement a three-layer organization, generating a migration plan that standardizes CLAUDE.md, CODEX.md, and AGENTS.md.

Can I use a documentation review to standardize onboarding for new contributors?

Yes, you can use a documentation review to standardize onboarding by proposing modular structures and aligning repository conventions. This process delivers actionable migration steps that help new contributors navigate human docs and agent rules effectively.

Does documentation modularization work with existing .cursorrules and CODEX.md files?

Documentation modularization works with existing .cursorrules and CODEX.md files by auditing them alongside human docs to identify gaps, proposing a three-layer structure that integrates these agent-context files into a unified, maintainable architecture.