第 30 课 作品说明文档
所属课程
青少年高级营
所属模块
模块 D：高级营结营作品
本课概览
- 讲解核心：怎样讲清技术结构、功能、角色和流程。
- 本课重点：怎样讲清技术结构、功能、角色和流程。
- 课上产出：项目说明页。
- 示例场景：校园图书角借阅与学习任务平台，或校园互助学习平台的系统结构
本课知识图谱
- 完整应用一定要同时考虑用户、角色、页面和流程。
- 系统图和页面树的作用，是把复杂项目讲成可讨论、可修改的结构。
- 一个系统说得清，后面的数据库、接口和管理端才有落点。
- 本课重点要落在“怎样讲清技术结构、功能、角色和流程。”上。
课前准备
老师准备
- 提前准备与“校园图书角借阅与学习任务平台，或校园互助学习平台的系统结构”相关的课堂示例页或草图，方便学生先看见成品轮廓。
- 准备一张“角色与页面对应关系图”作为课堂演示图。
- 准备一张“一条完整用户流程图截图”作为课堂演示图。
- 把本课阶段成果“项目说明页。”的评价标准提前写在板书或投屏页上。
学生准备
- 准备好本节课会用到的文字、图片或题目素材。
- 带着“作品说明文档”相关的一个真实使用场景进入课堂，方便快速进入任务。
- 准备在课堂上记录一张草图、流程图或问题清单。
本课素材清单
- 角色卡：学生、老师、管理员
- 页面树模板或流程图模板
- 一个完整动作的路径说明，例如“提交作业”或“借阅图书”
- 阶段成果模板：项目说明页。
- 参考来源：technical-writing
可直接使用的素材正文
示例文本
text
系统说明示例
角色：学生、老师、管理员
学生要做：查看内容、提交任务、查看反馈
老师要做：发布内容、查看提交、修改状态
管理员要做：维护数据、处理异常、查看统计
课堂问题：如果同一条数据既要给学生看，又要给老师改，它应该放在哪一层最合适？示例数据 / 字段
text
系统图节点：
- 用户端页面
- 管理端页面
- 数据记录
- 流程动作练习题 / 操作任务
text
练习 1：给“校园图书角借阅平台”补一条“老师操作流程”。
练习 2：画出“学生提交借阅申请 -> 老师确认 -> 状态更新”的 3 步流程。
练习 3：判断“借阅状态”这个数据应该出现在学生端、老师端还是两边都要出现。成套素材包
text
系统结构讲解素材
角色 1：学生 —— 查看内容、提交任务、查看反馈。
角色 2：老师 —— 发布内容、查看提交、修改状态。
角色 3：管理员 —— 维护数据、处理异常、查看统计。
流程示例：学生提交借阅申请 -> 老师审核 -> 状态更新为“已借出” -> 学生再次查看时看到最新状态。课堂练习题组
text
1. 给这个系统再补 1 条“老师操作流程”。
2. 画出“学生提交 -> 老师处理 -> 状态更新”的 3 步流程。
3. 判断“借阅状态”应出现在学生端、老师端，还是两边都要出现。
4. 用一句话解释前端、后端和数据库在这个例子里的分工。长正文素材
text
系统结构讲解长正文示例
这一页的目标，是把“前端、后端、数据库、角色”这些听起来有点远的词，讲成学生能想象的真实流程。导语可以这样写：一个网站不是只有页面，它背后还有不同的人在用、不同的数据在流动、不同的动作在发生。只要把角色和流程拆开来看，系统结构就不会那么抽象。
主体段一：可以先从三个角色开始讲。学生负责查看内容、提交任务、接收反馈；老师负责发布内容、处理提交、修改状态；管理员负责维护数据、处理异常、查看统计。角色一旦分清，学生就会明白为什么同一个系统里会有不同页面。
主体段二：再用一条最短流程把结构串起来：学生提交借阅申请，老师审核，系统把状态更新为“已借出”，学生再次查看时就看到最新结果。只要学生能把这四步顺着讲出来，系统结构的主线就已经进脑子了。
教师串讲语：这一类课最怕讲成抽象名词堆。要不断把它拉回“谁在做动作、动作改了什么、别人为什么会看到变化”这条线，学生才会觉得它和真实项目有关。
页面收束语：系统结构并不是更难的页面，而是让学生第一次看到，一个作品背后其实有角色、有流程、有数据、有状态。页面文案建议
- 说明句式：谁进入页面、先做什么、系统再处理什么。
- 过渡句式：同一份数据，不同角色会看到不同重点。
可替换素材方向
- 先讲清角色和流程，再讲页面和数据。
- 一个系统图里先不要超过 3 个角色和 5 个关键动作。
主视觉配图
页面示例配图
截图规划示意
60 分钟教学展开
0-15 分钟：提出问题并界定任务
讲解推进
- 从“作品说明文档”对应的真实学习或校园情境切入，让学生知道这节课要解决的具体问题。
- 用问题清单或情境提问带出“怎样讲清技术结构、功能、角色和流程”这一主线，先把讨论范围收拢。
- 明确今天 1 小时的阶段成果是“项目说明页”，让学生知道最后要交付什么。
本段知识点
- 先从“作品说明文档”的真实使用场景入手，帮助学生知道今天为什么要学这一课。
- 完整应用一定要同时考虑用户、角色、页面和流程。
- 系统图和页面树的作用，是把复杂项目讲成可讨论、可修改的结构。
建议展示 / 截图
- 角色与页面对应关系图
- 作品说明文档的课堂任务卡或成果示意图
本段资料与素材
- 角色卡：学生、老师、管理员
- 任务说明卡 1 份
本段逐字稿
text
【本段开场】
同学们，先把今天这节课放回一个真实项目里。课题是“作品说明文档”，但我们真正要看的是：当系统里开始出现“怎样讲清技术结构、功能、角色和流程”时，项目会发生什么变化。
这一模块要把作品往更完整产品推进，重点是平台延展、订单意识、运营视角和最终展示。
先把情境放回真实项目里去想。假如现在面对的是“校园图书角借阅与学习任务平台，或校园互助学习平台的系统结构”，如果没有今天这一层，这个系统最容易卡在哪里？
我们先看“角色卡：学生、老师、管理员”。看示例的时候，不只是看页面长什么样，而是看角色、数据和流程到底是怎样被摆出来的。
先把这节课放回“更完整产品”的视角里，让学生知道今天是在补商业、平台、说明或展示层。
先把使用场景讲稳，比先记术语更重要。只要学生知道这一层在解决谁的麻烦，后面结构就会顺很多。
这一段先把场景、角色和目标收稳。起点一旦说清，后面系统图和流程线就不会飘。
你们现在先不要急着回答得很大，只要先把“谁、做什么、最后留下什么结果”说清，就已经够用了。
如果系统真的给别人用，今天这一层为什么迟早要补？
等会儿我们会从一个最小例子开始，不是为了把事情讲简单，而是为了把关键关系先讲准。
等会儿我会先把今天这一课放回完整产品视角里，不急着只看单个页面。你们要先看见这一步为什么会在后期出现。
这一段一直要记住：开始像一个在把作品讲成完整产品的人。只要你开始会判断角色、数据、页面和流程的关系，这节课就已经不只是“多学几个新词”了。
如果到了这一段结束，你还只能说个大概，我们就再回到示例图和流程线多收一遍。系统类的内容一旦关系没收住，后面每加一层都会更乱。
这一节先收住：当作品开始面对真实使用、说明或展示，它就已经在往产品走。
【本段收束】请同学们用一句话说出这一段你最确定的一点，再进入下一段。老师演示提示词（给 Codex）
用途：把下面这段直接复制给 Codex，用来生成本段课堂演示页或功能示例。
text
请直接实现一个给八至九年级学生看的“产品延展与展示页”课堂开场页。 本课主题是“作品说明文档”，页面场景使用“校园图书角借阅与学习任务平台，或校园互助学习平台的系统结构”。 请直接输出可实现的网页页面，优先使用单文件 HTML（内含 CSS 和 JavaScript），不要只给方案说明。 页面必须包含：场景说明区、关键页面或流程区、状态或亮点区、结尾展示区。 核心内容请围绕“怎样讲清技术结构、功能、角色和流程”来实现。 页面重点突出：这一课是在把作品往更完整产品推进。 页面要让人一打开就知道这页在做什么。 首屏要有主题说明、核心内容区和一个明确入口，可以保留一个开始按钮或继续入口。 页面排版要清楚，标题醒目，分区明确，按钮和反馈明显。除了界面，还要把角色、数据、流程或状态关系讲清，不要只做外观示意。课堂动作
- 先用 1 到 2 分钟让学生说出自己对“作品说明文档”最直观的理解，再进入示例页。
阶段成果
- 完成本课任务目标和阶段成果的确认。
15-30 分钟：梳理结构、角色或判断标准
讲解推进
- 把“怎样讲清技术结构、功能、角色和流程”拆成 2 到 3 条可判断的标准，帮助学生形成稳定的思考框架。
- 借助结构图、流程图、角色卡或页面树，把抽象想法转成可视化的组织方式。
- 通过对比示例说明哪些内容属于本节课必须保住的核心，哪些内容可以留到后面扩展。
本段知识点
- 把“怎样讲清技术结构、功能、角色和流程。”拆成可观察、可操作的页面结构或流程关系。
- 完整应用一定要同时考虑用户、角色、页面和流程。
- 系统图和页面树的作用，是把复杂项目讲成可讨论、可修改的结构。
建议展示 / 截图
- 一条完整用户流程图截图
- 作品说明文档的结构草图、流程图或区域标注图
本段资料与素材
- 页面树模板或流程图模板
- 结构草图模板 1 份
本段逐字稿
text
【本段开场】
现在我们不急着继续堆功能，先把这节课最关键的关系拆开。只要这一段能听明白，后面很多看起来复杂的词都会落到具体动作上。
这一模块要把作品往更完整产品推进，重点是平台延展、订单意识、运营视角和最终展示。
这一段继续围绕“校园图书角借阅与学习任务平台，或校园互助学习平台的系统结构”往下看。我们不是再换一个新例子，而是把同一个场景里的结构关系真正拆开。
这一段继续借“页面树模板或流程图模板”来拆关系。你们要边看边判断：这一块到底是在交代页面、数据，还是流程。
把订单、统计、平台选择或展示表达拆开，帮助学生理解一个作品怎样逐渐像真正产品。
这一段最怕的是把关系讲散。我们要一直顺着“谁在用、谁处理、结果去哪”这一条线往下走。
这一段最关键的是把复杂内容讲成顺着走的关系。先看谁在用，再看谁处理，最后看结果去哪。
这一步要不断追问：它到底在系统里负责哪一层？如果答不上来，就说明关系还没有收稳。
订单、统计、平台选择和展示表达里，哪一个最像“让作品进入真实世界”的门槛？
接下来这几分钟，你们要重点听“关系”而不是只听名词。名词可以晚一点记，关系不能听散。
这一段我会一直围绕“价值、流程、说明、展示”来讲，让学生意识到作品往后走不只是继续写页面。
这一段一直要记住：开始像一个在把作品讲成完整产品的人。只要你开始会判断角色、数据、页面和流程的关系，这节课就已经不只是“多学几个新词”了。
如果到了这一段结束，你还只能说个大概，我们就再回到示例图和流程线多收一遍。系统类的内容一旦关系没收住，后面每加一层都会更乱。
只要能把流程、价值和表达说顺，项目就会比只停在功能上更完整。
【本段收束】请同学们用一句话说出这一段你最确定的一点，再进入下一段。老师演示提示词（给 Codex）
用途：把下面这段直接复制给 Codex，用来生成本段课堂演示页或功能示例。
text
请直接实现一个给八至九年级学生看的“产品延展与展示页”结构拆解页。 本课主题是“作品说明文档”，页面场景使用“校园图书角借阅与学习任务平台，或校园互助学习平台的系统结构”。 请直接输出可实现的网页页面，优先使用单文件 HTML（内含 CSS 和 JavaScript），不要只给方案说明。 页面必须包含：场景说明区、关键页面或流程区、状态或亮点区、结尾展示区。 核心内容请围绕“怎样讲清技术结构、功能、角色和流程”来实现。 页面重点突出：把平台选择、订单流程、统计视角或展示顺序讲明白。 页面要把区块分工、流程顺序或阅读路径讲清。 请用分区标题、编号、箭头、步骤标签或结构图，把每一块分别负责什么写清楚。 页面排版要清楚，标题醒目，分区明确，按钮和反馈明显。除了界面，还要把角色、数据、流程或状态关系讲清，不要只做外观示意。课堂动作
- 带学生一起把今天的页面、流程或知识结构画成一张简单草图，边讲边标注。
阶段成果
- 形成一张结构图、分区图或流程图草稿。
30-45 分钟：输出草图、清单或方案稿
讲解推进
- 组织学生完成“项目说明页”的第一版草图、清单或方案稿。
- 要求学生在产出中体现“怎样讲清技术结构、功能、角色和流程”，而不是只写一个空标题。
- 讲师边巡视边帮助学生把范围收紧，避免方案过大、过散或脱离真实场景。
本段知识点
- 在动手环节里，把“项目说明页。”做成真正能演示的结果。
- 系统图和页面树的作用，是把复杂项目讲成可讨论、可修改的结构。
- 一个系统说得清，后面的数据库、接口和管理端才有落点。
建议展示 / 截图
- 页面树和系统结构图并排显示的截图
- 项目说明页。正在完成中的过程截图
本段资料与素材
- 一个完整动作的路径说明，例如“提交作业”或“借阅图书”
- 项目说明页。的半成品模板
本段逐字稿
text
【本段开场】
下面开始看最关键的一轮演示。今天这一段不求做很多，而是要把一条最短闭环跑顺，让你们看见结果是怎样真的出现的。
这一模块要把作品往更完整产品推进，重点是平台延展、订单意识、运营视角和最终展示。
现在把“校园图书角借阅与学习任务平台，或校园互助学习平台的系统结构”里的关键动作跑起来。只要这一轮动作能看顺，学生就会知道系统不是停在示意图上。
接下来还是先盯住“一个完整动作的路径说明，例如“提交作业”或“借阅图书””。今天这一步不是看热闹，而是看最关键的一轮动作怎样真的跑起来。
现场做出一轮能看出价值、能讲出逻辑的产品页或说明页，让结果不只停在功能本身。
动手时只盯最关键的动作链。只要“项目说明页。”的核心闭环跑通，今天这节课就已经有真实结果。
动手时先保最短闭环。只要今天这条“项目说明页。”核心链路真的跑起来，系统就已经站住一大半。
如果演示一跑就乱，先回到最短流程，不要一边加功能一边猜问题会不会自己消失。
这节课最重要的是让功能更多，还是让别人更容易理解和使用？
下面这一段我会先演示，再回头解释。你们先看顺序，再看每一步分别落在哪一层。
接下来我会做一轮最小产品页或说明页示范，让你们看见这一步怎样把项目从“能做”推进到“能讲”。
这一段一直要记住：开始像一个在把作品讲成完整产品的人。只要你开始会判断角色、数据、页面和流程的关系，这节课就已经不只是“多学几个新词”了。
如果到了这一段结束，你还只能说个大概，我们就再回到示例图和流程线多收一遍。系统类的内容一旦关系没收住，后面每加一层都会更乱。
这一课最值钱的，是你开始知道一个完整项目最终要怎么被理解、被使用、被展示。
【本段收束】请同学们用一句话说出这一段你最确定的一点，再进入下一段。老师演示提示词（给 Codex）
用途：把下面这段直接复制给 Codex，用来生成本段课堂演示页或功能示例。
text
请直接实现一个给八至九年级学生看的“产品延展与展示页”功能演示页。 本课主题是“作品说明文档”，页面场景使用“校园图书角借阅与学习任务平台，或校园互助学习平台的系统结构”。 请直接输出可实现的网页页面，优先使用单文件 HTML（内含 CSS 和 JavaScript），不要只给方案说明。 页面必须包含：场景说明区、关键页面或流程区、状态或亮点区、结尾展示区。 核心内容请围绕“怎样讲清技术结构、功能、角色和流程”来实现。 页面重点突出：做出一轮能演示、能判断价值的产品页。 页面要做出最关键的一轮功能演示，让操作、反馈和结果连成闭环。 必须支持至少一轮真实动作，例如点击、输入、切换、提交、答题、反馈或状态变化，并且操作后立刻出现结果。 页面排版要清楚，标题醒目，分区明确，按钮和反馈明显。除了界面，还要把角色、数据、流程或状态关系讲清，不要只做外观示意。课堂动作
- 讲师边投屏边带做，让学生至少独立完成一次最关键动作。
阶段成果
- 拿到“项目说明页。”的可演示版本。
45-60 分钟：交流修订、形成阶段结论
讲解推进
- 安排小组交流或快速讲述，让学生把自己的方案说给别人听。
- 回到“怎样讲清技术结构、功能、角色和流程”逐条检查，补齐最关键的缺口，形成可进入下一课的阶段版本。
- 围绕“项目说明页”做简短收束，让学生带着清晰版本进入下一课。
本段知识点
- 通过检查、互评和整理，让学生知道这节课的成果怎样继续进入下一课。
- 一个系统说得清，后面的数据库、接口和管理端才有落点。
建议展示 / 截图
- 项目说明页。最终整理后的展示截图
- 同伴互评或发布前检查清单截图
本段资料与素材
- 检查清单 1 份
- 结尾展示顺序卡 1 份
本段逐字稿
text
【本段开场】
最后这一段我们不再继续加内容，而是把今天的结果讲清楚、收整齐。能不能把“项目说明页。”说顺，决定这节课到底有没有真正站住。
这一模块要把作品往更完整产品推进，重点是平台延展、订单意识、运营视角和最终展示。
最后再回到“校园图书角借阅与学习任务平台，或校园互助学习平台的系统结构”这个场景里看一遍结果。系统讲到这里，要能让别人听懂它为什么值得继续做下去。
最后回头看“检查清单 1 份”，重点不在多加内容，而在把已经做出来的结果讲顺、收稳、讲明白。
收束成一套项目收口法，让学生最后能把作品讲成一个完整的产品故事。
这一段的重点不是再扩内容，而是把结果说得清、顺、稳。能复述清楚，才是真的学会了。
这一段收尾时先把结果讲顺、看顺、检查顺。能复述清楚，才是真的会了。
收尾时先看逻辑有没有闭合，再看表达是不是顺。讲不顺的地方，通常也是理解还没彻底收住的地方。
如果最后只能保留一条最重要的产品说明，你会留下哪一句？
最后我会请大家把结果倒着讲一遍：先说今天拿到了什么，再说它是怎样一步步出来的。
最后我会请大家用一句话概括：今天这一层到底让作品更完整在哪。
这一段一直要记住：开始像一个在把作品讲成完整产品的人。只要你开始会判断角色、数据、页面和流程的关系，这节课就已经不只是“多学几个新词”了。
如果到了这一段结束，你还只能说个大概，我们就再回到示例图和流程线多收一遍。系统类的内容一旦关系没收住，后面每加一层都会更乱。
记住，产品成熟的标志，不只是功能多，而是别人越来越能看懂它值不值得用。
【本段收束】请同学们用一句话说出这一段你最确定的一点，再进入下一段。老师演示提示词（给 Codex）
用途：把下面这段直接复制给 Codex，用来生成本段课堂演示页或功能示例。
text
请直接实现一个给八至九年级学生看的“产品延展与展示页”收束展示页。 本课主题是“作品说明文档”，页面场景使用“校园图书角借阅与学习任务平台，或校园互助学习平台的系统结构”。 请直接输出可实现的网页页面，优先使用单文件 HTML（内含 CSS 和 JavaScript），不要只给方案说明。 页面必须包含：场景说明区、关键页面或流程区、状态或亮点区、结尾展示区。 核心内容请围绕“怎样讲清技术结构、功能、角色和流程”来实现。 页面重点突出：把成果收成适合路演、说明或结营展示的版本。 页面要把当前结果整理成适合展示和收束的版本。 页面里要保留结果展示、小结、检查点或下一步，让成果能够直接拿来展示。 页面排版要清楚，标题醒目，分区明确，按钮和反馈明显。除了界面，还要把角色、数据、流程或状态关系讲清，不要只做外观示意。课堂动作
- 安排结对互看或小组展示，让学生把自己的结果讲成一段完整说明。
阶段成果
- 把今天的结果整理成可展示、可提交、可继续修改的版本。
课后作业
必做任务
- 把你今天讲到的系统，再用“谁进入、先做什么、系统再处理什么”的顺序说一遍。
- 把课堂上的“项目说明页。”再补一个更完整的细节，并保留前后对比。
提交建议
- 提交本课产出：项目说明页。
- 附 2 到 3 句说明：你今天做了什么、最满意哪里、还准备改什么。
自查清单
- 我能说清楚这节课做的页面或流程是给谁用的。
- 我能指出页面里最重要的一个区块、一个动作和一个结果。
- 我保存了课堂过程中的草图、截图或记录，方便下次继续。
相关参考
technical-writing