< 教程:教程
如你所见,这是一篇教程的教程 (XD。
教程创作的目标有多个,让新人更快熟悉内容、让老人找内容更方便,本篇教程将以教程编写为主题,介绍使用mediawiki(以下简称wiki)编写教程的主要流程和技术细节,并着重找出技术文档和教程的关键区别。
主要流程
这部分内容按照编写流程介绍
圈定编写范围
如章节名称所示,第一步定范围,即准备好要写什么内容。同时可以确定教程的分类和相关页面。
收集并整理材料
接下来是整理材料的环节,从第三方获取二手资料、或者回顾自己以前的实践经验。
制定阅读流程
这个部分相对比较难,因为编写教程的人可能难以找出让新人容易理解的切入点。
因此这里提供两种方案来撰写简单易懂的教程:
- 找一个新人,根据TA的学习路径来撰写教程
- 自己是新人,在自己学习的过程中直接撰写教程
反馈和修订的循环
在撰写完成,即第一版发布之后,可以根据反馈来不断提升内容质量。
wiki的讨论功能就很适合这种场景。
技术细节
这部分内容将使用类似技术文档的方式划分章节,
利用子页面规划章节
使用子页面分割内容可以缩短单个页面的长度,让整体更容易阅读。子页面自带的返回上级页面的功能适合需要反复阅读主页面来建立整体框架的场景。
文档 VS 教程
这个部分尝试列出文档和教程的区别,以供参考。
- 文档注重于详细地表述技术细节,而教程的主旨是让观者理解总体的知识框架。
- 文档使用专有术语来划分概念,而教程会先使用通俗易懂的词语解释专有术语。
- 文档假定阅览人员有知识背景,而教程需要考虑无基础的阅读者。