1.9 KiB
1.9 KiB
CLAUDE.md
Claude Code 的仓库级上下文。进入本仓库后,先读本文,再读
AGENTS.md和docs/00-ai-start-here.md。
仓库用途
这是 harness coding 文档样本库,目标是提供一套新项目启动前可复制的 AI coding 文档模板。
这套模板参考了 D:\opc_project\lingo\docs 的真实项目文档结构,但本仓库产物应保持通用,不绑定 lingo 的业务、数据、技术栈或任务状态。
关键事实
- 根目录
README.md是样本库总入口。 docs/README.md是模板文档导航。docs/00-ai-start-here.md是新项目中 AI agent 的工作入口模板。docs/05-coding-rules.md是新项目中 AI agent 的硬约束模板。docs/06-tasks.md是任务看板模板,强调每轮只做一个任务。docs/current-state.md用来记录代码现实,防止文档计划和实际状态脱节。
Claude 工作方式
处理本仓库任务时:
- 先确认用户是在要求修改模板本身,还是要求基于模板生成某个具体项目的文档。
- 如果是修改模板,保持通用占位符和可复制性。
- 如果是生成具体项目文档,允许替换占位符为该项目事实,但不要污染通用样本,除非用户明确要求覆盖模板。
- 修改文件前先读相关模板,保持同一套命名和结构。
- 修改后检查文档导航是否仍完整。
不要做
- 不要把真实密钥、token、账号、私有 URL 写入模板。
- 不要把旧项目的具体事实写成新项目通用规则。
- 不要把模板改成只适合某一种技术栈,除非用户明确要求。
- 不要在没有用户要求时创建应用代码、依赖配置或构建脚本。
常用检查命令
Get-ChildItem -Recurse -File
rg -n "AGENTS.md|CLAUDE.md|00-ai-start-here|05-coding-rules|06-tasks" .
如果 rg 不可用,使用 PowerShell Select-String。