name: project-memory description: 生成CLAUDE.md项目内存文件,以传递机构知识,而非明显信息。适用于设置新的新闻项目、入职协作者或记录项目特定怪癖。包括编辑工具、事件网站、出版物、研究项目、内容管道和数字档案的模板。
项目内存生成器
创建CLAUDE.md文件,以传递部落知识,而非明显信息。想象一下,像一位资深记者在入职一位能干的同事时那样思考——你不解释新闻工作的一般方式,你解释你的项目的怪癖。
什么应包含在CLAUDE.md中
| 包括 | 不包括 |
|---|---|
| 项目特定怪癖 | 新闻工作的一般方式 |
| 你的命名约定 | 标准文件组织 |
| 带有你的标志的命令 | 通用命令如“npm install” |
| 非明显架构 | 框架文档 |
| 在此项目中的常见错误 | 一般最佳实践 |
| 外部服务配置 | 已在注释中的信息 |
| 源处理要求 | 基本道德人人皆知 |
删除测试
对于你写的每一行,问:“有经验的记者是否已经知道这个?”
- 如果是 → 删除它
- 如果不是 → 保留它
基本模板结构
# CLAUDE.md
## 项目概述
[最多1-2句话。这是什么 + 谁使用它。]
## 命令
[仅项目特定命令。非通用命令。]
## 架构
[仅非明显决策。X存放在哪里?为什么?]
## 模式
[仅此项目独有的模式]
## 要避免的事情
[项目特定的反模式和陷阱]
## 外部依赖
[API、服务、凭据位置]
应无情删除的内容
人人皆知的通用命令:
<!-- 删除这个 -->
git add . # 暂存更改
npm install # 安装依赖
明显的新闻模式:
<!-- 删除这个 -->
我们在发布前验证事实。所有引用必须
归因。遵循美联社风格...
框架解释:
<!-- 删除这个 -->
React组件存放在/components中。我们使用钩子
进行状态管理...
应保留的内容
项目特定怪癖:
<!-- 保留这个 -->
电子表格中的源名称使用姓, 名格式
但CMS期望名 姓。导入脚本处理
这个,但手动条目需要翻转。
非明显架构:
<!-- 保留这个 -->
禁运日期在CMS中存储为纽约时间但
以读者本地时间显示。服务器端渲染
使用UTC。在更改日期代码前检查时区处理。
让你吃过亏的陷阱:
<!-- 保留这个 -->
AP订阅源在4小时后静默断开。:00的Cron作业
检查连接并在陈旧时重启。
语调指南
- 直接简洁
- 像你留给自己的笔记
- 无营销语言
- 无“欢迎来到…”介绍
- 无“这个项目是…”填充
示例:好与坏
坏(太啰嗦、明显):
# CLAUDE.md
## 概述
欢迎来到我们新闻编辑室的故事追踪系统!这是一个
使用React和Node.js构建的Web应用,帮助
编辑和记者协作故事。
## 入门指南
首先,确保已安装Node.js。然后:
npm install
npm start
好(仅部落知识):
# CLAUDE.md
## 概述
都会版故事追踪器。React + Supabase。
## 陷阱
- 故事slug必须在所有版面中唯一,不仅都会版
- “暂存”状态不会停止自动发布cron——使用“终止”
- 记者下拉菜单缓存1小时;新入职者不会出现
## 命令
npm run sync-ap # 从AP拉取最新,:15自动运行
## 凭据
Supabase密钥在1Password“都会版”保险库,而非.env
长度指南
一个好的CLAUDE.md是50-150行。如果更长,你在解释过多。如果更短,你可能遗漏关键怪癖。
新闻特定模板
模板位于templates/目录:
| 模板 | 用于 |
|---|---|
editorial-tool.md |
新闻编辑室工具、事实检查器、AI助手 |
event-website.md |
会议、研讨会、竞选网站 |
publication.md |
新闻简报、播客、持续内容系列 |
research-project.md |
调查、数据新闻具有定义范围 |
content-pipeline.md |
CMS工作流、发布自动化 |
digital-archive.md |
历史收藏、文档仓库 |
模板选择指南
你在构建什么?
├── 新闻编辑室的工具 → editorial-tool.md
├── 事件网站 → event-website.md
├── 持续内容系列 → publication.md
├── 一次性调查 → research-project.md
├── 发布自动化 → content-pipeline.md
└── 存档/保存 → digital-archive.md
如何使用模板
- 复制适当模板到项目根目录作为
CLAUDE.md - 用你的具体内容填充括号中的占位符
- 删除任何不适用的部分
- 当你发现时添加项目特定陷阱
- 保持更新——过时的CLAUDE.md文件导致混乱
最好的CLAUDE.md文件是由那些被他们记录的怪癖坑过的人写的。