SuperAPI AI 工具集

claude-md-authoring

编程与开发

查看项目

更新于 10-16 02:03

技能介绍

用途

该技能用于创建和审查 Claude Code 的 CLAUDE.md 配置文件。其核心理念是:模型对你的代码库的全部了解,只来自你放入其中的 token。CLAUDE.md 是上下文传递中杠杆率最高的位置,每条指令都在争夺有限的注意力,因此只应包含 Claude 无法自行推断、且必须普遍适用的内容。

主要能力

范围判定

  • 用户级(~/.claude/CLAUDE.md):适用于所有项目。只包含个人工作风格偏好、沟通关系动态(反馈、诚实、交流方式)、通用哲学(YAGNI、根因调试)、主动性边界。不包含项目特定命令、技术栈细节、随项目变化的风格规则、并非处处存在的工具或框架引用。
  • 项目级(.claude/CLAUDE.md):仅适用于单个项目。采用 WHAT/WHY/HOW 框架:
    • WHAT(2-5 行):一句话项目目的、主要语言/框架、关键目录及其用途
    • WHY(可选,2-3 行):非显而易见的架构决策、影响实现选择的约束
    • HOW(3-7 行):必要命令(构建、测试、lint、运行)、项目特定工作流、更多文档的位置

指令预算

LLM 能可靠遵循约 150-200 条指令,Claude Code 的系统提示已占用约 50 条,剩余预算有限。建议目标与上限:用户级约 30-40(上限 60)、项目级约 50-80(上限 120)、合并约 80-120(上限 150)。每条可执行指令计为一条,例如「NEVER skip tests」为 1 条,一个 5 项列表为 5 条。

反模式:把 Claude 当 Linter

不应依赖 Claude 执行样式强制,包括具体命名约定的示例、注释格式规则、空白/缩进要求、文件头要求(ABOUTME、版权等)。应改用确定性工具:JavaScript/TypeScript 用 ESLint/Biome,Python 用 Black/Ruff,文件头用 pre-commit 钩子,或用 Claude Code Hooks 运行格式化器。原因在于 LLM 遵循样式规则不稳定:linter 会确定性失败,而 Claude 会静默且不可预测地失败。例外是高层次哲学,如「名称应描述用途而非实现」是可接受的,而「绝不要使用 ZodValidator 或 MCPWrapper 这样的名称」则不可。

渐进式披露

对于复杂指引,不要把全部内容嵌入 CLAUDE.md,而是引用外部文档,让 Claude 决定相关性,例如在「Reference Documentation」小节中列出代码约定、API 模式、测试哲学的文档路径,并说明相关任务时阅读。好处是保持 CLAUDE.md 聚焦、按需读取文档、职责分离更易维护。

结构模板

用户级模板包含:开篇人设/哲学(1-2 行)、Working Together(关系动态、沟通偏好)、Proactiveness(何时继续、何时停下来确认)、Development Philosophy(通用原则)、Guardrails(版本控制、测试原则,保持简短)。项目级模板包含 Project Overview(WHAT)、Development(HOW)、Architecture(WHY,若非显而易见)、Conventions(如需,简要指向详细文档)。

质量检查清单

完成前需验证:普遍适用性(每条指令适用于每次会话或每个任务、用户级无项目特定命令、无可能不存在的工具引用);指令经济(在预算内、不与 Claude Code 内置行为冗余、示例精简或移入参考文档);非 LLM 式 Linter(无具体命名示例、无注释格式规则、无文件头要求、样式指引限于哲学);渐进式披露(复杂主题引用外部文档、主文件用户级 100 行以内、项目级 150 行以内、示例放在参考文件而非内联);清晰性(标题层级一致、无冲突指令、可执行指令而非模糊指引)。

常见陷阱

过度指定、样式强制、过时命令(构建/测试命令与实际工具脱节)、自动生成(使用 /init 而非手工编写)、工具假设(引用并非总是可用的 MCP 服务器或工具)、冲突规则、指令膨胀(每次受挫就加规则而非修复根因)。

使用方式

快速开始步骤:确定范围(用户级 ~/.claude/ 或项目级 .claude/);应用 WHAT/WHY/HOW 框架(仅项目级);将指令保持在预算内;绝不把 Claude 当作 linter(样式规则属于工具);最终定稿前用质量检查清单验证。整合方式:用户级可符号链接到 ~/.claude/CLAUDE.md 或直接放置;项目级提交到仓库根目录的 .claude/CLAUDE.md。验证方式为启动新的 Claude Code 会话,观察指令是否被遵循。

适用场景

适合需要为 Claude Code 编写或审查 CLAUDE.md 配置文件的场景,尤其是希望控制指令数量、区分用户级与项目级配置、避免样式强制类指令的用户。

限制

不适用于快速的一次性项目(直接使用默认值即可)、已有维护良好的 CLAUDE.md 的项目、团队已建立成熟模式的项目。另需注意,该技能的具体安装命令、平台支持和其他技术细节资料中暂未提供。