撰写以任务为导向的文档
以任务为导向的文档就是教用户怎么做的文档。作者要站在用户的角度理解各项任务。对于复杂的任务,应该把它分成多个子任务,避免让话题太长。
面向目标读者
写文档也要“看人下菜碟”。对管理者,文档可能只写整体的任务即可,对于基层操作员,文档要写得足够详细。
以用户视角呈现信息
需要用户操作的地方要用第二人称和主动语态来写,以此来表明操作的执行者是用户自己。
交代任务的背景和原因
在任务的开头要告诉用户为什么要做这个任务,做完这个任务能解决什么问题,实现什么效果。
在合适的地方解释细节问题
不能一味地告诉用户点这里,点那里,这样会让用户不知道自己在做什么,为什么要这样做。所以要在合适的地方解释为什么。
聚焦真实任务而非产品功能
避免只介绍产品的功能,要告诉用户怎样使用这些功能解决他们工作中的问题。
标题要能揭示任务的目的
标题应该让用户一眼就能看明白你要教他做什么。
将主任务拆解为子任务
任务话题的步骤应该小于等于9。太长的话题会让人失去兴趣,而且读到后面会忘记前面。给复杂任务写文档时,先捋顺主线任务有哪些子任务,这些子任务之间的关系如何,然后在把子任务分别写出来,最后按时间顺序、逻辑顺序或流程顺序排列好。
提供清晰、逐步的操作说明
操作步骤一定要清晰、完整。否则用户很容易失败,影响了用户的体验就会影响用户对产品的印象,从而影响企业的经济利益。