从当前章节开始,再让任务更容易被跟上
适用人群
技术写作与文档团队
你希望让一章信息密集的内容或设置路径更容易理解,同时不丢失与当前手册的关联。
- 技术写作者
- 文档团队
常见文档:用户手册设置指南产品教育与客户支持团队
你需要为最常把客户带到支持渠道的任务制作可重复使用的指南,同时让来源和版本始终清楚。
- 客户教育团队
- 支持团队
常见文档:帮助文章排障步骤运营与维护团队
当员工在没有现场专家的情况下回看手册时,你希望常规流程及其停止或升级节点仍然清楚可见。
- 运营团队
- 维护团队
常见文档:维护指南设备手册
准备文档
从你已经信任的来源开始
把用户手册、设置指南或排障流程,围绕一个具体任务做成清晰的视频指南。
- 快速上手与设置指南
- 产品与设备手册
- 软件使用说明
- 维护流程
- 排障步骤
- 当前产品文档
开始前建议
- 使用当前、完整的文档或文件版本
- 标出需要重点讲解的章节、步骤、图表或数据
- 指出必须保留的术语、数字、警告或表述
制作路径
从读者真正需要完成的任务开始
- 1
先明确观众的问题
选择一个章节或任务,再说明起点、目标结果、警告事项,以及观众不能遗漏的步骤。
- 2
添加承载细节的源文件
上传当前源文件,并说明讲解必须保留的章节、术语、数字或步骤。
- 3
根据实际使用场景完善讲解
在用户依赖视频前,请文档、产品或支持负责人核查标签、版本信息、警告、步骤顺序,以及指向当前手册的链接。
