T learn.traeai

第 2 节 · 本站原创中文课程 · 建议 35 分钟

第二节:让项目规则可读、可验证

学完能做:写出简短、准确的 CLAUDE.md,并验证规则是否影响输出。

把规则当作可维护的项目文档

CLAUDE.md 适合保存团队共同使用的项目结构、构建方式、测试入口和约束。它不等于数据库或永久聊天记录。先收集仓库里真实存在的命令,避免把猜测写成项目规范。

参考原文:02-memory/README.md ↗

规则要对应一个可观察的动作

与其写“代码要高质量”,不如写“修改解析器时运行解析器测试,并记录通过或失败”。给目录、命令和验收方式,比堆积口号更有用。下面是本站练习模板,命令必须替换为当前项目真实入口。

# 项目协作约定
## 结构
- src/: 业务实现
- test/: 对应测试
## 验收
- 修改后运行:<项目真实测试命令>
- 未运行时注明原因,不宣称通过
## 边界
- 不把凭据写入代码或日志
- 发布和外部写入按任务授权执行

区分共享规则与个人设置

团队规则提交到仓库,个人习惯和本地路径应放在适合个人的配置中。不要在共享文档保存密钥。子目录规则应补充局部约定,避免与根目录互相矛盾;具体加载范围按当前版本文档核对。

用对照任务检查是否有效

选择一个需要触发规则的任务,例如修改一个函数。记录加载了哪些文件、输出是否包含测试证据。规则写进文件不代表每次都被正确遵循,关键操作还要通过程序校验和人工审查。

这是本站独立编写的讲解与示例,并非官方课程逐字翻译。理解之后,请完成下面的练习、自测和笔记。

参考来源:luongnv89 / claude-howto · 社区开源教程

动手,把理解变成成果

本节练习

正在读取本机草稿…

为练习项目写一份不超过一屏的 CLAUDE.md,含真实测试命令、目录说明和两条可验收边界。设计一次验证任务。

34 / 6000 字。本页不执行代码;可下载后在本地运行,或用 Agent 获取定性建议。

给我一个提示

从 package.json、README 或构建文件确认测试命令。

查看参考思路(本站预写,非实时 Agent)

只保留结构、真实测试入口和发布边界。让助手修改一个函数,核对是否运行指定测试;没有环境时列出检查步骤并标待测。

人工自评:逐项核对自己的作品

这些勾选由你确认,不是自动测试结果。遇到待测项,请在作品里明确注明。

理解自测

项目记忆最适合保存哪类信息?

自己的学习笔记

0 / 3000 字 · 仅保存在此浏览器

围绕当前章节学习

Agent 答疑与作品评价

正在检查连接…

本站讲解、提示、参考思路和自测可独立使用。连接模型服务后,才能实时提问或评价;这里不会把预写内容伪装为 Agent 回答。

走完学习闭环

完成本节

保留练习、勾选人工自评并通过自测后,可记录完成。修改作品或答案会重新打开本节。

课程进度:0 / 10 · 本机记录,不是外部官方证书

← 上一节:第一节:把重复任务变成命令