教程编排
先组织内容,再设计版式。输入为目标读者、要完成的任务、已有材料和允许修改的范围;输出为可运行网页及源文件。用户当前要求优先。
内容组织
- 按实际操作顺序分章;一节解决一个主要问题,材料、要求、步骤与模板集中在一起。
- 标题简短、自明,直接写对象或动作。目录与正文一致,一般用章、节两层。
- 通用原则集中写一次;每节开头只写本节特殊要求。
- 合并零散卡片,删除重复说明、空泛铺垫和无信息的俏皮话。句子写清对象与动作。
- 原则直接展示;长代码、完整提示词和补充材料按需展开。提示词注明输入、输出与可编辑范围。
图例与批注
先给完整案例,再解释关键位置。文字案例保留一个自然段;流程图展示完整输入、操作、输出与衔接。只在批注有助于理解时使用,不给操作流程强塞段落案例。
高亮、编号与旁注一一对应。旁注写清做了什么、解决什么问题、在整体中起什么作用。按原文顺序排列,靠近对应位置;窄屏改为上下排列。颜色辅助对应关系,不能单独承担含义。
区分原文、译文、教学改写与占位模板,保留出处和复用边界。用户取消双语时保留一种连贯版本,不拆成零散逐句卡片。
交付检查
检查目录是否形成连续任务路径,模板是否可直接复制,图中文字与箭头是否清楚,窄屏是否溢出,链接与下载是否可用。保留素材事实与数据;公开包仅含获授权内容,移除凭据、机器路径、个人隐私和未公开材料。
原创规则:Da1yuqin / PaperBank & StrongResponse。CC BY 4.0;转载保留署名、原文链接与许可,改写注明改动。