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

《项目文档编写规范与代码规范》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、项目文档编写规范与代码规范往往越是规模大的公司，其项目工作中的每一个环节都有相应的规范进行管理，这些规范都是都前辈呕心沥血，披荆斩棘所获的的经验总结，而非普通文书工作者的推猜可得。当然，如果刚刚创业起步的小公司如能更早的抓住项目规范、文档规范，更是使公司发展或者比大公司更大的推动力。做文档应当十分注意细节问题，可以文档的细节规范决定文档的成败，正所谓细节决定成败。1.首先，绝对不允许有错别字。2.文档标题：命名标准为：客户公司名称+项目名称+版本号。（××公司采编项目_V1.0）。3.文档属性：打开word文档－>文件－>属

2、性（标题、作者、单位）。4.首页：文档标题，客户公司和实施公司LOGO，左下角标注（实施公司名，作者，更新时间，版本，文档编号）。5.文档管理：修改记录，审阅记录，分发记录，致被分发者。6.目录：动态更新目录，任何栏目修改都要及时更新。7.项目编号：整个项目编号撑起了整篇文档的栏目构架，在视图－>文档构架图中应可以看清这个脉络。8.文档字体：文档的项目编号、正文、注释都应有相应的字体大小。9.图片表格：每个图片和表格都必须要编号。10.段落：段落的之间的行距，是否空行，紧密程度应当十分注意，影响整体美观。11.页眉和页脚：页

3、眉,左边是实施公司LOGO，右边是文档标题；页脚，左边有公司名及版权声明。　拥有准确技术文档不仅对于公司是非常有益处，而且也能够让客户从中受益。由于产品如何使用在某种程度上是要依赖技术文档来进行说明，因此技术文档必须十分准确可靠。使用不准确和已经过时技术文档对于公司发展也会产生一定阻碍，同样，它也会对公司客户们产生消极影响。一旦客户发现在他们使用产品时候遇到了问题，却不能通过求助于伴随产品技术文档手段进行解决时候，客户们就会对这种产品产生怀疑乃至于失去信心，那么，公司信誉和利益自然而然就会受到损害。这就是不准确和过时技术文档

4、给我们带来危害。　　缺乏准确性以及内容晦涩难懂都会让开发新手以及其他一些技术工作者们对这些技术文档敬而远之，从而不利于他们学习和掌握。在本篇文章中，我们要讨论就是如何在你开发小组中编写出准确而且易于掌握技术文档。　　技巧一：制定出一个技术评价核对表　　许多程序开发设计者以及管理者都缺乏从技术上评价一个文档经验。这里有一些方法可以提高这些技术文档准确性：　　把注意力集中于技术事实上，这样能够核实这些技术是作为技术文档而被编写出来。技术评论工作并不等同于一般编辑工作。　　一定要从技术上核实，在技术文档里编写程序与步骤准确性。　　

5、一定要从技术上核实，在技术文档中使用图片捕捉准确性。　　技巧二：一定要在技术文档编写过程中明确责任　　技术文档编写不一个原因常常是由于对它不够重视。这是由于在编写技术文档时候，没有十分明确各种责任。因此，一定要在技术文档编写过程中明确责任，这些方法包括：　　在技术文档中加入作者以及相关人员姓名。一些公司可能有规定，禁止出现员工姓名，但是在技术文档中包含作者以及相关人士姓名做法能够促进这些内部员工之间交流。对于外部文档使用者，比如为商业现货软件编写用户指南，可以加入作者以及相关人员姓名，用以明确和承认他们对开发所做工作和贡献。

6、　　把文档技术评论作为提供给开发设计人员年度评论一部分。　　在项目计划中指派专人负责技术评论工作。　　技巧三：增加技术文档编写者准确性　　由于技术文档编写者在许多公司内都是非常主观一个职位，并且编写技术文档也是他们最主要职责，因此做这些工作人都必须与他们所编写技术文档准确性有着直接利害关系。字串7　　管理人员应该为技术文档编写者设置适当技术准确级别，并要求他们把准确性保持在这一范围之内。由于一些技术文档编写者对于提升自己对于技术理解总是不太积极主动，因此，增加他们责任让他们面对更多压力对项目里每一个人来说都是有处。如果一个技

7、术文档编写者无法达到更高标准，那么你就需要重新审视一下你技术文档编写者是否能够满足你们团队战略要求，是否能够满足客户们需要呢？　　为了帮助技术文档编写者，你需要让他们对于具体技术有着更深层次认识，因此，作为管理者，你应该：　　让技术文档编写者多参加有关产品设计与开发小组会议。　　让技术文档编写者参与到技术要求、功能规范以及设计方案开发工作中去。　　把技术文档编写者包括进开发小组邮件列表中去。　　这技术文档编写周期，把产品在公司内部进行发布。技术文档编写者很容易变得非常封闭，但是如果把产品在内部首先发布一下，那么就能够给开发人

8、员以及项目管理人员提供一种新途径来了解以前可能并不容易了解情况。　　鼓励技术文档编写者更多了解有关产品背后所包含各种技术。举个例子来说，如果你开发基于Java语言应用软件，那么，就应该鼓励技术文档编写者多多了解Java编程语言，并且尽量让他们能够流畅掌握这门编程语言。　　技巧四：设置任务优