UDC 狐 中华人民共和国行业标准 SH/T3901一1994 P 工 程 设 计 计算机软件开发及文档编制规范 Procedure for computer s oftware development and document ation 1 99 4 - 02 - 22发布 中国石油化工总公司 1 9 9 4 - 08 - 01实施 发布 中华人民共和国行业标准 工 程 设 计 计算机软件开发及文档编制规范 Procedure for c omputer soft ware development and documentati on SH/T3901-1994 主编单位:中 国石 化 北 京设 计 院 批准部 门: 中 国 石 油 化 工 总 公 司 199 4 北 京 中 国 石 油 化 工 总 公司 文 件 中石化 ( 1 99 4)建字 78号 关于发布行业标准 《工程设计计算机软件开发 及文档编制规范》的通知 各有关单位: 由中国石化北京设计院主编的 《工程设计计算机软件开发及文档编制规范》已审查 定稿.现批准 《工程设计计算机软件开发及文档编制规范》S H/ T3 901 一1 99 4为石油化工 行业推荐性标准,自一九九四年八月一日起实施. 本标准的具体解释工作,由中国石化北京设计院负责. 中国石油化工总公司工程建设部 一九九四年 二月二十 四日 目 次 1 总则・ ・ ・ ・ ・・ ・ ・ ・ ・ ・ “・ ・ ・ ・ ・・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・・ ”・ ・”・ ・ ・ ・ ・ ・ ・ “・ “・ ・・ ・ ・ ・ ・ “・・ ・ ””・ ”・ ”・ ・ ・ ・ “一 ”・ ・ ”・… 1 2 软件开发期工作阶段的划分及其文档“・ ・ ・ ・ ・ ・・ ・ ・ ・ ・・ ”・ ・ ・ ・ ・・ ““・ “・ ・ ・・ ・ ・ ・ ”・ ”・ ・ ・ “・ ‘… z 3 项目开发计划・・ ・ ・ ・ ・ “・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ “・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・・ ・ ・ ”・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・・ …… 4 4 需求分析・ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ”一 5 5 概要设计・ ・ ・ ・ ・ ・ ・ ”・ ・ ・ ・ ・ ・ ・ ”・ “・ ・ ・ ・ ”“・ ・ ・ ・ ・ ・ 一 ”・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ “・ ・ ““・ ・ ““・ ・ ・ ・ ・ ・ ・ ”・ ・ ・・ ・ ・ ・・ …… 7 5 .1 用户界面设计”・ ・ ・ ・ ・ ・ ・ ・ ・”.・ ・ ・ ・ ・ .・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ”・・ ・ ・ ・ ・ ・・・ ・ ”・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・・ ・ ・ …… 7 5: 2 算法设计・ ・ ・ ・ ・ ・ ”・ ・ ・ ・ ・ ”・ “・ ・ ・ ・ ・ ・ “・ ・ “・・ ・ ・ ・ ・ ・ ・ “・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・一 ”“・ ・ ・ ・ ・ ・ ・ ・ ”・ ・ ・ ・ ・ ・ …… 8 5. 3 结构设计・ ”・ ・ ・ ・ ・・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・・ ・ ・・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ……: ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ”・ ・・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ …… 9 6 详细设计 ( 模块设计)・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ”・ ・ ・ ・ 一 1 1 了 编程 ・ ・ ・ ・ ・ ・ ・ ・ ・ “・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・・ ・ ・ ・ ・ ・ .・ , ・ “・ ・・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ”・ ・ ・ ・ ・ ”・ “・ “・ ・・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・・ …… 1 2 8 调试. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 3 9 测试与验收“・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ”・ ”・ ・ ・ ・ ”“・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ””・ ・ ・ ・ ”・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ “・ ・ ・ ・ ・ ・ ・ “・・ …… 1 4 附录 A 用词说明 ・ ・ ・ ・ ・・ ・ ・ ・ ・ ・ ・ ・ ・ ”・ ・ ・ ・ ・ ・ ・ ・ ”・・ ・ “・ ・ ・ ・ ・ ・ ・ ・ ・ ・・ ・ ”・ ・ ・ ・ ・ ・ ・ ”・・ ・ ““・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ …… 1 5 附加说 明 ・ ・ ・ ・ ・ ・ ・・ ・ ・ ・ ・ ・ ”・ ・ ”・ ・ ・ ・ ・・ ・・ ・・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・・ ・ ・ ・ ・ ・ ・ ”・・ ・ ・・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・ ・・ ・ ・ …… 1 6 附条文说明・ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 7 总 则 1 . 0.1 为使石油化工工程设计计算机应用软件的开发工作概念统一、格式一致、文档 资料清晰完整;使软件开发工作规范化、系统化、工程化:提高软件开发效率和软件产 品质量:促进软件的商品化:特制订本规范。 1 . 0 . 2 本规范适用于一般开发难度的中型 (兼顾大、小型)石油化工工程设计计算机 应用软件的开发及文档编制工作。特殊软件项目可参照执行。 1 . o. 3 开发石油化工工程设计计算机应用软件,除执行本规范外,尚应符合现行国家 的有关标准、规范的规定 。 2 软件开发期工作阶段的划分及其文档 2.1 软件开发期工作 阶段 的划分 2.1. 1 软件开发期一般可划分为项目开发计划、需求分析、概要设计 (包括用户界面 设计、算法设计、结构设计)、详细设计、编程、调试、测试与验收等七个工作阶段。 如表2.1 .1所示。 2.1 . 2 软件开发期工作阶段的划分不是绝对的。复杂 的大、中型软件 ,可根据其特点 和 需要 ,对上 述划分的各工作阶段进 行再分解 。 2. 2 软件开发期的文档 2.2 .1 软件规模 的划分 小型软件:源程序少于5 0 00行或存储量小于 1 m. 中型软件:源程序5 00 0^- 30 00 0行或存储量 1 ^- 50 M; 大型软件:源程序多于 3 0 00 0行或存储量大于5 0M. 2 .2 .2 在软件开发期的每个工作阶段,软件开发人员必须编写出相应的文档.不同规 模软件文档的组成见表2.1 .1 . 2 .2 .3 文档编写的详略程度应随着软件的开发难度、复杂程度、重要性、开发风险等 的提高而增加。必要时可在各工作阶段的文档中增设需要的条目和内容。 2 .2 .4 文档的内容应完整、统一;定义应严格、准确:叙述应简练、逻辑性强;所提 的要求和指标应具体、可验证;使用的技术用语、图例、符号等,应符合有关专业技术 和软件技术的标准、规范、规定的要求,并在所有文档中保持一致. 2 .2 .5 用户手册的编写除应符合 2.2 . 4条要求外,尚应适合工程技术人员的使用习惯 和要求. 2 .2 .6 软件开发过程中的文档修改,应在严格管理下按以下不同情况分别对待: 2 .2 .6 .1 凡不涉及文档内容的修改,可仅仅修改源程序。 2. 2. 6. 2 涉及文档内容的一般性修改,应将源程序和文档同步修改。 2. 2. 6. 3 凡涉及软件的或模块的功能、性能、软件结构、数据结构、算法、接口等 文档,建 立本 次修改的文档 ,并 以新文档取代原文档. 软件开发期的工作阶段划分及其文档设置 大 型 工 作 阶 段 软 件 中 型 软 件, 小 文 档 设 里 工 作 阶 段 文 档 设 兰 表2 . 1 . 1 型 工 作 阶段 软 件 文 档 设 呈 项目开发计划 书项目开发计划 与软件需求说 项 目 开 发 项 目 开 发计 项 目 开 发 项 目 开 发 计 划 划 书 划 计 计 划 雷 求 分 析 软 件 需 求说 需 求 分 析 软 件 需 求 与需求分析 明 书 说 明 用 户界 面 用户界面设计 用户界面 用户界面设计 设 设 说 计 说 明 书 概 算法设 计 要 算 法 设 计 说 设 结构设计 结 构 设 计 计 说 明 明 计 算法设计 书 明 书 算法设计说明 书 结构设计 书 明书 书 结构设 计 说明 书 软件 设计 说
1994-SHT 3901-1994 关于《工程设计计算机软件开发及文档编制规范》的行业标准
温馨提示:如果当前文档出现乱码或未能正常浏览,请先下载原文档进行浏览。
本文档由 张玉竹 于 2022-04-07 17:26:46上传分享