有效文档 II 什么是有效文档?

by 沈蚊 on 二月 22, 2010

话说,上一篇《有效文档 I 为什么要写文档?》成文于2008年11月,到现在一年多了……

- = – = – = – = – = – = – = – 真是对不住大家…Orz…的分割线 – = – = – = – = – = – = – = -

没人喜欢无用功,对于文档而言,最恶心的莫过于写了文档没人看——所以,有效文档首先得是“有人看”的文档。

什么文档有人看呢?

答案是另一个问题:

谁要看什么?

由此可以衍生出来3个问题,如果你的文档可以很好的回答这些问题,那就已经达到“有效”了:

  1. 文档的读者是谁?
    可能有一个决定性的TA,但更多时候还会有Ta、tA和ta。
  2. TA最想看到什么?
    首先是“结论”,也许想看看过程,在某些时候,也可能希望看到字数or厚度。
  3. 你最想给TA看什么?
    听我的没错:形势大好!XD……其实不那么乐观?嘟嘟嘟~有危险靠近了!!!

进而,有效文档还具备以下3个特征:

  1. 清晰
    “清晰”是有效文档的首要条件,你要“确认”读者“确实”明白你所要表达的是什么。
  2. 规范
    作为一种良好职业素质的表现,“一规范,遮百丑”。
  3. 简洁
    通常,大家都喜欢简单干净的文档——不要废话,不要大段文字,且不要多余的装饰与字体。

基本上,当你做到上面这些时,就能写出真正的有效文档了。


分享到:



3 comments

嗯,终于是更新这个系列了,我感动得哭了

by Yibie on 2010 年 3 月 1 日 at 19:20. 回复 #

@Yibie,

我也感动的哭了……现在写的已经是以前提纲的一大半了(原计划是写6节的)

by 沈蚊 on 2010 年 3 月 2 日 at 17:35. 回复 #

最近也在想这个有效文档的问题,如果你可以继续更新的话就好了…

我也写了一篇:http://www.gtdstudy.com/?p=2710

可以相互应该看看

by Yibie on 2010 年 10 月 8 日 at 08:04. 回复 #

Leave your comment

Required.

Required. Not published.

If you have one.