claude-md-generator

Generate a validated CLAUDE.md from repository audit and developer responses.

22|6|Updated Mar 10, 2026

Search Tags:#documentation #onboarding #interview #generate #claude-md #repo-audit

Ready to run

npx skills add https://github.com/felvieira/claude-skills-fv --skill claude-md-generator-felvieira

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill converts repository audit output and a short guided developer interview into a single, concise CLAUDE.md that provides immediate onboarding context for agents and new contributors, eliminating vague or outdated project documentation.

Core Features & Use Cases

Audit-driven synthesis: reads docs/repo-audit/current.md and classifies sections as inferred, partial, or unknown to minimize redundant questions.
Guided interactive interview: asks one focused question at a time with pre-populated options from the audit, always soliciting tacit "gotchas".
Validated, actionable output: generates up to 11 concise sections, validates commands against package manifests, shows diffs before overwrite, and writes CLAUDE.md to the repo root.
Use case: run after the Repo Auditor to produce a ready CLAUDE.md for onboarding, agent context, or documentation updates.

Quick Start

Run the claude-md-generator after the repo audit to produce an actionable CLAUDE.md for the project.

Frequently Asked Questions about claude-md-generator

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

FAQPage Schema

How do I generate a CLAUDE.md file for project onboarding from a repository audit?▼

Generate a CLAUDE.md file by consuming a repository audit file, performing a guided interactive interview to fill information gaps, validating commands against package manifests, and writing the final concise documentation to the project root.

What is the best way to create concise documentation from a repo audit for new contributors?▼

The best way to create concise documentation from a repo audit is to classify audit sections as inferred, partial, or unknown, then use a guided interview to ask focused questions and solicit tacit gotchas before synthesizing the results.

Do I need a specific audit file format before generating project onboarding documentation?▼

Yes, you need the repository audit output located at docs/repo-audit/current.md before generating project onboarding documentation, as the tool reads and classifies this file to minimize redundant developer questions.

Can I validate package manifest commands before writing the final CLAUDE.md to my repository?▼

Yes, you can validate package manifest commands during the generation process, ensuring the actionable output is accurate and preventing broken commands from being written to the CLAUDE.md file.

How does an interactive interview improve repository documentation generation?▼

An interactive interview improves repository documentation generation by asking one focused question at a time with pre-populated options from the audit, capturing tacit developer knowledge and resolving unknown sections efficiently.