claude-md-generator

Generate claude.md documentation for new folders and modules.

36|6|Updated Nov 2, 2025

Search Tags:#templates #documentation #claude #claude.md #hierarchy #md-generation

Ready to run

npx skills add https://github.com/oimiragieo/LLM-RULES --skill claude-md-generator

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: claude-md-generator
Source: https://github.com/oimiragieo/LLM-RULES/tree/main/.claude/skills/claude-md-generator
Command: npx skills add https://github.com/oimiragieo/LLM-RULES --skill claude-md-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically creates claude.md documents for new folders or modules to standardize Claude Code guidance and inheritance.

Core Features & Use Cases

Creating new modules: Generate claude.md for module onboarding
Adding new major components: Document rules and patterns
Hierarchical inheritance: Reference parent claude.md for inheritance
Validation: Ensure claude.md structure is correct

Quick Start

Generate claude.md for src/modules/auth

Frequently Asked Questions about claude-md-generator

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

FAQPage Schema

How do I automatically generate claude.md documentation for new folders in my codebase?▼

Generate claude.md files automatically by running the Skill on target directories. It analyzes the folder structure, inherits parent rules, and produces module-specific documentation using templates that populate Purpose, Key Patterns, Rules & Guidelines, Dependencies, and Usage Examples.

What is claude.md and why do I need it for my modules?▼

claude.md is a standardized documentation file that guides Claude's understanding of your module's context, patterns, and rules. It ensures consistent documentation across hierarchical codebases and enables Claude to inherit parent documentation while maintaining module-specific guidance.

Can I use claude.md with existing hierarchical codebases?▼

Yes. The Skill applies hierarchical inheritance, automatically referencing parent claude.md files and inheriting parent rules while generating module-specific documentation. This maintains consistency across nested folder structures.

How do I validate that generated claude.md files follow the correct structure?▼

The Skill includes built-in validation that checks generated claude.md structure for correctness before output. It ensures all required sections are present and properly formatted according to your template.

What template format does the Skill use to generate claude.md files?▼

The Skill loads templates from .claude/templates/claude-md-template.md and uses them to structure generated documentation. Templates define sections for Purpose, Key Patterns, Rules & Guidelines, Dependencies, and Usage Examples.

Do I need to manually update claude.md when adding new modules or components?▼

No. The Skill automates module onboarding by generating claude.md for new folders and components. This eliminates manual documentation steps while ensuring standardized structure and inheritance across your codebase.