编写项目说明

约定多人或较大任务的目标、范围与验收方法。

先写会影响实施的决定

当任务涉及多个页面、业务规则或协作者时,把约定写进项目文件,避免每次聊天重新解释。

  • 目标:要解决哪个具体问题,给谁使用。
  • 范围:这次做什么,明确不做什么。
  • 资料:依据哪些文件,哪些内容不能发给外部服务。
  • 完成条件:用哪些操作、数据或检查确认结果。

示例:字数统计网页

项目说明示例,可保存为 README.md
# 字数统计网页
用途:输入文字后实时显示字符数。
范围:一个 index.html,不连接外部服务,不做登录。
规则:标点计数,空格和换行等空白不计数;按 Unicode 码点计数。
检查:空输入为 0;你好为 2;你好 AI! 为 5。
后续改动:添加清空按钮后,要重复上述检查。

说明要跟着实际改动更新

需求变更时,同步修改文档中的规则和检查方法。尚未决定的事项写明待确认,不让 AI 自行当作既定方案。

团队模板可能使用 proposal、design、tasks 等文件,分别记录提议、设计和任务;按仓库自己的说明使用。单个网页练习不必额外建这套文档。