【石油化工行业标准(SH)】 工程设计计算机软件开发及文档编制规范

中华人民共和国行业标准
SH/T3901-1994
工程设计
计算机软件开发及文档编制规范Frocedure for computer softwaredevelopment and docunentation1994-02-22发布
1994-08-01实施
中国石油化工总公司
中华人民共和国行业标准
工程设计
计算机软件并发及文档编制规范Procedurc for cobputer softwaredevelopmentand documentationSH/T3901-1994
主端单位，中国石化北京设计院批准邮门：中国石油化工总公司1994北京
各有关单位：
中国石油化工总公司文街
中石化（1的4）建字78号
关于发布行业标工程设计计算机软件开发及文档编制规范”的通知
由中的石化北京设计院主综的工程设计计算机软件开发及文挡编考规范已求查定弱。现批准7.程设计计算机软件开发及文档编制规范SH/T3901-1994为石油化工行业推荐性标准，自一九丸四年儿月一日起案施本标推的具体解释工作，由中国石化北京设讨院负责。中国石油化工总公司工程建设部一九九四年二月二十四日
wt.总则-
2致作开发期工作阶段的划分及其文档3项目开发计剃
4商常分折
5抵要设计
5.1用户异面设计
5:2累法设计
5.3结构投计
详细没计（模块设计）
输程·
测试与验妆
附录A用词说明
附漏说明
附条文说明：
1.01为使石油化工工程没计节机应用软作的开发工作概念统一，格式一致，文挡资料请听光整；使软性开发T作规范化、聚统化、工程化：提密软性开发效率和软性产品盂通：促进教件的商品化：特制订本规范，1.0.2本规范适用于一設开发难度的中型（接顾大、小型）石油化工工程设计讨算机应用软件的开发及文档编制工作。特殊软性项甘可参照热行。1.0.3开发和油化T:T程设计计算机应用作，除执行本规范外：尚应符合现行国家的有关标准，规范的规定，
2软件开发期工作阶段的划分及其文档2.1软件开发期工作阶股的划分
2.1.1软件开发期一股可划分为项目开农计划、带求分析、概要设计（包括旧户界面设计、算法设计，结构设计)、详细投计、编程、调试、测试与验收等七个工作阶段，如表2.1.1所宗。
21.2软件并发期工作附段的划分不是对的。复杂的大，中型软件，可很据其特点和需要，对上述划分的各工作阶毅进行再分解。2.2款件开发期的文挡
2.2.1软件规模的划分
小型软件：源痤序少于5000行或存储盘小于1M中型软件：源程序5000～30000行或存储量1~50M大型软件，源程序多于300行裁存储量大于50M。2.2.2在软格开效期的每个工作阶段，软件开发人员必须编写山捐应的文档，求同规损软件文档的组成见表2.1.1.
2.2.3文档端写的详略程度应随者软件的开发难度，安杂程度、重要性、开发风险等的提高而增加必要时可在务工作阶段的文档中增设带要的条目和内容，2.2.4文挡的内容应宽整、统，定义应严格、准确；敦速应简练、逻辨性账；所提的要求和指标应具体、可验证；使用的技术用语、图例、符号等，应符合有关专业技末和软件技术的标准，规范、规定的要求，并在所有文档中保持一致。2.2.5用户手册的编写除应符合2.2.4条要求外，尚应适合工差技术人员的使用习慢和要求。
2.2.心软件开发过程中的文档静收，应在严格管理下控以下不同情祝分别对：2.2.6.1凡不涉及文档内容的修改，可仅仪修改源序。2.2.6.2涉及文档内容的一股性修改，应将源程序和文同步惨改。2.2.6.8凡涉及软性的或模块的功能、性能、软件结构、数据结构、算法、提口等软件基本特征的候改，应按以下步翊进行，（1）提议，软件开发人员向项日负资人提出书面像改建议，说明改理出、修改内容、修改方实以及需要静改的文档及其共部位：（2）审表：由现目负责人对该项修改建设进行审核，并制定修改突施计划：3）批准，一般情况下，批准权属于开发部门负黄人：（4）实藏：项目负责人按批准的修改计划，安排人员实施整改工作，修改相关的女档，露立本次修改的文档，并以新文档取代原文档，较件开发期的工作阶段划分及其文档设置大型较件
工作阶
项目开发
文档设置
开发计
作院段
项目卉发
文程设五
月开，
工作阶接wwW.bzxz.Net
表 2. 1. 1
文程设卫
项目开发计划
书项目开发计划
与缺传需求说
求与需来分析
索求芬新教件需求说
需求分析较件需
用户界面
较算法设计
设结构设计
详即设计
浏演与整北
用户界面设计
算法设计
说明书
构设计
进明书
模块开发春审
用户手研，
户指南．摊作
安装手册
教件调试例题
项目开发患站
软件测筑报告
文检资料验收
月户试用报告
验设会审报告
用产系面
其法设计
结构设计
详细设计
用户再面设计
其法设计试期
结构设计疏明
模琪开发卷家
限户手册
软件调流例趣
项耳开发总站
软件测试投告
文超资快查收
测试与验收报告
解户试间告
验收会审投告
教件设计
剧试与验款
较件设计说明
（模块开发考
宗和测越创题
巢可的情取
用卢手册
资国开赛品
3项目开发计划
3.1任务
3.1.1对开发该收料项目应完成的土要工作、需要的条将、开发的产的、参加的人只、任务的分配、开发的进度、经费的使用等收出计划：提山应制定的各项专越计划并说明其铺写要点：编写项日开发计划非等。3.2实施步爆和要求
32.1根据软件项日的可行性研究报告、开发合内书或整废准的计期任书、上级部的批文：明确软件开发目标、款件的基本功能和性能以及开发工作应完虚的主要工作。对术进行可指性研究的并贫项目，应对可行性研究报告中的内容进行补充论证和说明。3.2.2出开发T.疗应托备的计算机环境和开发条纤。3.2.3确定批装工作查过箱的标准、热格、规定等开发按括。3.2.4刻出完成软件开发工作后，开发单位应提交的软性产品的消单。3.2.5提出开发1.作组织计均.
说明开发组的组成单位及分工：规定项目负盘人、每个工作段（或某一专项开发容、分项目）的负责人、主要开发人员等在开发管理和开发技术方面的职资关亲等，提出参加各工作阶段开发人员的数最及素质要求，3.2.6提出完做各.工性阶段开发任务（括谢研、络训、工作评等）的进度计划，32.7到出各工投的经费支出计划-说明计算机及其辑助设和各种技术资料的购罩、人员培诉，尚耗性村料、动力、运输等各种证。
3.2.8根据开发项自的规模、复教和难易程度、提出器垂测定的各预专感计期，并分期说明其端写要点
专题计划的设置及其内窄详略程度的要求，应随者收性的规换、其程变及开发难度的提高丽增如。在软件开发期内，专题计期包括所五保证计划、款件调试计越、软件测试计划、配置管理计期、安全保密计划、蔡续安装计划、用户培训计划、开发人员培调计划等，
3.2.9编写项日开发计辨拐，
4需求分析
4.1任务
4.1.1在调查用广需求的基础上，进行软件需求定义和软件系统分析工作，确定详细的软件开发日标，功能、性能、内部及外部的接门，开发依据和条件、开发及行的计算机环坡：修订项日于发计划书：输写软件需求说明书等。4.2实施步骤和要求
4.2.1成文包括用户单位、开发单位登托单位和软件管理门人员的需求分析小组益求分析小组的成实应具有较高的技术水平。4.2.2调查，分针用户的滞求，进行性的需求定实。4.2.2.1明确软件开发目标，详细定义软件的各项功能及其应用范围，适用的条红和限制，使用的计尊方法等
4.2.2.2定义软件的性能，
确定较件的数据精度、吋间特性，选行效率、对运行环境的适应能力等性能，4.2.2.8定义软性的属性，
提出在提高软件的可使用性、可维护性、可移拉性，使用诊错及容错技术以及软件在交全保密等右面的设计要求。4.2.2.4确定并发依据。
明俏开发.1.准避循的务级标准、规范规定或科技论文、技术会议的决策等其他开发依据：
4.2.2.5定义软托的开发和运行的计算机环境。明确恢用的主机和联机运行的辅助设各的名称，型号、内样和外存穿量，能置及其有关的技求指标：使用的操作系统、数学软竹包、教据库，编泽影、闭形软件、通迅，网络、联机运行的应用软件等所有支持性艾工具性软件的名称、场写调、版本号、助记号、规格说叫号及来源等。
4.2.2.6需求定义部分文字说明的树摘，也可以由有经验的用户提出，由需求分折小绝进行醒认或修改，
4.2.2.7在技术统方，计算机环度，开发经费和开发周期等实性充许时，需求定义的内容应尽量满足用产的满求。4.2.2.8在造行软件需求定文的工作中，一般情况下应避免涉及软群的实现方案、验证，现管理卵替算内客，以免为后继的软仔设计工作造成不含理的约束，4.2.3进行款件的系统分折。
析化、修改，确认软作需求定义内容、定义款伴主要成分及各成分尚的和软作外部接口的效据希求。
4.2.3.1绘制软指的IP0图、定义软件的外部接口，对软行进行总体表现：4.2.3.2绘制软件的系统分解图，确定并标注软件外部投门及备软件成分问的报：1载提计对软华或分的功能，算法和要求，接门敬据编说明4.2.3.3为使系统分新感要是合理和正确的：在成次（部分或整佳）快分所应对其进行综合评价。以期发现、改进分舒的缺陷宁不足，提商系统分析质划，综会降与等划下。
（1）分解是谷法反了动能类和法常提：（2）上、下层分控中数器流是否平测（3）分解层次是钙沟衡：
（4）每入收件成分的功微及客软性成分间接口数据的义起香确、头体：4.2.4编写软件需求说明1：
4.2.6整改、流普项层开发计划节。4.2.6进行需求分矿阶段工作成果的评审。签门款件需证说明注软件开发期中的重要毕用，在确写完改软件需求说明后，年第片维与发T件之前，邀请近当人造，减交专门小维对软件牌求说明的内容进行两将、全值的评市：评单工军上要有以下儿方出的内容：4.2.6.1需求定文部分的内存是否整、温确，是满足了用的全部篇求4.2.6.2软件系经分拆成果程需求定义内察是秀--致4. 2. 6. 3托发依据足否充分：4.2.6.4辅入、辅小内案的弹细规格可存锣确认：各签门数据足否二额摘速4.2.6.5资计路是咨已放实取：
4.2.6.6采构计发技术是否可行，是否有风验及成付措落：4.2.6.7务种要示！文字说疾的内容是石准通、完搭、晰：4.2.E.日项丘并发让划否可行，任务分配，开发座、经势支出等咨合理。4.2.了款驾求说明还过评审后，者对试行政，须存证得用户单立，开发户位，资单贷、致作营强你门同您后进行。6
W5概嘉设计
3.0.1软企改计L.件包括概恶设计和详细设计内部分内容：据要设：称总传设计、包括用户界而设计，算法设计和结构没计些部分内容，5.1用户界面设计
5.1.1仁务
改计较件输入和简出的恶式，内究和格式，设计款件安装，运行快作钓方式和前今式：就尽用产不函设计说明书和州户乎册弱。5.1.2实整步骗要求
用户系面设计应符合用户的习惯和恶求，易于理解，于使，所加信总景少，辅均性图象，爽示栏数培、说明和导性文字业用得当、5.1.2.1培入异而设计
（1）求所有翰入信息进行定义和分析，建2输入数据序列，确定笑入界而的市式（2）详纠设计输入乔面
设汁工特效率商的入男面
输入数据应阅批而无逻辑上和危义上的重豆，充分利问数据间的内个关系和技术示段，通过数落相工（延需端要使合适的就法）月较少的激据蒲送较复杂的则西。使与可说化我术，适过罪需图形或逐象，外利用计算机的能力和环受空纳，学业提高输入聚面的智能比，简比入过需，减轻入作摄，轨人限率的提意输入1格效率，整汁能提教件可整性的输入界面确定确入而健问诊谱，窄增技术的部起，设汁其实理方法、付别的算法以及压定显的器水性、整性信息等，以提高教件他用的效累和示带性。设计对儿产发好的约入贝亚
学拍的功能齐含，建用行便、除乳有数据加工、诊错、错等动能外，还成买车辑些、税明、搓心、引导等辅助动能：51.2.2输比界面设计，
（）没让文字输用的形式，指定筑出介后：（2改计各种军表、格（数出综图表、种裘格，计算站果）的输出影式、饰资
（）没计照层（域工能资形，照游显示的阻程图象等）的输达形，说明遵箱商本雅、法年、“正、真，影的组会、物山降股宝、便服的动出齐所（），各产的非，设计出的销，说缺准的条件限等7
5.1.2.3设计软件安装、树始化及运行过挥的操作（1）破定软件储存形式，软件安装与初化过程的操作内容利命专，表明安整工作完成的熟试以设安装过程中使用的软件工具等。12：对批处理达行方式设计启动点，检查点等及命令格式：（3）出现非正常运行（故率，错误等）后的提示诺息、处课步称命今格式：（4）列出各种运行销况下的操作命令序列。5.1.2.4编写用广界而设计说明15.1.2.5编与用户乎册扭稿
5.2算法设计
5.2.1任务
案法段计工作，包招算法结构故计和算法过程设计两部分内容。算法结构设计是选择或构造能实现软性功能带求果舍的（包势数据管理、盈据如工罩法）、恰当的克方法，计算公式，形战软排的期法结构：算法过程设计是针对每个计算方法资计其有效节算法过程；编写算法设计说明等。6.2.2实施步赚和要求
5.2.2.1为了降低算法役计的复杂性，进行算法设计时，应根据软件需求说明书有关内容的要求，将个科独立的期法或功能组合，分为举干个子系统，分程序、大的功能模块分别进行，
5.2.22调查、收维备要的享法或计算公式，对收集判的算法或计算公式进行性能评价。性能评价包括以下几方面的内穿：（1）正确性，指该穿法理论、数学物玛模型的止确性；（2）适用性，指该算法对较些中问题渠合的缔合运用程度：（）计算粘度与计节速度的可接受性：4）收效性。即计实纺果的精度随筑法的近似指标改送代次数变化的规伴：（5）存储量，对于算法受适宜的数据结构，党选所要求的存储的精确丧示或行储显随问愈赶模变的凝律：
（6）计算。即计算量的摘确表示或计算盘随问题规模变化的规律，（7）慈定性。指计算过莅的稳定性，抑训算结果的精度对原始数据误差和计葬窃度的依赖性，特别超这冲俊赖性附制题规带变化的规荐：S）复杂性，指算法细传的复杂栏度。5.2.2.3在算法性瓷评价的获础上，选门或白行构造山满起工程技术要求的、能实现款件各项动能，性能需求的计算方法、计算公式、数据加工或转换的势法，违行克法选择时，必额法意算法的成熟性和正确性，以确保软件的可宽性。对或源款性的算法迷据，除战进行可鼎的理论分析和算法性能评价外，前以便用效适试验性方法，进-步该出性能评价。
小提示：此标准内容仅展示完整标准里的部分截取内容，若需要完整标准请到上方自行免费下载完整标准文档。