skills.rest
lestrrat
lestrratCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

claude-docs-init

Generate repository docs and CLAUDE.md for Claude Code navigation.

2|Updated Feb 24, 2026
Search Tags:#automation#documentation#analysis#claude#repository#docs#pre-read
One-click install
npx skills add https://github.com/lestrrat/claude-code --skill claude-docs-init
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: claude-docs-init
Source: https://github.com/lestrrat/claude-code/tree/main/skills/claude-docs-init
Command: npx skills add https://github.com/lestrrat/claude-code --skill claude-docs-init

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Initialize .claude/docs/ and CLAUDE.md for a repository. Analyzes the codebase and creates agent-optimized documentation so Claude Code can navigate, modify, and test the project effectively.

Core Features & Use Cases

  • Generate core docs (packages.md, testing.md, dependencies.md) to map project structure and testing landscape.
  • Generate ecosystem-specific docs based on detected language (Go, Node, Python, etc.) to cover APIs, configurations, and architecture.
  • Produce CLAUDE.md with pre-read rules and cache maintenance, enabling agent sessions to operate with up-to-date repo context.

Quick Start

Analyze the repository and generate CLAUDE-docs artifacts for immediate agent readiness.

Frequently Asked Questions about claude-docs-init

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

FAQPage Schema
How do I generate agent-optimized documentation for my codebase to help Claude Code navigate projects?▼

Agent-optimized documentation is generated by analyzing the repository root to determine language ecosystem, build system, project structure, tests, and CI/CD, producing core docs and a CLAUDE.md file for Claude Code.

What is the best way to set up CLAUDE.md pre-read rules for repository context?▼

Setting up CLAUDE.md pre-read rules involves generating a file with cache maintenance instructions that enables agent sessions to operate with up-to-date repository context and navigation rules.

Can I automatically map project structure and testing landscapes for different language ecosystems like Go or Python?▼

Yes, the repository analysis detects the language ecosystem and generates ecosystem-specific docs covering APIs, configurations, and architecture alongside core docs like packages.md and testing.md.

How do I keep repository documentation in sync with source code changes?▼

Keeping docs in sync with source changes is handled by the generated CLAUDE.md cache maintenance rules, which ensure agent sessions operate with up-to-date repository context during modifications.

Do I need existing documentation to bootstrap agent-ready repository docs?▼

No, existing documentation is not required. The tool analyzes the codebase structure, build system, and CI/CD configuration to generate core docs and ecosystem-specific documentation from scratch.

What documentation files are generated to map project dependencies and structure?▼

The generated core documentation files include packages.md, testing.md, and dependencies.md to map the project structure, testing landscape, and dependency ecosystem for agent navigation.

Related Skills

Explore More Software Engineering Skills→
ribon-orgribon-org

init

Analyze project structure and update AGENTS.md with tech stack and commands.

Official
Intermediate
yologdevyologdev
1.9k

evolve

Modify source code, run tests, and commit changes when tests pass.

Community
Advanced
lucas-flatwhitelucas-flatwhite
43

document-release

Synchronize README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md after a ship.

Community
Advanced
fabioc-alohafabioc-aloha
1

API Documentation Skill

Scaffold technical documentation projects with templates for API endpoints and guides.

Community
Intermediate