写第一份项目说明
01-03 写第一份项目说明
Section titled “01-03 写第一份项目说明”这一课把上一节的需求澄清记录整理成项目说明。项目说明是编程实战的施工图:它告诉 AI 要做什么,也提醒学员哪些范围已经确认,哪些想法要暂缓。
本课重点是让项目有清楚边界。后面生成代码、画界面、跑项目、排错、验收,都会回到这份项目说明。
这一课的成果是一份「第一版项目说明」。
- 能把需求澄清记录整理成项目说明。
- 能写清项目名称、目标、场景、功能、输入、输出、验收。
- 能设置暂缓需求区。
- 能让 AI 帮忙润色,但由学员确认边界。
- 能保存项目说明到项目文件夹。
- 建议时长:20 到 30 分钟。
- 用上一节保存的需求澄清记录继续演示。
- 强调项目说明是施工图,后面每一章都会用。
- 屏幕上展示说明从混乱记录变清楚文档的过程。
- 收尾让学员确认“第一版只做什么”。
- 需求澄清记录。
- 项目文件夹。
- AI 工作台工具。
- 空白项目说明文档。
可以这样开场:
“上一节,我们让 AI 帮我们追问需求。现在这些回答还像散落在桌上的纸条。今天要把它们整理成一张施工图。”
第一份项目说明包括八块内容。
第一,项目名称。
名称要让人一眼知道它做什么。比如“CSV 转 Markdown 小工具”“课程资料导航页”“文件命名清洗器”。
第二,项目目标。
用一句话说明它解决什么麻烦。比如“把粘贴进来的 CSV 内容转成可复制的 Markdown 表格”。
第三,使用场景。
说明谁在什么时候打开它。越具体越好。比如“整理课程资料时,把表格内容粘贴到文档里”。
第四,第一版核心功能。
只写当前版本要做的功能。一个输入区、一个转换按钮、一个结果区、一个复制按钮,这就足够清楚。
第五,输入材料。
写出输入格式和样例。样例最好脱敏。
第六,输出结果。
写出输出格式和用途。比如 Markdown 表格,可以复制到文档。
第七,验收标准。
写清怎么判断完成。比如“输入三行 CSV 后,输出三行 Markdown 表格,复制到文档后格式正常”。
第八,暂缓需求。
把上传文件、下载结果、历史记录、漂亮动画这些想法放进暂缓区。它们没有消失,只是排队。
最后收束:
“项目说明是给 AI 的施工图,也是给自己的边界线。说明越清楚,AI 越容易帮你把想法做成能运行的东西。”
屏幕演示流程
Section titled “屏幕演示流程”- 打开需求澄清记录。
- 新建项目说明文档。
- 让 AI 根据澄清记录整理第一版项目说明。
- 人工检查项目目标、输入、输出、验收是否清楚。
- 把过大的功能移到暂缓需求。
- 保存项目说明到项目文件夹。
- 在 README 或日志里记录项目说明位置。
给 AI 的协作卡
Section titled “给 AI 的协作卡”请根据下面的需求澄清记录,整理一份第一版项目说明。
请包含:1. 项目名称2. 项目目标3. 使用场景4. 第一版核心功能5. 输入材料6. 输出结果7. 验收标准8. 暂缓需求
请保持范围小,优先保证第一版能运行、能验收。第一版项目说明
Section titled “第一版项目说明”- 项目名称:
- 项目目标:
- 使用场景:
- 第一版核心功能:
- 输入材料:
- 输出结果:
- 验收标准:
- 暂缓需求:
让学员把自己的需求澄清记录整理成项目说明。
要求:
- 第一版核心功能控制在 3 到 5 项。
- 输入和输出必须有样例。
- 暂缓需求至少写 2 项。
- 项目目标写得像口号:改成“处理什么输入,得到什么输出”。
- 核心功能过多:只保留能跑通主流程的功能。
- 验收标准太虚:写成能人工检查的结果。
- 暂缓需求舍不得放:提醒学员后续版本还能继续做。
完成第一版项目说明,并保存到项目文件夹。
提交内容:
- 项目说明文档。
- 暂缓需求区。
- 一句话第一版目标。
- 第 1 页:项目说明是施工图
- 第 2 页:八块内容
- 第 3 页:从澄清记录到说明文档
- 第 4 页:暂缓需求区
- 第 5 页:第一版项目说明