写项目文档是要注意什么？ 引言 国家近年来大力推进信息化建设，衍生了大量的信息化项目，然而大多数项目的文档工作并未受到足够尊重，经常是项目到验收阶段才想到需要编制验收文档，只能临时赶进度，对于项目实施过程中的文档到最后阶段才开始集中编制，这样导致验收文档质量不高，很多内容全靠编，大多内容其实经不起推敲。 一、现状分析 我们经常会听到这些呼声，“写文档有啥用”、“我不写，我的工作又不是写文档”、“我还有其它事情做，没时间写”、“不会，写不好”，往往一提到文档，好像就会本能抗拒，其实这种想法很危险，一个项目的文档体系是需要多方配合才能完成编制的，如果大家都不配合，会给项目带来潜在的风险隐患。造成这些问题的原因，无外乎三点，一、公司没有建立项目全生命周期管理制度；二、项目周期短，压力大，项目经理忽略文档重要性；三、技术人员不配合，自身文档编制能力弱。 二、文档重要性 项目文档作为整个项目的文字载体，其重要性不言而喻了。项目文档是工作开展的前提，标准化的文档展现的是一种做事的态度；项目文档也能作为项目监管的手段，报告与进度文档能让管理者对项目的整体情况有全面了解；项目各个阶段的制度规范都可以通过文档形式表达和传递，也是工作成果的具体体现；项目各个成员之间也能通过文档进行交流，留下工作印记；项目文档经过不断积累，最终形成知识共享经验库，供需要的人随时查阅，可最大程度发挥知识的价值。 三、文档类别及类型 说到信息化项目的文档，我们从其类别和类型来区分一下项目各个阶段的文档。文档类别项目文档的类别主要分为三类，即方案、报告和说明书。方案：项目前期建设时，有针对性，系统性的提出的方法、应对措施及相关对策。简而言之，事情用什么方法去做，以及相关的计划安排。报告：描述项目实施过程、进展、和结果，及项目过程中遇到问题。简而言之，就是项目实施过程中或实施完成后的总结。说明书：对一件事情进行相对的详细描述，做到全面具体，同时清楚地说明应注意的事项和可能产生的问题。文档类型 这里我将信息化项文档的类型进行总结，从项目实施周期的维度进行分类，共分为九大类。具体如图1所示：
图1 文档类型 （1）项目准备阶段 技术方案：整个项目建设前期指导性文件，详细说明项目来源、需求分析、系统框架、建设内容、部署进度安排等内容。主要面向客户、项目组成员，可作为实施方案的依据。 实施方案：指导项目施工，包括项目需求调研、系统设计、编码、测试、部署、培训、试运行、上线的技术要求和具体人员时间安排。主要面向项目成员。 （2）需求分析阶段 需求分析报告：对项目需求调研进行整合，包括产品的功能需求、信息化现状、外部接口需求。主要面向项目业务人员、客户，可作为需求规格说明书的依据。 需求规格说明书：说明产品的业务规则，并对产品进行详细的功能解析，具体包含原型界面、业务接口、活动图等。主要面向项目产品设计、开发人员。 （3）系统设计阶段 概要设计说明书：设计软件的结构，明确软件系统由那些模块组成，模块的层次结构、调用关系以及模块的功能，同时确定数据结构和数据库结构。主要面向项目产品设计、开发人员，可作为详细设计说明书的依据。 详细设计说明书：对软件系统每个模块完成的功能进行具体的描述，把功能描述转变为精确地结构化的过程描述，既该模块的控制结构或者说逻辑结构。主要面向项目产品设计、开发人员。 （4）系统编码阶段 编码规范：说明前端代码和后端代码的规范，包括命名、注释、声明、语句、功能分布等的检查事项和具体要求。主要面向项目开发人员。 （5）系统测试阶段 测试方案：说明软件系统的测试方法、测试工具、测试环境、测试目的和任务、测试计划、人员安排等方面内容。主要面向项目测试、开发人员，可作为测试用例的依据。 测试用例：说明软件系统的测试目标、测试环境、输入数据、测试步骤、预期结果，测试脚本等。主要面向项目测试、开发人员，可作为测试报告的依据。 测试报告：包括单测试报告和集成测试报告，具体说明测试的过程和结果，对发现的问题和缺陷进行分析，为纠正软件的存在的质量问题提供依据，主要面向项目测试、开发人员。 （6）系统部署阶段 安装部署说明书：说明软件系统、数据库、运行环境、各类工具和插件的安装配置方法，服务启动与更新的方法。主要面向项目实施人员。 （7）系统试运行阶段 试运行方案：说明软件系统试运行的目的、计划、支撑环境、内容、作用、改进方向和措施等方面内容。主要面向客户、项目组成员。 试运行报告：说明软件系统试运行的具体功能模块、支撑环境、工作安排、用户规模、系统存在问题及解决办法、成效、正式上线准备工作、结论等方面内容。主要面向客户、项目组成员。 （8）系统培训阶段 培训方案：说明软件系统培训的组织对象、目的、内容、方式、地点、时间等方面内容。主要面向客户、项目组成员。 培训文件：具体包括软件系统培训的讲义，即Word、PPT、录屏等各类资料。主要面向客户、项目组成员。 （9）系统上线阶段 系统上线计划：说明软件系统上线的功能、时间、地点、计划安排等方面内容。主要面向客户、项目组成员。 四、信息化项目验收文档总体框架示例 信息化项目验收具体以甲方要求为主，一般包括验收文档（各类过程资料）和系统/平台源代码。下面举例示意信息化项目验收文档的总体框架，具体如图2所示：
图2 信息化项目验收文档总体框架 五、小结 总而言之，希望各个从事信息化项目工作者，逐渐开始重视文档编制，不只是简单为了应对项目验收，更是为了工作留痕、经验分享、项目可持续发展。后面也将分享更多关于信息化文档编制经验，与大家一起学习，一起进步！
2024最新激活全家桶教程，稳定运行到2099年，请移步至置顶文章：https://sigusoft.com/99576.html
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请联系我们举报，一经查实，本站将立刻删除。 文章由激活谷谷主-小谷整理,转载请注明出处：https://sigusoft.com/39105.html
