①文档需要覆盖整个物流信息系统的生命周期。在项目早期几个阶段就要求有文档,而且在系统开发过程中文档必须是可用的和可维护的。在开发完成后,文档应满足软件的使用、维护、转换或传输的需要。
②文档应是可管理的。指导和控制文档的编制和维护,管理者应准备文档产品、进度、可靠性、资源、质量保证和评审规程的详细计划大纲。
③文档应适合于它的读者。读者可能是管理者、分析员、无计算机经验的专业人员、维护人员、文书人员等。根据任务的执行,他们要求有不同的材料表示和不同的详细程度。针对不同的读者,文档编制者应设计不同类型的文档。
④文档效应贯穿到系统的整个开发过程中。在系统开发的整个过程中,应充分体现文档的作用和限制,即文档应指导开发全部过程。
⑤文档标准应被标识和使用。选择文档标准时,应尽可能地采纳现行的标准;若没有合适的标准,必要时应研制适用的标准或指南。
⑥应规定支持工具。工具有助于开发和维护系统产品,包括文档,因此尽可能地使用工具是经济的、可行的。
2.制定文档管理的标准和指南
在一个物流信息系统开发和运作项目组内,应采用一些标准和指南,包括系统生存期模型、文档类型和相互关系、文档质量。这些标准和指南决定了如何实现文档管理任务,提供一些准则以评价所产生的系统文档的完整性、可用性和适用性。应尽可能地采用现行的国家标准和国际标准,若现行的标准不适用或没有相应的国家标准和国际标准,那么各机构应制定自己的文档管理标准。
(1)选择系统生存期模型
现行的一些系统生存期模型,对于不同的阶段有不同的词汇,从系统文档的观点来看,采用哪种模型无关紧要,只要阶段和相应的文档是清晰定义的、已计划的,并且对于任何具体系统项目都是能遵循的。因此,管理者应选择一个系统生存期模型并保证该模型在机构内是适用的。
(2)规定文档内容和类型
系统文档一般应归入如下三种类别:开发文档——描述开发过程本身;产品文档——描述开发过程的产物;管理文档——记录项目管理和系统运行的信息。这个分类是比较粗略的,可以作为具体项目中定义文档类型的参考。
(3)确定文档的质量等级
仅仅依据规章、传统的做法或合同要求来制作文档是不够的,管理者还必须确定文档的质量要求以及如何达到和保证质量要求。质量要求的确定取决于可得到的资源、项目的大小和风险,可以对该产品每个文档的格式及详细程度作出明确的规定。每个文档的质量必须在文档计划期间就有明确的规定。文档的质量可以按文档的形式和要求划分为四个等级。
①最低限度文档(1级文档)。1级文档适合开发工作量较小的自用程序。该级别文档包含程序清单、开发记录、测试数据和程序简介。
②内部文档(2级文档)。2级文档可用于在精心研究后被认为似乎没有与其他用户共享资源的专用程序。除1级文档提供的信息外,2级文档还包括程序清单内足够的注释以帮助用户安装和使用程序。
③工作文档(3级文档)。3级文档适用于由同一单位内若干人联合开发的程序,或可被其他单位使用的程序。除2级文档提供的信息外,3级文档还包括共享程序结构和相应的注释说明,方便集成现有应用和工作成果共享。
④正式文档(4级文档)。4级文档适合那些要正式发行供普遍使用的系统产品。关键性程序或具有重复管理应用性质(如工资计算)的程序需要4级文档。4级文档遵守《计算机软件产品开发文件编制指南》(GB/T8567-1988)的有关规定。
质量方面需要考虑的问题还包括文档的结构和内容。文档结构由各个组成部分的顺序和总体安排的简单性来确定,文档内容可以根据正确性、完整性和明确性来判断。
3.文档编制计划
文档编制计划可以是整个项目计划的一部分,也可以是一个独立的文档。应该编写文档编制计划并把它发给全体开发组成员,作为文档重要性的具体依据和管理部门文档工作责任的备忘录。
对于小的、非正式的项目,文档计划可能只是一页纸;对于较大的项目,文档计划可能是一个综合性的正式文档,这样的文档计划应遵循各项严格的标准及正规的审批和批准程序。
文档计划一般包括以下几个方面的内容:列出应编制文档的目录;提示编制文档应参考的标准;指定文档管理员;提供编制文档所需要的文件,落实文档编写人员、所需经费以及编制工具等;明确保证文档质量的方法,为确保文档内容的正确性、合理性采取一定的措施,如评审、鉴定等;绘制进度表,以图表形式列出在软件生存期各阶段应产生的文档、编制人员、编制日期、完成日期和评审日期等。
7.3.3 文档的质量管理
质量差的文档不仅使读者难以理解,给使用者造成很多不便,而且会使管理人员难以确认和评价开发工作的进展,削弱对物流信息系统的管理,一些工作可能会被迫返工从而增加物流信息系统的开发成本,甚至会造成误操作等更加严重的后果。
造成物流信息系统文档质量不高的原因主要有以下几个方面:不重视文档的编写工作而造成文档质量较低;文档的编写很随意,不按照各类文档的规范写作;缺乏文档编写的实践经验,对文档编写工作的进度安排不科学;缺乏评价文档质量的科学标准,使文档管理的有些工作流于形式,缺乏真正执行的机制。
1.文档的内容质量
物流信息系统的建设在很大程度上是物流软件的开发,就软件的两大部分——程序和文档而言,程序是必须最终完成的,而且程序的好坏有很大一部分是可以通过运行来看出来的,而文档有一些是必须完成的,有些可能没有严格要求或可以事后补充,有时为了追求开发速度,一些文档常被忽略或粗制滥造。另外,文档经常是给别人看的,文档的作用很多是在事后才能体现出来的,所以物流信息系统开发和管理人员缺乏编写文档的动力和自觉性。
高质量的文档通常具有以下的一些特征:
①针对性。文档编制之前应分清楚读者对象,根据不同类型、不同层次的读者的要求,编制适合他们的不同的文档。例如,用户文档不能像开发文档那样使用过多的信息技术专业术语。
②精确性与统一性。文档的行文应当十分确切,避免一些歧义的措辞。同一项目的不同文档在描述同一内容时应当协调一致,不能相互矛盾。
③完整性。物流信息系统开发和运行过程中的任何一个文档都应当是完整的、独立的。
④可追溯性。物流信息系统开发和运作阶段的文档与各阶段需要完成的工作都有很紧密的关系,随着工作的逐步进展,前后阶段的文档也具有一定的继承关系,所以一个物流信息系统开发和运行管理阶段的文档必定也必须存在着可追溯性,必要时应能做到跟踪追查。例如,对某一项物流处理功能的需求,在用户需求说明书、系统分析报告、系统设计报告、测试计划和用户手册中都有所体现。
⑤易用性。文档的编制应充分考虑方便各个用户使用的要求,如文档便于读者检索,文档应力求简洁明了,适当地配以图表,使文档更加清晰。
2.文档编制的格式要求
高质量的文档不仅仅是指内容的高质量,也包含规范统一的格式要求。在编制文档时,要立足于读者的需要,格式规范、统一,文字准确、简单明了。
在文档编排时,要遵循以下原则:所有的文档都应该编排得便于迅速查到需要的内容;采用由一般到具体的层次结构,可能的情况下还可以采用词汇之间的互相链接;在可能的情况下,图表应放在它所解释的文字附近,以便用户阅读;可以适当采用不同的字体和版式,以增加正文的明晰度。