audit-claude-md

Audit CLAUDE.md and AGENTS.md files for best-practices conformance.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/flying7eleven/system-configuration --skill audit-claude-md-flying7eleven
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: audit-claude-md
Source: https://github.com/flying7eleven/system-configuration/tree/main/roles/llm/files/skills/audit-claude-md
Command: npx skills add https://github.com/flying7eleven/system-configuration --skill audit-claude-md-flying7eleven

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Audits CLAUDE.md and AGENTS.md for best-practices conformance and recommended structure, helping teams validate documentation quality and prepare for improvements.

Core Features & Use Cases

  • Validates YAML frontmatter presence and required fields in SKILL.md.
  • Checks for the existence and proper usage of optional directories (scripts/, references/, assets/).
  • Generates a structured audit report and provides actionable improvement guidance, including potential file splits when necessary.

Quick Start

Run /audit-claude-md to audit CLAUDE.md and AGENTS.md for structure and conformance.

Frequently Asked Questions about audit-claude-md

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

FAQPage Schema
How do I audit CLAUDE.md files for best practices and structural conformance?

You can audit CLAUDE.md files by running the /audit-claude-md command, which validates YAML frontmatter presence, required fields, and optional directory structures to generate a conformance report.

What does validating AGENTS.md documentation structure involve?

Validating AGENTS.md documentation structure involves checking for proper YAML frontmatter, verifying the existence and usage of optional directories like scripts/ and references/, and enforcing safe defaults for prompt behavior.

When do I need to split CLAUDE.md files into separate components?

You need to split CLAUDE.md files when the audit identifies structural issues or excessive content, providing actionable improvement guidance for dividing documentation into manageable, best-practice compliant sections.

Can I check if my markdown documentation has the correct frontmatter and dependencies?

Yes, the audit checks markdown documentation for YAML frontmatter presence, validates required fields, and verifies dependencies using included scripts and configuration to ensure proper documentation structure.

What is the best way to ensure CLAUDE.md follows recommended documentation practices?

The best way to ensure CLAUDE.md follows recommended practices is executing a structured audit that validates frontmatter, checks optional components like assets/ and references/, and provides actionable improvement guidance.

Does the documentation audit work without any external dependencies?

Yes, the documentation audit works without external dependencies, using only included scripts and configuration to validate structure, enforce safe defaults, and generate conformance reports for CLAUDE.md and AGENTS.md files.