2006-10-17 9:20:16
[原创]怎么样的文档才算实用，才算好文档？
怎么样的文档才算实用
1.目的明确，针对性强
文档肯定是针对某类问题的说明，因此要求目的明确，针对性强。比如若仅是针对某个模块其中一个版本的说明，则决不含糊其辞，而是在很明显的地方与以说明，决不浪费使用者/读者的时间。
2.条理清晰，可读性强
从读者角度思考问题，合理编排章节，讲清楚：是什么？为什么？怎么做？等几个问题，必要时还需要增加“谁？”“何时？何地？何种情况？”等一些问题。
3.前后呼应，一致性好
在文中多次出现的有关内容，应该前后描述一致，不自相矛盾。
4.内容充实，实事求是
就某个问题的描述，应该言之有物而不夸夸其谈，若其中某个部分实在没东西讲，应该写明“内容有待细化/补充”等。
5.引用有源，体贴周到在文中出现对有关内容的引述，应该尽可能提供链接或出处，方便读者搜索，以便于更深入研究。
6.操作性强，便于共享
如果文档的特点是针对操作开展，则应该在内容的真实性、可验证性上做足文章。尽可能地提供可视化的图片或其他媒体方式，以便内容直观，更易于理解，读者能够根据文档的提示一步步完成某项工作。
0
推荐到鲜果： 查阅更多相关主题的帖子: 知识管理 文档管理
评论
发布者 渠清如许
2006-10-17 9:37:25
非常同意！
我觉得文档可读性强最重要。
可以分为两种文档：
1.格式文档（公司内部，公司之间，行业通行的约定格式）。目的是快速阅读，快速掌握，目标明确
2.文本文档。目的是启发、关联知识。
发布者 stanley gu
2006-10-17 9:43:40
发布者 渠清如许
2006-10-17 9:45:27
写得不错，有指导意义。
期待渠的分享。
发布者 萧秋水
2006-10-17 11:38:51
个人愚见：“文档”的范畴太大了，一部宪法是文档，一个论坛帖子是文档，一个制度规范是文档，一个blog的心情小文是文档，一篇软件需求说明书也是文档，如果真要拿一个评价标准来囊括所有类型的文档，那必定是要高度抽象的（呵呵，可能又要上升到哲学高度才行），而一组高度抽象的文字，若放在在互联网这个讲求快餐式阅读的环境下来看，估计必是曲高和寡：）
但如果我们来讨论一个有知识共享价值的适合在论坛发表的文档的标准，我很赞同楼主和stanley gu 所说可读性这个标准，因为互联网信息太多，阅读成本太高。
发布者 Xenosliu
2006-10-18 2:17:38
楼上想的真全面！俺不是哲学家，所以写不出高度抽象的东西。
修订一下楼上的定义：“有知识共享价值的企业文档”这是俺描述的标准的适用范围。
发布者 KM实践者
2006-10-18 9:04:18