返回提示词库

为项目写一份给 Agent 看的说明

新会话不知道怎么构建、测试,也不知道有哪些约定:写一份一屏以内的说明。

什么时候用 新项目开始时,或换了一个 Agent 工具之后

完成后得到什么

一份简短的项目说明草稿(AGENTS.md 或 CLAUDE.md),确认后写入。

开始前

  • Agent 可以读取整个项目

执行步骤

  1. 查看构建、测试和运行方式
  2. 找出和常规做法不同的约定
  3. 记下容易踩的坑
  4. 控制在一屏以内

应交付的产物

  • 项目说明草稿

完成标准

  • 只写代码里看不出来的内容
  • 写下的命令都能运行
  • 一屏以内
  • 写入前经过你确认

复制给 Agent

只读分析这个项目,写一份给 Agent 看的简短说明:怎么安装、构建、测试和运行,代码约定里和常规做法不同的地方,容易踩的坑。只写从代码里看不出来、每次都用得上的内容,控制在一屏以内。项目里已经有说明文件的话,就在原文件上提修改建议,不要另起一份。先给我看草稿,我确认后再写入。写完草稿就停下。