文档编写规范：标准化与代码规范.pdfVIP

文档编写规范：标准化与代码规范

军无疑问，文档是项目管理中最关键的部分之一，文档的规范与否关系到项目进展状况，关系整项

目工作的效率与效益。

往往越是规模大的公司，其项目工作中的每•环节都有相应的规范进行管理，这些规范都

是都前辈呕心沥血，披荆斩棘所获的的经验总结，而非普通文书工作者的推猜可得。

当然，如果刚刚创业起步的小公司如能更早的抓住项目规范、文档规范，更是使公司发展或

者比大公司更大的推动力。

做文档应当十分注意细节问题，可以文档的细节规范决定文档的成败，正所谓细节决定成败。

1.首先，绝对不允许有错别字。

2.文档标题:命名标准为:客户公司名称+项目名称+版本号JXX公司采编项目_VLO）。

3.文档属性：打开word文档一》文件一＞属性（标题、作者、单位）。

4.首页：文档标题，客户公司和实施公司LOGO,左下角标注（实施公司名，作者，更新

时间,版本.文档编号）.

5.文档管理：修改记录，审阅记录，分发记录，致被分发者。

6.目录：动态更新目录，任何栏目修改都要及时更新。

7.项目编号：整项目编号撑起了整篇文档的栏目构架，在视图一＞文档构架图中应可以

看清这脉络。

8.文档字体：文档的项目编号、正文、注释都应有相应的字体大小。

9.图片表格：每图片和表格都必须要编号。

10.段落：段落的之间的行距，是否空行，紧密程度应当十分注意，影响整体美观，

11.页眉和页脚：页眉，左边是实施公司LOGO,右边是文档标题；页脚，左边有公司名及

版权声明。

拥有准确技术文档不仅对于公司是非常有益处，而且也能够让客户从中受益。由于产品如何使用在某种

程度上是要依赖技术文档来进行说明，因此技术文档必须十分准面可靠。使用不准确和已经过时技术文档

对于公司发展也会产生一定阻碍，同样，它也会对公司客户们产生消极影响。一旦客户发现在他们使用产

品时候遇到问题，却不能通过求助于伴随产品技术文档手段进行解决时候，客户们就会对这种产品产生

怀疑乃至于失去信心，那么，公司信誉和利益自然而然就会受到损害。这就是不准确和过时技术文档给我

们带来危害。

缺乏准确性以及内容晌涩难懂都会让开发新手以及其他一些技术工作者们对这些技术文档敬而运之，

从而不利丁•他们学习和掌握。在本篇文章中，我们要讨论就是如何在你开发小组中编写出准确而且易于掌

握技术文档。

技巧一：制定出一个技术评价核对表

许多程序开发设计者以及管理者都缺乏从技术上评价一个文档经验。这里有一些方法可以提高这些技

术文档准确性：

把注意力集中于技术事实上，这样能够核实这些技术是作为技术文档而被编写出来。技术评论工作并

不等同于一般编辑工作。

一定要从技术上核实，在技术文档里编写程序与步骤准确性,

一定要从技术上核实，在技术文档中使用图片捕捉准确性。

技巧二：一定要在技术文档编写过程中明确责任

技术文档编写不一个原因常常是由于对它不够重视。这是由于在编写技术文档时候，没有十分明确各

种责任。因此，一定要在技术文档编写过程中明确责任，这些方法包括：

在技术文档中加入作者以及相关人员姓名。一些公司口］•能有规定，禁止出现员工姓名，但是在技术文

档中包含作者以及相关人士姓名做法能够促进这些内部员工之间交流。对于外部文档使用者，比如为商业

现货软件编写用户指南，可以加入作者以及相关人员姓名，用以明确和承认他们对开发所做工作和贡献。

把文档技术评论作为提供给开发设计人员年度评论一部分。

在项目计划中指派专人负责技术评论工作。

技巧三：增加技术文档编写者