如何写好网站帮助文档?

document

一、清楚自己的用户是哪些人?

首先弄清楚自己的用户是谁,是写好文档的第一步。了解你的用户,才能做出更好的引导,告诉他们为什么这样以及怎么做?
针对不同的群体要有不同的写作侧重点。如果是给运维人员看的,那么重点是要说清楚各个操作以及相关逻辑;如果是给非技术人员看的,一定要尽量『看图说话』,联系他们能够理解的概念来跨越不同职业的鸿沟。

二、列出总的分类和大纲。

先列出总的分类,根据分类写出需要写哪些类型的文章,列出大纲。

三、写初稿。

写作中可以多使用的几种方式:
(1)总分总结构:文章可以使用总分总结构,因为这种文章结构非常符合人类的思维习惯。
(2)一图胜千言:涉及到诸多难以解释的概念和联系时,不要过多解释,画一个清晰的图,比什么效果都好。如果是针对小白的使用教程,就把每一个需要使用的功能,按照真实的使用步骤,逐步进行详细的截图说明和讲解。
(3)少即是多:文档太长,自己更新起来累,别人看起来也累,维护起来更累。所以去掉各类废话、套话,说重点。
(4)注意排版:突出重点,让结构显得清晰饱满。

四、更新迭代

根据网站实际功能的变化,随变化更新迭代。保证及时更新。

一份好文档的标准:

(1)准确:不会给人模棱两可的感觉
(2)清晰:不会给人写了很多但不知道写了啥的感觉
(3)完整:不会给人话说到一半戛然而止的感觉
(4)简洁:不会给人没话找话说的感觉
(5)有组织:不会给人不知道要去哪里看什么内容的感觉
(6)可读性好:不会给人每个字都认识但就是看不懂的感觉
(7)任务导向:不会给人跑题不说重点的感觉

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,482评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,377评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,762评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,273评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,289评论 5 373
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,046评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,351评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,988评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,476评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,948评论 2 324
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,064评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,712评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,261评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,264评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,486评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,511评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,802评论 2 345

推荐阅读更多精彩内容