skills.rest
bryonjacob
bryonjacobCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

documenting-with-claude-md

Organizes and loads CLAUDE.md documentation hierarchies for AI context.

1|Updated Oct 21, 2025
Search Tags:#templates#documentation#CLAUDE.md#hierarchical#AI-context#module-index
One-click install
npx skills add https://github.com/bryonjacob/aug --skill documenting-with-claude-md
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documenting-with-claude-md
Source: https://github.com/bryonjacob/aug/tree/main/aug-dev/skills/documenting-with-claude-md
Command: npx skills add https://github.com/bryonjacob/aug --skill documenting-with-claude-md

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill enables teams to create a structured, machine-readable documentation workflow using CLAUDE.md roots and module CLAUDE.md files, reducing cognitive load for AI context and improving discoverability.

Core Features & Use Cases

  • Hierarchical documentation: root CLAUDE.md with a module index and per-module CLAUDE.md for significant modules.
  • Consistent templates: provides templates for root and module CLAUDE.md to standardize content.
  • AI-assisted reasoning: enables instant loading of documentation into AI context for faster decision making.

Quick Start

Use the documented templates to create a root CLAUDE.md and add module CLAUDE.md files to organize codebase documentation.

Frequently Asked Questions about documenting-with-claude-md

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

FAQPage Schema
How do I structure CLAUDE.md files for AI context loading?▼

Structure CLAUDE.md files hierarchically by creating a root CLAUDE.md with a module index and adding optional per-module CLAUDE.md files for significant modules to organize codebase documentation for AI agents.

What is a hierarchical CLAUDE.md documentation workflow?▼

A hierarchical CLAUDE.md documentation workflow uses a root CLAUDE.md to define structure and templates alongside per-module CLAUDE.md files, reducing cognitive load for AI context and improving discoverability.

When do I need per-module CLAUDE.md files?▼

You need per-module CLAUDE.md files when your codebase has significant modules that require individual documentation entries to enable AI agents to reason with specific module contexts effectively.

How do I standardize CLAUDE.md templates across a codebase?▼

Standardize CLAUDE.md templates by using the documented root and module templates provided to create consistent content structure across your codebase documentation hierarchy.

Does this approach work without a root CLAUDE.md file?▼

No, this approach relies on a root CLAUDE.md file to define the structure, templates, and module indices that enable the hierarchical loading of documentation into AI context.

Why use machine-first CLAUDE.md documentation for AI agents?▼

Machine-first CLAUDE.md documentation enables instant loading of structured documentation into AI context, allowing AI agents to reason with codebase structure and make faster decisions.

Related Skills

Explore More Content & Communication Skills→
shenxingyshenxingy
8

map

Scan repository directories and generate ARCHITECTURE.md with a Mermaid module graph.

Community
Intermediate
Agentic-AssetsAgentic-Assets

context-engineering

Audit and optimize AI agent context across CLAUDE.md files and hooks.

Official
Advanced
rashideerashidee
3

specgen-laravel-eloquent-bladehtmx

Generate Laravel specification blueprints from CLAUDE.md, PRD.md, and MOCKUP inputs.

Community
Advanced
imehrimehr

dev-docs-workflow

Maintains three-file task documentation (plan.md, context.md, tasks.md) for Claude Code sessions.

Community
Basic