首页 百科知识 工程文档的质量要求

工程文档的质量要求

时间:2022-06-19 百科知识 版权反馈
【摘要】:三、LIS工程文档的质量要求文档设计在LIS工程建设中有着举足轻重的作用。LIS工程文档的书写除应遵守一般科技论文的书写准则之外,在自身结构和前后呼应关系上还应遵守以下原则:即时性。对于大型LIS工程而言,《LIS总体方案》是所有文档的基本指导书,所有文档的内容均不得违背总体方案的框架。LIS工程建设是系统工程中的一个具体应用,文档书写应体现系统工程的思想。

三、LIS工程文档的质量要求

文档设计在LIS工程建设中有着举足轻重的作用。文档作为软件的一部分,也应遵守相应的书写要求和规范。

LIS工程文档的书写除应遵守一般科技论文的书写准则之外,在自身结构和前后呼应关系上还应遵守以下原则:

(1)即时性。所有文档应在相应阶段按时完成,适当的提前逾越有时是可以的(比如用户手册可逐步完成),但滞后的弥补则是不允许的。严禁在项目完成之后补写项目文档,但因中途需求或设计更改而引起的文档修改不受此限制。

(2)一致性。文档应在总体控制之下完成。对于大型LIS工程而言,《LIS总体方案》是所有文档的基本指导书,所有文档的内容均不得违背总体方案的框架。为保证文档的连续性,后一阶段文档的内容不能与前面阶段文档内容相冲突。

(3)完整性。文档首先应保证逻辑上的严谨和完整。LIS工程建设是系统工程中的一个具体应用,文档书写应体现系统工程的思想。其次,文档也应反映工程开发项目在技术上的完整,不应出现疏漏或失误。

(4)可读性。不同文档的书写应考虑到其读者群的素质和层次。内部交换文档的书写可以采用较为专业的词汇和专业化的表达,而面向用户的文档则宜采用大众化的写法,力求通俗易懂。联机帮助文档则要发挥电子文档的优势,在功能交互查询、词条交互检索以及使用例证上系统化、逻辑化。

(5)规范性。文档的书写应规范化,尤其是同一主题不同内容的文档(如模块设计说明),应提交格式一致的文档。

免责声明:以上内容源自网络,版权归原作者所有,如有侵犯您的原创版权请告知,我们将尽快删除相关内容。

我要反馈