手册的小船,怎样才不说翻就翻
打个不恰当的比方,客户面对一个全新产品时,就像是要跨越一条河流。而所能依靠的就是手册这条小船。那么所能收集到的相关信息信息就像是船下潺潺流水,能载舟,亦能覆舟。产品在一头,用户在另一头,手册的小船怎样才能载着用户顺利到达对岸?这就靠顺风,顺水,会掌舵。最好能把船做成桥,这样就保证随时随地跨越河流。以下就是从dita best practice中领悟到的。
1.know your audience,了解你的用户,包括知识水平,对于产品的期望,使用产品的预期目标,常用的使用场景。
2.minimalist,极简主义,写手册也要学会断离舍,不要拖沓,只提供必要信息,移除所有非必要信息。
3.task analysis,执行任务分析、分解。每一个topic对应一项任务,那么任务的体量就要合适。不能把造大飞机当成一个任务,企图通过一个topic来覆盖,那这个topic的小船就得做成航空母舰级别。而是要逐级分解,直到每一个topic大约能够在7步以内完成。7是一个神奇的数字。但也不需要拆的太零散,一个topic中必要的组成元素还是要有的。
4.task-oriented,以客户为中心,以任务为导向。说起来就像是喊口号,就差一句“为人民服务”了。关注任务,是要指导读者的目的,船是为人而开,要按照掌舵人的意愿行驶,而不能是放任自流,让船带着人走。
比如,我们经常在手册中看到类似描述“使用xx功能”,然后就把这个功能按钮啥的描述一遍,只字不提用户为什么要做,做完了会有什么结果。不禁想代表用户问一句“然后呢?”
5.区分topic类型。很多时候,写作过程中,会经常容易混淆不同内容,在一段话中有动作,有解释说明,又有参考信息。小船不知该往哪个方向走,这也是上一条中出现纯功能描述文字,妄图指导用户操作的原因。
举几个简单的例子,一起来区分一下。如果我们想要做一道经典名菜,西红柿炒鸡蛋,哈哈。那么切菜,摘菜,洗菜,下锅,翻炒,加调料,出锅等一气呵成动作无疑就是task了。那么,对于某些人,要额外说明为什么是西红柿,什么是鸡蛋,就是概念。那么,参考信息时什么呢?就是这份菜单中,用了多少调料,配料,再加上必要的配图,都属于参考信息。
好了,才翻了几页就准备做分享,我的自信也是够够的,来自梁静茹满满的勇气。明天还要继续整理,分享。
手册的小船,怎样才不说翻就翻