2024-03-06

引言

国家近年来大力推进信息化建设,衍生了大量的信息化项目,然而大多数项目的文档工作并未受到足够尊重,经常是项目到验收阶段才想到需要编制验收文档,只能临时赶进度,对于项目实施过程中的文档到最后阶段才开始集中编制,这样导致验收文档质量不高,很多内容全靠编,大多内容其实经不起推敲。

一、现状分析

我们经常会听到这些呼声,“写文档有啥用”、“我不写,我的工作又不是写文档”、“我还有其它事情做,没时间写”、“不会,写不好”,往往一提到文档,好像就会本能抗拒,其实这种想法很危险,一个项目的文档体系是需要多方配合才能完成编制的,如果大家都不配合,会给项目带来潜在的风险隐患。造成这些问题的原因,无外乎三点,一、公司没有建立项目全生命周期管理制度;二、项目周期短,压力大,项目经理忽略文档重要性;三、技术人员不配合,自身文档编制能力弱。

二、文档重要性

项目文档作为整个项目的文字载体,其重要性不言而喻了。项目文档是工作开展的前提,标准化的文档展现的是一种做事的态度;项目文档也能作为项目监管的手段,报告与进度文档能让管理者对项目的整体情况有全面了解;项目各个阶段的制度规范都可以通过文档形式表达和传递,也是工作成果的具体体现;项目各个成员之间也能通过文档进行交流,留下工作印记;项目文档经过不断积累,最终形成知识共享经验库,供需要的人随时查阅,可最大程度发挥知识的价值。

三、文档类别及类型

说到信息化项目的文档,我们从其类别和类型来区分一下项目各个阶段的文档。

文档类别项目文档的类别主要分为三类,即方案、报告和说明书。

方案:项目前期建设时,有针对性,系统性的提出的方法、应对措施及相关对策。简而言之,事情用什么方法去做,以及相关的计划安排。

报告:描述项目实施过程、进展、和结果,及项目过程中遇到问题。简而言之,就是项目实施过程中或实施完成后的总结。

说明书:对一件事情进行相对的详细描述,做到全面具体,同时清楚地说明应注意的事项和可能产生的问题。

文档类型

这里我将信息化项文档的类型进行总结,从项目实施周期的维度进行分类,共分为九大类。具体如图1所示:


图1 文档类型

(1)项目准备阶段

技术方案:整个项目建设前期指导性文件,详细说明项目来源、需求分析、系统框架、建设内容、部署进度安排等内容。主要面向客户、项目组成员,可作为实施方案的依据。

实施方案:指导项目施工,包括项目需求调研、系统设计、编码、测试、部署、培训、试运行、上线的技术要求和具体人员时间安排。主要面向项目成员。

(2)需求分析阶段

需求分析报告:对项目需求调研进行整合,包括产品的功能需求、信息化现状、外部接口需求。主要面向项目业务人员、客户,可作为需求规格说明书的依据。

需求规格说明书:说明产品的业务规则,并对产品进行详细的功能解析,具体包含原型界面、业务接口、活动图等。主要面向项目产品设计、开发人员。

(3)系统设计阶段

概要设计说明书:设计软件的结构,明确软件系统由那些模块组成,模块的层次结构、调用关系以及模块的功能,同时确定数据结构和数据库结构。主要面向项目产品设计、开发人员,可作为详细设计说明书的依据。

详细设计说明书:对软件系统每个模块完成的功能进行具体的描述,把功能描述转变为精确地结构化的过程描述,既该模块的控制结构或者说逻辑结构。主要面向项目产品设计、开发人员。

(4)系统编码阶段

编码规范:说明前端代码和后端代码的规范,包括命名、注释、声明、语句、功能分布等的检查事项和具体要求。主要面向项目开发人员。

(5)系统测试阶段

测试方案:说明软件系统的测试方法、测试工具、测试环境、测试目的和任务、测试计划、人员安排等方面内容。主要面向项目测试、开发人员,可作为测试用例的依据。

测试用例:说明软件系统的测试目标、测试环境、输入数据、测试步骤、预期结果,测试脚本等。主要面向项目测试、开发人员,可作为测试报告的依据。

测试报告:包括单元测试报告和集成测试报告,具体说明测试的过程和结果,对发现的问题和缺陷进行分析,为纠正软件的存在的质量问题提供依据,主要面向项目测试、开发人员。

(6)系统部署阶段

安装部署说明书:说明软件系统、数据库、运行环境、各类工具和插件的安装配置方法,服务启动与更新的方法。主要面向项目实施人员。

(7)系统试运行阶段

试运行方案:说明软件系统试运行的目的、计划、支撑环境、内容、作用、改进方向和措施等方面内容。主要面向客户、项目组成员。

试运行报告:说明软件系统试运行的具体功能模块、支撑环境、工作安排、用户规模、系统存在问题及解决办法、成效、正式上线准备工作、结论等方面内容。主要面向客户、项目组成员。

(8)系统培训阶段

培训方案:说明软件系统培训的组织对象、目的、内容、方式、地点、时间等方面内容。主要面向客户、项目组成员。

培训文件:具体包括软件系统培训的讲义,即Word、PPT、录屏等各类资料。主要面向客户、项目组成员。

(9)系统上线阶段

系统上线计划:说明软件系统上线的功能、时间、地点、计划安排等方面内容。主要面向客户、项目组成员。

四、信息化项目验收文档总体框架示例

信息化项目验收具体以甲方要求为主,一般包括验收文档(各类过程资料)和系统/平台源代码。下面举例示意信息化项目验收文档的总体框架,具体如图2所示:


图2 信息化项目验收文档的总体框架

五、小结

总而言之,希望各个从事信息化项目工作者,逐渐开始重视文档编制,不只是简单为了应对项目验收,更是为了工作留痕、经验分享、项目可持续发展。后面也将分享更多关于信息化文档编制经验,与大家一起学习,一起进步!

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,271评论 5 466
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,725评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,252评论 0 328
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,634评论 1 270
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,549评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 47,985评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,471评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,128评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,257评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,233评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,235评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,940评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,528评论 3 302
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,623评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,858评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,245评论 2 344
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,790评论 2 339

推荐阅读更多精彩内容

  • 前注: 本采购求中提出的服务方案仅为参考,如无明确限制,合作方可以进行优化,提供满足采购人实际要的更优(或者性能实...
    很少更新了阅读 24,526评论 1 7
  • 21、 南吴派宣州副指挥使花虔率军会同广德镇遏使涡信屯驻广德,准备入寇衣锦军。吴越钱传瓘先行进攻广德。 22、 六...
    华杉2009阅读 260评论 0 12
  • 环保工程师、环评工程师、注册安全工程师的报考条件 大部分人都不知道自己应该考哪个证书,建议大家考与自己从事的行业有...
    花阡陌2022阅读 147评论 0 0
  • pgmp项目集管理介绍 易佳课题 PgMP®是美国项目管理协会 PMI 三大项目管理核心证书(PMP®,PgMP®...
    de5ea6d11ab2阅读 28评论 0 0
  • 注意力,生命的货币 打卡,每日固定流程7.0版本进度: 1.睡前安宁/清晨唤醒:237(30)午间攻克:99 ...
    番茄打卡阅读 48评论 0 1