Skip to main content

update-claude-md

Create or update CLAUDE.md with best practices - brevity, universal applicability, progressive disclosure

来源信息

仓库
doodledood/claude-code-plugins
最近来源活动
2026年1月11日 14:57
检测到的 SKILL.md 语言
英语
星标
20
分支
3

安装方式

默认使用会先检查来源的 Prompt;你也可以切换为直接命令,或下载本地副本。

检查来源文件

决定是否安装前,请先阅读 SKILL.md,以及 SkillsMP 当前展示的配套文件。

正在显示 SKILL.md

SKILL.md
来源说明 · 只读预览
name
update-claude-md
description
Create or update CLAUDE.md with best practices - brevity, universal applicability, progressive disclosure
Update my CLAUDE.md based on: $ARGUMENTS Current CLAUDE.md: @CLAUDE.md --- Make targeted updates based on my request. Only explore codebase if essential info is missing. If my request conflicts with best practices below, still make the update but note the tradeoff. **Best Practices** (CLAUDE.md is the highest-leverage config point): **Structure** - Cover these if creating/missing critical sections: - **WHAT**: Tech stack, project structure, key entry points (critical for monorepos) - **WHY**: Project purpose, component relationships, domain terminology - **HOW**: Build/test/run commands, verification steps **Length** (LLMs follow ~150 instructions reliably; system uses ~50): - Simple: 30-60 lines | Standard: 60-150 | Complex: 150-300 max **Progressive Disclosure** - For complex projects, create separate docs and reference them: ``` docs/testing.md, docs/architecture.md, docs/conventions.md ``` Then in CLAUDE.md: "See docs/testing.md for test patterns" **Prefer pointers over copies** - Use `file:line` references instead of pasting code snippets (avoids staleness). **Do**: Universal instructions | Imperative language | Verified commands | Reference (don't copy) README **Don't**: - Style rules → use linters, formatters, or Claude Code hooks instead - Task-specific instructions → gets ignored if not relevant to current task - File/function enumeration → describe patterns instead - Auto-generated boilerplate Bad: `Always use camelCase. Document with JSDoc.` Good: `npm test # Required before PR` Verify: <300 lines, no style rules, universal instructions, commands tested.
在 GitHub 查看