研发管理

img Musicwind

有关文档的实用性要求——来自《文档审核意见-关于xx文档》的摘录

发表于2004/10/28 15:50:00  1512人阅读

分类: 杂食动物 开发心得

有关文档的实用要求

1.       文档不仅仅是给客户的,也是我们此次工程实施的经验总结;

2.       文档必须要实用,为了客户,也为了我们自己!

怎么样的文档才算实用?

1.       目的明确

a)        文档肯定是针对某类问题的说明,因此要求目的明确,针对性强。比如若仅是针对某个模块其中一个版本的说明,则决不含糊其辞,而是在很明显的地方与以说明,决不浪费使用者/读者的时间。

2.       条理清晰

a)        尽可能地以读者角度/思路来合理编排章节;

b)        讲清楚:是什么?为什么?怎么做?等几个问题,必要时还需要增加“谁?”“何时?何地?何种情况?”等一些问题。

3.       一致性

a)        在文中多次出现的有关内容,应该前后描述一致,不自相矛盾;

4.       内容充实

a)        就某个问题的描述,应该言之有物而不夸夸其谈;

b)        若实在没东西讲,应该写明“内容有待细化/补充”;

5.       可操作性

a)        如果文档的特点是针对操作开展,则应该在内容的真实性、可验证性上做足文章。读者能够根据文档的提示一步步完成某项工作;

b)        文档应该尽可能地提供可视化的图片或其他媒体方式,以便内容直观,更易于理解;

6.       体贴

a)        在文中出现对有关内容的引述,应该尽可能提供链接,以免读者四处搜索遍寻不着;

阅读全文
0 0

相关文章推荐

img
取 消
img