项目文档编写规范与代码规范.pdf

项［目文档编写规范与代码规范］

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

这些规范都是都前辈呕心沥血，乘风破浪所获的的经验总结，而非普通文书工作

者的推猜可得。

固然，如果刚刚创业起步的小公司如能更早的抓住项目规范、文

档规范，更是使公司发展或者比大公司更大的推动力。

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

所谓细节决定成败。

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

2.文档标题：命名标准为：客户公司名称十项目名称+版本号。

（XX公司采编项目_V1.0）。

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

单位）-

4.首页：文档标题，客户公司和实施公司LOGO,左下角标注

实（施公司名，作者，更新时间，版本，文档编号）。

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

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

7.项目编号：整个项目编号撑起了整篇文档的栏目构架，在视

图一〉文档构架图中应可以看清这个脉络。

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

体大小。

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

10.段落：段落的之间的行距，是否空行，密切程度应当十分

注意，影响整体美观。

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

题；页脚，左边公司名及版权声明。

拥准确技术文档不仅对于公司是非常益处，而且也能够让客户从中受益。

由于产品如何使用在某种程度上是要依赖技术文档来进行说明，因此技术文档必

须十分准确可靠。使用不许确和已经过时技术文档对公司发展也会产生一定阻

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

候遇到了问题，却不能通过求助伴有产品技术文档手段进行解决时候，客户们

就会对这种产品产生怀疑乃至失去信心，那末，公司信誉和利益自然而然就会

受到伤害。这就是不许确和过时技术文档给我们带来危害。

缺乏准确性以及内容晦涩难懂都会让开辟新手以及其他一些技术工作者们

对这些技术文档敬而远之，从而不利他们学习和掌握。在本篇文章中，我们要

讨论就是如何在你开辟小组中编写出准确而且易掌握技术文档。

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

许多程序开辟设计者以及管理者都缺乏从技术上评价一个文档经验。这里有

一些方法可以提高这些技术文档准确性：

把注意力集中技术事实上，这样能够核实这些技术是作为技术文档而被编

写出来。技术评论工作并不等同普通编辑工作。

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

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

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

技术文档编写不一个原因往往是由对它不够重视。这是由在编写技术文

档时候，没有十分明确各种责任。因此，一定要在技术文档编写过程中明确责任，

这些方法包括：

在技术文档中加入作者以及相关人员姓名。一些公司可能有规定，禁止浮现

员工姓名，但是在技术文档中包含作者以及相关人士姓名做