一、清楚自己的用户是哪些人?
首先弄清楚自己的用户是谁,是写好文档的第一步。了解你的用户,才能做出更好的引导,告诉他们为什么这样以及怎么做?
针对不同的群体要有不同的写作侧重点。如果是给运维人员看的,那么重点是要说清楚各个操作以及相关逻辑;如果是给非技术人员看的,一定要尽量『看图说话』,联系他们能够理解的概念来跨越不同职业的鸿沟。
二、列出总的分类和大纲。
先列出总的分类,根据分类写出需要写哪些类型的文章,列出大纲。
三、写初稿。
写作中可以多使用的几种方式:
(1)总分总结构:文章可以使用总分总结构,因为这种文章结构非常符合人类的思维习惯。
(2)一图胜千言:涉及到诸多难以解释的概念和联系时,不要过多解释,画一个清晰的图,比什么效果都好。如果是针对小白的使用教程,就把每一个需要使用的功能,按照真实的使用步骤,逐步进行详细的截图说明和讲解。
(3)少即是多:文档太长,自己更新起来累,别人看起来也累,维护起来更累。所以去掉各类废话、套话,说重点。
(4)注意排版:突出重点,让结构显得清晰饱满。
四、更新迭代
根据网站实际功能的变化,随变化更新迭代。保证及时更新。
一份好文档的标准:
(1)准确:不会给人模棱两可的感觉
(2)清晰:不会给人写了很多但不知道写了啥的感觉
(3)完整:不会给人话说到一半戛然而止的感觉
(4)简洁:不会给人没话找话说的感觉
(5)有组织:不会给人不知道要去哪里看什么内容的感觉
(6)可读性好:不会给人每个字都认识但就是看不懂的感觉
(7)任务导向:不会给人跑题不说重点的感觉