SuperAPI AI 工具集

claude-md-writer

编程与开发

查看项目

更新于 10-16 01:58

技能介绍

用途

claude-md-writer 是一个用于创建和优化 CLAUDE.md 文件的技能,遵循 Anthropic 官方最佳实践。CLAUDE.md 是提供给 Claude Code 的仓库级指导文件,用于说明项目结构、命令、架构和开发规则。该技能的核心目标是让 CLAUDE.md 保持精简有效,避免因内容膨胀而导致 Claude 忽略其中的指令。

其黄金法则是:对每一行内容追问“删除这一行会导致 Claude 犯错吗?”如果不会,就删除它。

主要能力

  • 根据项目结构生成初始 CLAUDE.md(/init)
  • 在会话过程中动态添加指令(# key)
  • 支持 @import 语法,从其他文件导入内容,例如引用 README.md、package.json 或 docs/git-instructions.md
  • 提供参考文档:良好示例、常见反模式、质量验证清单、死重审计(5 条裁剪标准)
  • 区分 CLAUDE.md 与 Skills 的适用边界
  • 内容分诊:判断某内容应放入 CLAUDE.md、建议创建 skill,还是仅链接到文档
  • 死重审计:按 5 条标准(是否默认行为、是否冲突、是否冗余、是否临时补丁、是否含糊)逐条审查现有规则,输出裁剪列表、冲突列表和清理后的版本

使用方式

该技能通过以下调用模式工作:

  • /claude-md-writer:完整流程,分析项目并编写或改进 CLAUDE.md
  • /claude-md-writer actualiza con la sesion:从当前会话提取相关信息并添加到 CLAUDE.md
  • /claude-md-writer agrega regla: [descripcion]:以正确格式添加一条具体规则
  • /claude-md-writer revisa y optimiza:审计现有 CLAUDE.md,删除冗余,改进强调
  • /claude-md-writer audita:执行死重审计,应用 5 条标准
  • /claude-md-writer convierte a skill:识别应转为 skill 的内容并提取

处理流程分为四步:分析项目(技术栈、结构、现有文档);应用三个维度(WHAT 项目是什么、WHY 为何存在、HOW 如何工作);按最佳实践编写;用检查清单验证。

编写规范建议:长度控制在 200 行以内(理想约 100 行);结构顺序为仓库概览、存在原因、快速开始与命令、架构概览、关键开发规则、参考链接;关键规则使用 CRITICAL 和 IMPORTANT 强调;采用渐进式披露,用文件引用代替代码片段。

适用场景

  • 为代码仓库创建或改进 CLAUDE.md
  • 审查现有 CLAUDE.md 并清理无效内容
  • 判断某类知识应放入 CLAUDE.md 还是独立 skill
  • 在开发会话中动态补充项目指令

限制

资料未提供该技能的收费、价格、平台支持范围或具体效果数据。其内容主要针对 CLAUDE.md 的编写方法论,不涉及其他类型文件的生成。