系统设计报告编写规范


    













    系统设计报告编写规范



















    文件编号:
    NW506101
    生效日期:
    2000320
    受控编号:
    密级:秘密
    版次:Ver21
    修改状态:
    总页数
    19
    正文
    4
    附录
    15
    编制:胡景德
    审核:袁淮孟莉
    批准:孟莉



    沈阳东阿尔派软件股份限公司
    (版权翻版必究)




    文件修改控制

    修改记录编号
    修改
    状态
    修改页码条款
    修改
    审核
    批准
    修改日期
































































    目录

    1 目
    2 适范围
    3 术语缩略语
    4 编写规范
    41 排版规范
    42 模板
    5 引文件
    6 附录

    1 目
    系统设计报告软件产品软件项目满足规定软件规格求确定软件系统体系结构组成成分数组织模块外部接口务:
    1) 建立软件产品软件项目目标系统总体结构规模软件系统应分干子系统报告中说明总体设计然子系统编写系统设计报告
    2) 总体设计
    3) 模块设计
    4) 涉数库设计需编写数库设计

    2 适范围
    适软件开发设计阶段系统设计报告编写

    3 术语缩略语
    程序采NQ402100质量手册中术语缩略语定义

    4 编写规范
    41 排版规范
    1) 整规范2节构成模板单独节
    2) 正文样式采规范正文
    3) 标题编号采节独立编号
    42 模板
    系统设计报告编写具体情况选摸板格式编写指南格式
    1) 拷贝规范
    2) 删第节(系统设计报告封面前页)
    3) 修改完容更新目录域相关页数域

    5 引文件
    ()

    6 附录
    部分系统设计报告模板编写指南
    密级:机密
    文档编号: 第 版
    分册名称: 第 册 册








    项目名称(项目编号)

    系统设计报告



    (部门名称)












    沈阳东阿尔派软件股份限公司




    总页数

    正文

    附录

    生效日期: 年 月 日
    编制:
    审核:
    批准:


    目录

    1 引言
    11 目
    12 背景
    13 术语
    14 参考资料
    2 总体设计
    21 系统运行环境
    22 软件功描述
    23 软件结构
    24 技术路线
    25 外部接口
    251 户接口
    252 软件接口
    253 接口
    3 模块设计
    31 功
    32 性
    33 部接口
    34 外部存贮结构设计
    4 障处理说明
    5 数库设计
    51 数字典设计
    52 安全保密设计

    1 引言
    11 目
    说明编写系统设计说明书目
    12 背景:
    说明理解报告需背景公司软件间联系等
    13 术语
    列出系统设计说明书中专门术语定义英文缩写词原词组
    14 参考资料:
    列出编写参考文件资料技术标准作者标题编号发布日期出版单位
    编号
    资料名称
    简介
    作者
    日期
    出版单位







    列出编写报告时需查阅Intenet杂志专业著作技术标准网址
    网点
    简介




    2 总体设计
    21 系统运行环境
    出软件系统运行需基软硬件环境软件系统典型户设备分布图设备相应软件配置软件环境包括:操作系统数库支撑软件硬件环境包括:机类型网络类型存储器容量特殊设备
    22 软件功描述
    描述开发软件功等作文件(已编写软件功规格说明书)直接引述该文件名档部门
    23 软件结构
    图表形式出软件子系统结构模块组成结构单独编写系统设计报告子系统部模块必列出
    24 技术路线
    出软件系统实现程中采技术路线方法较新技术予详细阐述必说明情况出相应技术参考资料
    25 外部接口
    251 户接口
    描述该软件户接口包括户输入输出界面样式操作方式界面间转移关系具等作文件(开发工具编写界面原型程序等)处仅需列出该文件名保部门
    252 软件接口
    描述该软件系统软件接口说明系统提供编程接口系统系统提供编程接口具等作文件(包含接口说明注释源文件程序头文件接口帮助超文文件等)处仅需列出该文件名保部门
    253 接口
    描述该软件系统类型接口说明系统提供系统系统提供硬件接口通信协议规程数交换格式等具等作文件处仅需列出该文件名保部门

    3 模块设计
    31 功
    简述模块功
    32 性
    说明模块性求包括精度时间特性处理速度
    33 部接口
    说明模块间接口包括:
    1) 模块途(调)方式
    2) 说明子程序(方法Method)特性(Property)反馈事件(Event)相应输入输出项说明
    3) 指明模块含类外部接口列出外部接口说明材料名
    34 外部存贮结构设计
    说明系统存贮磁盘等持久性存贮介质数库理系统进行理数组织结构包括数名称途数项标识名类型含义组织结构访问方法存储求

    4 障处理说明
    说明系统采基错误处理方法原例:统采C++ trycatch错误方法错误终必须界面形式户说明览表方式说明类错误障出现时系统处理方法补救措施

    5 数库设计
    51 数字典设计
    数库设计中涉种项目数项记录表数库等建立数字典说明标识符义名关信息说明数字典设计基考虑采数库设计工具(ER图设计工具)生成数字典处仅需列出应文件名保部门
    52 安全保密设计
    说明数库设计中通区分访问者访问类型数象进行分获数库安全保密设计考虑
    系统设计报告编写指南

    1 Introduction介绍
    l 描述文档编写目
    l 描述文档适范围
    l 描述文档读者
    l 确定系统产品名称版号
    l 定义重术语缩写词缩略语
    l 总结(出概)文档容

    2 System Overview系统概述
    软件系统般性描述包括系统功设计相关容

    3 Design Considerations设计考虑
    节描述完成完整设计解决方案前必须阐明解决问题
    31 Assumptions and Dependencies假设赖
    l 相关软件硬件
    l 操作系统
    l 终户特征
    l 功发生变化
    32 General Constraints般限制
    l 描述软件系统设计重影响全局限制约束
    l 硬件软件环境
    l 终户环境
    l 资源性挥发性
    l 标准兼容(option)
    l 协工作求
    l 接口协议求
    l 数储存发布求
    l 安全性求(类似规)
    l 存容量限制
    l 性求
    l 网络通信(option)
    l 验证确认求(测试)
    l 质量目标求
    l 需求分析说明书中描述求
    33 Goals and Guidelines目标指导方针
    描述支配软件系统设计目标指导方针原者优先权
    l 量保持简单易
    l 强调速度存矛盾
    l 象已存产品样工作观察者体会
    34 Development Methods开发方法
    简描述软件设计方法果采正式已公布方法方法进行详细描述时简单解释什采方法中某部分

    4 Architectural Strategies体系结构策略
    描述影响整系统组织结构设计决定策略策略深入描述系统体系结构关键技术机制设计决定策略描述产生原(引前面阐述设计目标原)均衡折中涉容:
    l 特定类型产品(编程语言数库函数库等)
    l 重现组件
    l 软件未扩展升级计划
    l 户接口模型(系统输入输出模型)
    l 硬件软件接口模型
    l 错误检测恢复
    l 存理策略
    l 外部数库数存储理维护
    l 网络分布式数控制
    l 控制般方法
    l 发步
    l 通信机制
    l 资源理
    采重战略必须相应子章节加讨

    5 System Architecture系统体系结构
    节应该较高层次说明系统功划分子系统组件涉组件身细节(面节专门详细描述组件)节目标描述系统进行分解样分解原部分协作工作完成预定功
    较高层次描述系统承担工作责系统扮演种角色描述系统划分成组件子系统组件子系统作什描述高层组件间协调工作已完成预期功进行系统分解时采基原图表模型流程图等形式描述述容
    51 Subsystem Architecture子系统体系结构
    建立子章节详细描述某组件作进步描述该组件分子组件子组件间关系

    6 Policies and Tactics政策实施策略
    描述影响系统接口细节系统实现细节方面:
    l 选择特定产品(编译器解释器数库函数库等)
    l 工程折中
    l 编码规范惯例
    l 子系统模块子程序协议
    l 选择某特定算法编程语实现系统部分
    l 功性说明
    l 保证需求回溯性计划
    l 软件测试计划
    l 软件维护计划
    l 终户软件硬件通信接口
    l 源代码物理形态(文件路径)进行分层组织
    l 构造产生系统交付物(编译链接加载等)
    项容必须相应子章节进行讨果方案供选择时说明没选择方案原图表模型流程图等形式描述述容

    7 Detailed System Design详细设计
    系统体系结构中描述绝数组件需章节进行更深步讨样低层组件子组件需描述组件建立子章节详细描述组件包括容:
    l Classification 分类
    组件种类例子系统模块类包函数文件等等
    l Definition 定义
    组件确切途语义需参需求说明
    l Responsibilities 责
    该组件责行完成什?扮演什角色?客户提供写服务?需参需求说明
    l Constraints 约束
    该组件相关假设限制者约束时间存储组件状态包括该组件进行交互规(前提条件置条件变量输入输出值局部全局值限制数格式数存取步例外等)
    l Composition 合成
    描述组成该组件子组件途
    l UsesInteractions 户接口
    描述该组件组件间关系该组件组件?该组件组件?关系交互作方法面象设计必须描述已知预期子类超类元类
    l Resources 资源
    描述组件理影响资源存处理器印机数库软件库描述存资源竞争死锁等情况相应解决方案
    l Processing 程
    描述该组件执行程包括算法状态变化相关时间空间复杂性发创建方法初始化清例外情况处理
    l InterfaceExports 界面出口
    描述该组件提供服务资源数类型常量子程序例外等集合明确定义服务元素分类定义责约束组合资源处理接口描述
    71 Detailed Subsystem Design详细子系统设计
    章节该组件进行更详细描述复杂图表显示组件结构行者信息控制流

    8 Glossary词汇表
    列出文档中定义术语概念

    9 Bibliography参考书目
    参考书目相关出版物列表
    系统设计报告编写指南二

    Objectives 目标
    描述系统设计报告容目

    Scope 范围
    适指导包含设计阶段项目编写系统设计报告

    3 References 参考

    4 Outstanding Issues 尚存问题

    5 Approvals 批准
    R&D单位负责

    6 Responsibilities 职责
    61 开发部长系统设计报告进行审核
    62 项目理部门组织系统设计报告进行评审
    63 设计员提交符合指南系统设计报告
    64 设计员设计阶段文档进行配置理

    7 Template 模板
    71 Introduction 绪
    l 项目概述
    l 设计产品概述
    72 System Description 系统描述
    721 Support for Requirements 需求支持
    l 设计满足需求程度
    l 设计未完全满足需求原
    722 System Purpose 系统目标
    简述开发系统果系统系统手工计算机方面关系描述参考需求分析报告容
    723 Inputs and Outputs 输入输出
    详细描述系统输入输出包括界面设计报表设计参数格式
    724 Functions功
    描述系统提供功
    725 Stored data 数存贮
    简述系统数文件
    726 Security and backup 安全备份
    系统安全备份方面考虑设计包括回滚恢复
    727 Exception handling 例外处理
    系统产生错误信息列表包括错误发生条件采取措施例外情况列表系统采取措施
    728 Impact assessment 影响评估
    描述系统现环境重影响工序变化工作量变化硬件变化参需求分析报告容
    73 User Procedures 户规程
    731 System navigation 系统导航
    描述户充分系统规
    732 Routine 例程
    l 描述正常工作环境系统预期方法
    l 流程图描述例程流程图带辅助描述描述功户类型
    733 Exception 例外处理
    描述系统异常情况处理方式网络失效时数恢复
    734 Installation 安装
    描述系统安装程
    74 System architecture 系统结构
    741 Design principles 设计原
    描述系统设计采策略户界面形式标准产品等
    742 Design rationale 设计原理
    l 描述进行设计数库结构等
    l 模块调原理:部外部修改重建重
    743 Software components and interfaces 软件组件接口
    l 描述系统中组件包括间传递包数流
    l 数流图功分解图
    l 描述引外部模块
    744 Capacity requirements 系统资源需求
    估计系统容量等需求界值存磁盘空间传输速率等
    745 System structure 系统结构
    描述系统模块连接起工作
    75 Data 数
    751 Definitions 定义
    系统中包含数项描述
    752 Database design 数库设计
    l 逻辑数库文件设计描述
    l 物理数库文件设计描述
    l 数校验规
    753 Calculations 算法
    l 定义系统采计算算法
    l 确定实现算法流程
    754 Data management procedures 数理程序
    描述系统数理流程存档等
    76 Module specifications 模块说明
    l 详细描述模块逻辑功模块状态模块关联状态变迁存条件采取动作
    l 简洁标准语言
    l 说明模块输入输出
    77 Physical environment 物理环境
    描述建立运行系统需物理环境
    78 Appendices 附录
    l 数流图
    l 数模型

    文档香网(httpswwwxiangdangnet)户传

    《香当网》用户分享的内容,不代表《香当网》观点或立场,请自行判断内容的真实性和可靠性!
    该内容是文档的文本内容,更好的格式请下载文档

    下载文档到电脑,查找使用更方便

    文档的实际排版效果,会与网站的显示效果略有不同!!

    需要 2 积分 [ 获取积分 ]

    下载文档

    相关文档

    技术报告编写规范

     技术报告编写规范 文件编号: NW506102 ...

    7年前   
    7092    0

    项目总结报告编写规范

     项目总结报告编写规范 文件编号: NW504102 ...

    12年前   
    29051    0

    需求分析报告编写规范

     需求分析报告编写规范 文件编号: NW503101 ...

    7年前   
    15039    0

    流程编写规范

    IVR 流程编写标准IVR Coding Standard编制单位:新太科技技术开发中心编制时间:2004/2/20文档编号:SPMS-SEP-12版 本 号:内部试用版编制审核批准生效日期汤...

    8个月前   
    188    0

    风评报告编写规范及参考样式

    附件1   社会稳定风险评估报告编写规范   社会稳定风险评估报告是一种特定的公文。本《编写规范》适用于四川省范围内重大决策社会稳定风险评估。重大固定资产投资项目的社会稳定风险分析篇章...

    7年前   
    3791    0

    可行性分析报告编写规范

     可行性分析报告编写规范 文件编号: NW503101 ...

    13年前   
    8837    0

    测试计划编写规范

     软件测试计划编写规范 文件编号: NW507101 ...

    8年前   
    30859    0

    开发计划编写规范

     开发计划编写规范 文件编号: NW504101 ...

    12年前   
    19792    0

    数据库编写规范

    数据库编写规范 帝音科技 版本 1.0 修订历史记录 日期 版本 说明 作者 2004-07-11 1.0 使用表格进行归类;添加、修改了一些内容 吴雪青 2004-0...

    6年前   
    29093    0

    初步设计编写格式例文11

    初步设计编写格式例文11 年处理500吨药材的中药提取车间工艺设计初步设计说明书班级:学号:姓名:湖州师范学院2012.05目 录第1章 总 论 ....................错误!...

    10年前   
    573    0

    测试工作总结编写规范

     软件测试工作总结编写规范 文件编号: NW507103 ...

    10年前   
    11874    0

    计算机源代码编写规范

     计算机源代码编写规范 文件编号: NW506104 ...

    12年前   
    25792    0

    软件功能规格说明书编写规范

     软件功能规格说明书 编写规范 文件编号: NW503102 ...

    13年前   
    9736    0

    配置管理计划编写规范

     配置管理计划编写规范 文件编号: NW601102 生效日期: 2000.3...

    10年前   
    4026    0

    实习报告的编写

    实习报告的编写  自然地理野外实习结束以后,即转入室内整理和综合分析阶段,对实习的基本内容从感性认识提高到理性认识上来。在室内整理和认真研究的基础上,应编写自然地理野外实习报告或就某一专题进行...

    12年前   
    751    0

    XX加工厂供配电系统设计供配电系统设计报告课程设计

    xx大学 供配电系统设计报告 课 题 某加工厂供配电系统设计 专业班级 自动化**** ...

    4年前   
    1135    0

    地质认识实习报告的编写

    地质认识实习报告的编写  地质认识实习报告的编写  在野外实习结束时,每位同学都必须编写一份实习报告,对实习内容进行系统而概括地总结。地质报告是完成野外和室内各种工作后的最终成果,编写地质报告...

    9年前   
    519    0

    通风系统规范

    通风与空调设备安装(净化空调系统)检验批质量验收记录 (GB50243-2002)表C.2.5-3                                          编号:W...

    5年前   
    1596    0

    信号与系统设计性设计性实验报告

    《信号与系统实验》综合设计性实验报告册实验项目:选频网络的设计及应用研究 学院:物理与电子工程学院 年级专业班: 电子 姓名: 学号: 成绩: 实验地点:电子楼指导老师:...

    1年前   
    314    0

    微机课程设计报告计算机钢琴的程序编写

    微 机 课 程 设 计题 目计算机钢琴的程序编写学 院物信学院专 业电子信息工程班 级电信班姓 名学号指导教师一.实验目的 1.掌握利用pc机扬声器发出不同频...

    3年前   
    667    0

    文档贡献者

    f***t

    贡献于2015-05-26

    下载需要 2 积分 [ 获取积分 ]
    下载文档