展开知识库目录
写教程前怎样定义读者起点、最终成果和失败现场
正常教程首先解决内容本身:读者现在卡在哪里、已有何种环境和材料、照做后会看到什么。
教程开写前先定义读者能做什么
正常教程首先解决内容本身:读者现在卡在哪里、已有何种环境和材料、照做后会看到什么。框架、SEO 和 AI 只是辅助,不能替代真实步骤。
写读者起点
明确角色、经验、设备、软件版本、权限和已有材料,不用“零基础”概括所有差异。
把主张对应到原始素材、采访、数据、链接和发布日期;示例与真实事实必须明确区分。
写一个失败现场
给出读者真实症状、错误或错误结果,避免用抽象痛点代替。
确认“写一个失败现场”已经有可回查结果,再进入“确定最终成果”;依据仍然来自猜测时,把缺口单列并停在当前步骤。
确定最终成果
结果是文件、配置、检索式、表格、图片或决策,并写怎么判断正确。
确认“确定最终成果”已经有可回查结果,再进入“决定必要内容”;依据仍然来自猜测时,把缺口单列并停在当前步骤。
决定必要内容
只有影响完成的概念、步骤、例子、截图、排错和来源才保留;不需要的板块不因模板加入。
确认“决定必要内容”已经有可回查结果,再进入“列证据缺口”;依据仍然来自猜测时,把缺口单列并停在当前步骤。
列证据缺口
操作未实测、图片未生成、数据无来源或版本未核对时,先补材料而不是扩写。
每次修改只改变当前章节负责的问题,已经核实的数字、限定条件和引用不得顺手漂移。 完成后把证据归入“教程任务说明书”。
完成后应能在“教程任务说明书”中找到与这一步对应的记录;仍需靠猜测补全,就停在这里。
任务说明书是编辑的拒绝标准
正文某一节不能帮助读者从失败现场走向成果,就删掉或重写。先让教程可用,再做标题和元数据优化。
