claude-md-creator skill

Overview

This skill generates a minimal, focused CLAUDE.md file at the project root that captures the project WHY/WHAT/HOW in 60 lines or fewer. It prioritizes universal, always-applicable guidance and leaves detailed procedures and large content to external documents. The generated file is suitable for automation, onboarding, and clear project intent statements.

How this skill works

The skill inspects the repository metadata and project files to extract core purpose, scope, and primary workflows. It synthesizes that information into a compact WHY/WHAT/HOW structure and writes a new CLAUDE.md at the repository root, ensuring the output stays below 60 lines. References to deeper documentation are added as pointers rather than expanded content.

When to use it

• When you need a one-page project intent statement for onboarding.
• When a concise, consistent CLAUDE.md is required across multiple repositories.
• When automating documentation generation in CI/CD pipelines.
• When aligning teams on project purpose and primary contribution guidance.
• When you want to keep repository tops concise while delegating details externally.

Best practices

• Keep WHY/WHAT/HOW statements short and universally applicable.
• Avoid procedural or large technical details; link to external docs instead.
• Validate the file stays under 60 lines before committing.
• Use clear, present-tense language focused on outcomes and responsibilities.
• Prefer pointers to WORKFLOW.md, TEMPLATES.md, and PRINCIPLES.md for depth.

Example use cases

• Create CLAUDE.md for a new microservice to state its goal, scope, and how to contribute.
• Add a standardized CLAUDE.md across an organization to improve discoverability of intent.
• Regenerate CLAUDE.md during release automation to reflect updated high-level goals.
• Replace verbose README sections with a short CLAUDE.md that links to detailed docs.
• Onboard new contributors quickly by presenting the project WHY/WHAT/HOW up front.

FAQ