Skip to content
Get packs

CLAUDE.md Writer

Creates, updates, or audits CLAUDE.md project instruction files using concise best practices

Source Download skill
Repository
luongnv89/claude-howto
Stars
46,401
Licence
MIT
Files
1 file

What it does

This skill teaches an AI coding agent how to write and maintain CLAUDE.md, the project instruction file that an agent reads at the start of every session in a codebase. Once installed, the agent analyzes your project, drafts a short focused CLAUDE.md with build and test commands, key conventions, and gotchas, and asks for your approval before writing. It can also audit an existing file for bloat and anti-patterns without changing it, and it includes guidance for AGENTS.md files.

Great for

  • Developers setting up a new repository so their AI coding agent starts with useful project context
  • Teams whose CLAUDE.md has grown long and needs condensing
  • Maintainers who want a read-only quality audit of an existing CLAUDE.md

Skip it if

  • Non-developers or projects with no AI coding agent, since the output only matters to agents that read CLAUDE.md
  • Anyone expecting fully automatic generation, because the skill explicitly discourages auto-generated files and asks for review before writing

Try asking

  • “Create a CLAUDE.md for this project based on its README and package.json”
  • “Audit my current CLAUDE.md and report its line count and anti-patterns without changing it”
  • “Update CLAUDE.md to remove style rules and move task-specific instructions into agent_docs/”
  • “Create src/api/CLAUDE.md with instructions specific to the API directory”
Step-by-step guide: how to use CLAUDE.md WriterInstall, first run, examples, tips and FAQs

Install in 3 steps

  1. 1

    Download the skill

    The ZIP contains the 1 original files, the MIT licence and an attribution note.

    claude-md.zip
  2. 2

    Add it to your agent

    Claude Code (all projects)

    mkdir -p ~/.claude/skills && unzip claude-md.zip -d ~/.claude/skills/

    Claude Code / Agent SDK (this project only)

    mkdir -p .claude/skills && unzip claude-md.zip -d .claude/skills/

    Claude apps (web/desktop): Settings → Capabilities → Skills → Upload skill, and choose the ZIP.

  3. 3

    Ask for the task

    No special command needed — the agent reads the skill's description and loads it when your request matches. Try one of the prompts above.

Get better results

  • Say 'audit' first to see what needs fixing before asking for changes.
  • Review the draft carefully, since the skill asks for approval before writing and commands should be verified to work.
  • Point it at a specific path such as src/api/CLAUDE.md for directory-level instructions.

What's inside

  • SKILL.md

Redistributed unmodified from luongnv89/claude-howto under the MIT licence. The assessment was drafted with AI from the skill's files on 2026-10-29. Skills can instruct your agent to run code — read SKILL.md and any scripts before installing.