SuperAPI AI 工具集

writing-claude-md-files

智能体与模型

查看项目

更新于 10-15 21:36

技能介绍

用途:帮助为项目编写或更新 CLAUDE.md 文件,让 Claude 在无状态会话中保留上下文,避免每次重新解释架构意图。

主要能力:区分顶层与子目录两类文件。顶层写“如何在此代码库工作”,包括技术栈、命令、项目结构、约定与可编辑边界;子目录写“为何存在及其承诺”,包括目的、契约(暴露/保证/期望)、依赖与边界、关键决策、不变量、关键文件与陷阱。Claude 会自动从当前目录向上读取 CLAUDE.md。

使用方式:顶层模板含技术栈、命令、结构、约定、边界;子目录模板含目的、契约、依赖、决策、不变量、关键文件、陷阱。每个文件必须包含“Last verified”日期,且须用 Bash 执行 date +%Y-%m-%d 获取真实日期,不得臆造。引用文件时只写文件名,不要用 @ 语法,以免强制加载消耗 token。

适用场景:领域存在非显而易见的契约、架构决策影响演进、存在代码中不明显的不变量,或新会话反复需要同样上下文时创建子目录文件。

限制:不要为琐碎工具目录或频繁变动的实现细节创建;顶层建议少于 300 行,子目录少于 100 行;不要写代码风格规则、详尽命令列表、敏感信息,也不要重复父级内容。更新时须核对契约、删除过时内容并更新日期。