|
编制软件文档应考虑的因素
文档编制,需要付出艰巨的劳动。为保证文档编制质量,使之能适应不同使用对象的要求,而又使所花费的劳动与不同项目对文件的需求相适应,应根据下列因素确定文档的编制要求。
(1) 每一种文档都有其特定的使用者。这些使用者包括软件开发单位(一个或几个)的技术人员、管理人员和领导干部;使用和维护这些软件的用户;社会上的公众等。这些不同的人员对文档的内容,详尽程度以及侧重点有不同的要求。因此,文档的编写者必须了解文档使用者的特点、水平和需要,以及该文档提供的广泛程度等,有针对性地编写成各种文档。
(2) 编制的各种文档的某些内容上不可避免会有重复,这是为了使文档的使用者能比较方便地了解某些共性的内容,而不必频繁地去参阅另外一些文档或章节,这样的重复是必要的,但在行文的详尽程度上可根据该文档的使用对象不同而有所侧重。
(3) 根据软件的规模和复杂程度的不同,在确定文档的种类、详尽程度、种类与章节的扩展压缩、程序设计和文档的表现形式等方面时可灵活掌握,使其更符合实际需要。这包括:
A 应编制的文档种类
本规范建议应编制的软件文档有16种。但针对一项具体的软件开发项目,以把某几种文档合并成一种,以减少文档的种类。
当本规范所编制的文档种类尚不能满足某些单位或部门的特殊需要时,还可根据需要再规定若干种增补编制的文档。
应编制的文档种类和详尽程度取决于承担开发单位的管理能力、软件的专业特点、开发项目的规模、复杂性和成败风险等因素。因此,软件开发单位应制定一个文档编制实施规定,说明在什么情况下应编制哪些文档(包括本单位规定应增补的文档)。
对每个具体的软件项目,应确定一个文档编制计划,规定应编制的文档种类;详尽程度;编制、审查、批准人员和进度要求;以及开发期间各文档的维护、修改、管理人员和批准手续,文档编制计划是整个开发计划的重要组成部分。
B 文档的详尽程度
文档编制的详尽程度取决于任务的规模、复杂性以及该文档的使用者对文档内容的需求。
C 文档种类以及章节的扩张和缩并
当一种文档的内容非常多或有必要分卷时,则可将其分卷编写。各种文档编写时,一般应符合本规范所规定的章节及其大致相同。但各章节的内容可根据实际情况扩展(细分)或缩并。在这种情况下,章节的编号应相应改变。
D 程序设计和文档的表达形式
本规范对程序设计的表现形式以及文档的表现形式不作具体的规定或限制。设计开发人员和文档的编制者可根据实际情况,以最方便和最有利于表达并为文档使用者接受的形式来设计和编写。
为了便于管理和统一,各单位可参照有关标准对文件的编写格式等作出具体规定。 |
|