软件开发规范.doc

软件开发规范一、需求分析1、需求分析中必须注明参考文件的名称及来源，包括技术协议、外来文件（如用户提供的图纸）等。2、测点明细表的标题栏包括：序号、测点代码、测点名称、I/O类型、传感器型号、传感器类型、量程范围、精度等级、报警/联锁值、开车条件值、备注等项，参考“测点明细表_规范”。3、需求分析应包括软件的功能、性能、用户界面、运行环境、数据要求（包括数据逻辑描述和数据采集的各项要求），并根据需求综合成系统的解决方案，给出目标系统的详细逻辑模型。4、对于特殊功能，应从硬软件两方面来考虑实现的可行性，并作为开发工具及系统运行平台选用的依据之一。5、需要分析中应包括软件的有效性准则，以保证对软件进行确认测试。6、需求分析的最后一步是需求分析评审，应从功能的正确性、完整性、清晰性以及其他需求给予评审，评审的内容主要包括：系统定义的目标是否与用户的要求一致；系统需求分析阶段提供的文档资料是否齐全；文档中的所有描述是否完整、清晰、准确反映用户要求；与所有其他系统成分的重要接口是否都已经描述；所开发项目的数据流与数据结构是否足够，确定；所有图表是否清楚，在不补充说明时能否理解；主要功能是否已包括在规定的软件范围之内，是否都已充分说明；设计的约束条件或限制条件是否符合实际；开发的技术风险是什么；是否考虑过软件需求的其他方案；是否考虑过将来可能会提出的软件需求；是否详细制定了检验标准，它们能否对系统定义成功确认；有没有遗漏、重复或不一致的地方。对评审结果包含有修改意见的，待修改完成后再经评审通过后，才可进入设计阶段。评审结束后，项目负责人应即时写出评审报告。7、在需要分析阶段，应提出项目的进度计划。二、系统总体方案（概要设计）、详细设计1、软件部分应包括系统的功能分配、模块划分、程序的总体结构、输入输出及接口设计、运行设计、数据结构设计及出错处理设计等，必要时提供特殊界面图样。2、控制系统运行逻辑应包括工艺流程、控制逻辑（与硬件一起）、数据流程。3、测点图、系统配置表及设备清单等要求参见硬件管理规范。4、软件设计图纸必须包括图例及符号说明、软件结构、软件功能、画面跳转关系（包括菜单说明）、软件逻辑图、软件界面、数据字典（包括变量名、数据类型、I/O及本地变量类型、I/O型通道编号等等，与测点明细表相对应）。5、在详细设计中应对于特殊算法说明其实现方法，每个软件功能块，应写出其逻辑流程。三、软件编程1、软件编程必须以签字批准的详细设计图纸为依据。2、软件编程应遵守代码编写规范（如各代码段前应有注释，例程的名字永远应该以大写的字母开头并且中间错落分明以便于可读性、永远不要在括号与括号之间的字符中间留下空格、相同类型的形参应合并在一个语句中、各代码段间应有空行间隔等）。3、软件的更改必须在图纸修订并签字批准后方可进行，并保持需求分析说明书、软件设计图纸等文档的同步更改。四、软件组装、测试（出厂前调试）1、在检测回路硬件线路的基础上，用模拟信号逐点按量程的0%、25%、50%、75%、100%，检查回路信号的一致性，PID回路的响应性，报警联锁值设定的正确性.2、将I/O逐点与现场一次元件连接起来，检查I/O点现场值与显示值的一致性，执行元件的响应性。 3、在软件进行测试前，程序员必须已经根据设计图纸进行了代码调试（Debuging）。4、在设计测试用例时，除包括合理的输入条件，还应包括不合理的输入条件（如非法字符等异常输入、报警联锁等临界值输入）。5、必须严格执行测试计划，排除测试的随意性。测试计划应包括：所测软件的功能、输入和输出、测试内容、各项测试的进度安排、资源要求、测试资料、测试工具、测试用例的选择、测试的控制方式和过程、系统组装方式、评价标准等。在测试中，应对每一个测试结果做全面检查，以抓住征候，暴露错误。6、测试包括单元测试、组装（集成）测试、确认测试和系统测试。单元测试的内容应包括：模块接口测试、局部数据结构测试、路径测试、错误处理测试、边界测试。组装测试包括：模块连接时穿越模块接口的数据是否会丢失；各模块的功能间是否有会产生不利影响；各子功能组合后能否达到预期要求的父功能；全局数据结构是否有问题；单个模块的误差累积起来，是否会放大，从而达到不能接受的程度。确认测试包括有效性测试和软件配置复审。有效性测试验证所测软件是否满足需求分析说明书中列出的需求（如软件功能、性能，文档正确性，软件可移植性、兼容性、出错自动恢复、可维护性等），对测试结果与预期的结果不一致的应提供问题报告。软件配置复审包括软件配置的所有成分（如软件用户文档、开发文档等）是否齐全、各方面的质量是否都符合要求。系统测试的软件必须是已通过确认测试，必须在实际运行（使用）环境下进行，其测试用例应根据需求分析说明书来设计。系统测试应包括功能测试、可靠性测试、性能测试、配置测试、互连测试、容量测试。系统测试通常现场调试阶段进行。7、出厂前检验，应有检测员授权书，项目负责人应根据需求分析说明书设计出厂检验大纲，根据大纲进行出厂前检验。检验结束后，应根据运行情况写出72小时运行总结报告，同时填写出厂检验报告、提交用户资料表和装箱单。五、现场调试1、软件的现场调试必须与硬件调试相结合。2、软件的现场调试主要为系统测试，先进行静态测试，当所有单元的静态测试都完成后，才能进行动态调试（带负荷运行）。3、现场调试的具体要求，参见“现场调试大纲”。调试结束后，应提交现场验收报告和用户验收纪要以及项目总结报告。4、在现场调试结束后，应根据项目总结报告中的修