第六章软件工程文档写作
软件文档写作精品复习材料
第一章 软件工程标准与软件文档1. 软件工程标准的定义？答：按标准的类型划分主要有过程标准、产品标准、行业标准、记法标准等;按标准的范围划分。
主要是根据软件的任务功能和软件生存期进行比较、判定、评价和确定软件工程标准的范围和内容。
任务功能可以表示软件工程过程，可以划分为产品工程功能、验证与确认功能以及技术管理功能3个部分。
意义：提高软件的生产率和软件人员的技术水平；提高软件人员之间的通信效率，减少差错和误解；有利于软件管理；有利于降低软件产品的成本和运行维护成本；有利于缩短软件开发周期。
1.2．软件工程标准的层次？答：根据软件工程标准制定的机构和标准适用的范围，可分为5个层次：国际标准、国家标准、行业标准、企业(机构)标准、项目(课题)标准。
2. ISO9000-3的核心思想？答：强调质量形成于生产的全过程；“必须使影响产品质量的全部因素在生产全过程中始终处于受控状态”；“企业具有持续提供符合要求产品的能力”；“质量管理必须坚持进行质量改进”2.1. ISO 9000系列标准的内容是什么？ISO 9000 质量管理和质量保证标准——选择和使用的导则；ISO 9001 质量体系——设计/开发、生产、安装和服务中的质量保证模式；ISO 9002 质量体系——生产和安装中的质量保证模式；ISO 9003 质量体系——最终检验和测试中的质量保证模式；ISO 9004 质量管理和质量体系要素——导则3. 什么是软件质量？软件质量的6个主特性？答： ①功能性②可靠性③可使用性④效率⑤可维护性⑥可移植性。
第二章 软件文档及其组成1. 什么是软件文档? 答：软件文档也称做软件文件，是一种重要的软件工程技术资料。
2. 软件文档的作用? P16答：是计算机软件的重要组成部分，在软件开发人员、软件管理人员、软件维护人员、用户以及计算机之间起着重要的桥梁作用。
主要反映在以下几个方面：项目管理的依据；技术交流的语言；保证项目质量；培训与维护的资料；软件维护支持；记载软件历史语言；3. 软件文档分为哪三类? 每一类包含哪些文档? 答：基于软件生存期，分成两类：1软件开发过程中需要填写的各种图表，2应编制的各种技术文件或管理资料。
软件工程文档编写
软件工程文档编写一、引言软件工程文档是软件开发的重要组成部分，它记录了软件的需求、设计、实现等关键信息，对于项目的成功实施和后续维护具有重要意义。
本文将介绍软件工程文档的编写流程、要素以及常见的文档类型，旨在帮助开发人员有效地编写规范的文档。
二、软件工程文档编写流程1. 确定文档目标在编写软件工程文档之前，需要明确文档的目标和受众群体。
目标可以是需求说明、设计文档、测试报告等。
受众群体可能包括开发人员、测试人员、项目管理人员等。
2. 收集信息收集所需的信息，包括需求分析报告、设计方案、代码实现等。
在此阶段，需要与相关人员进行沟通，确保理解和掌握关键信息。
3. 组织结构根据文档目标和受众群体的需求，确定文档的组织结构。
常见的结构包括引言、背景介绍、需求描述、设计概要、实现细节、测试过程等。
4. 编写文档内容根据组织结构编写文档内容，要求语句通顺、流畅，重点突出。
在编写过程中，需准确表达各个部分的内容，确保无语义和逻辑错误。
5. 审核与修改完成文档的初稿后，进行审核与修改。
审核过程中，需要确保文档内容准确、规范，并与实际开发情况保持一致。
修改过程中，可以进一步完善文档的表达方式，提高可读性。
6. 发布与分发完成文档审核与修改后，对文档进行最终的发布和分发。
确保文档能够被关键人员及时获取，并在项目开发和维护中起到指导作用。
三、软件工程文档的要素1. 需求描述需求描述是软件工程文档的基础，它记录了软件开发的需求和功能要求。
需求描述应当清晰、具体，并与相关方进行确认和验收。
2. 设计概要设计概要包括软件的架构设计、模块划分、接口设计等内容。
设计概要应当准确、清晰，能够满足软件开发过程中的设计和编码需求。
3. 实现细节实现细节记录了软件的具体实现方式和编码规范。
包括编程语言、算法设计、数据结构等内容。
实现细节应当详细、精确，有助于开发人员理解和实现软件功能。
4. 测试过程测试过程记录了软件的测试策略、测试用例、测试结果等信息。
软件工程文档模板范例
目录三、需求规格说明书 (2)四、概要设计说明书 (12)五、详细设计说明书 (15)3软件需求说明书软件需求说明书的编制是为了使用户的软件开发者双方对该软件的起初规定有一个共同的理解，使之成为整个开发工作的基础。
编制软件需求说明书的内容要求如下：3.1引言3.1.1编写的目的3.1.2背景3.1.3定义3.1.1参考资料3.2任务概述3.2.1目标3.2.2用户的点3.2.3假定与约束3.3需求规定3.3.1对功能的规定3.3.2对性能的规定3.3.2.1精度3.3.2.2时间特性要求3.3.2.3灵活性3.3.3输入输出要求3.3.4数据管理能力的要求3.3.5故障处理要求3.3.6其它的专门的要求3.4运行环境规定3.4.1设备3.4.2支持软件3.4.3接口3.4.4控制4数据需求说明书数据要求说明书的编制目的是为了向整个开发时期提供关于处理数据的描述和数据采集要求的技术信息。
编制数据要求说明书的内容要求如下：4.1引言4.1.1编写目的4.1.2背景4.1.3定义4.1.4参考资料4.2数据的逻辑描述4.2.1静态数据4.2.2动态输入数据4.2.3动态输出数据4.2.4内部生成数据4.2.5数据约定4.3数据的采集4.3.1要求和范围4.3.2输入的承担者4.3.3处理4.3.4影响5概要设计说明书概要设计说明书可称作系统设计说明书，这里说的系统是指程序系统，编制的目的是说明对程序的系统的设计考虑，包括程序系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计、运行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。
编制概要设计说明书的内容要求如下：5.1引言5.1.1编写目的5.1.2背景5.1.3定义5.1.4参考资料5.2总体设计5.2.1需求规定5.2.2运行环境5.2.3基本设计概念和处理流程5.2.4结构5.2.5功能需求与程序的关系5.2.6人工处理过程5.2.7尚未解决的问题5.3接口设计5.3.1用户接口5.3.2内部接口5.3.3外部接口5.4运行设计5.4.1运行模块组合5.4.2运行控制5.4.3运行时间5.5系统数据结构设计5.5.1逻辑结构设计要点5.5.2物理结构设计要点5.5.3数据结构与程序的关系5.6系统出错处理设计5.6.1出错信息5.6.2补救措施5.6.3系统维护设计6详细设计说明书详细说明书可称作程序设计说明书。
软件工程导论(第五版) 第六章
•经典的结构程序设计：只允许使用顺序、
IF_THEN_ELSE选择和DO_WHILE循环；
扩展的结构程序设计：除了三种基本控制结构， 还使用DO_CASE和DO_UNTIL循环；
修正的结构程序设计：除了三种基本控制结构 和两种扩充结构，还使用BREAK等结构。
6.1.1 结构化程序
6.1.1.1 控制结构 • 流程图通常由三种结点组成： •1）函数结点 • 如果一个结点有一个入口线和
行李重量w30行李重量w30国内乘客外国乘客头等舱其他舱头等舱其他舱残疾乘客正常乘客残疾乘客正常乘客残疾乘客正常乘客残疾乘客正常乘客w302w304w303w306w304w308w306w3012免费图67用判定树表示计算行李费的算法636pdl2可以使用普通的正文编辑程序或文字处理系统来完成pdl的书写和编辑工作
•定义7：由基本程序的一个固定的基集合构造出的复合
程序，称为结构化程序。
6.1.2 结构化定理 •结构化定理：任一正规程序都可以函数等价于
一 个 由基 集 合 {顺 序 ， If-else-then，While-do} 产生的结构化程序。
• 实际上，只要能证明可以将任一正规程序转
换成等价的结构化程序就可以证明这个结构化 定理。
123456789 TTTTFFFF TFTFTFTF FFTTFFTT
TFFFFFFFF
×
×
×
×
×
×
×
×
×
•6.3.5 判定树
• 判定树是判定表的变种。
行李重量
国内乘客
头等舱 其他舱
残疾乘客
正常乘客 残疾乘客 正常乘客
（W-30）×2 （W-30）×4 （W-30）×3 （W-30）×6
软件工程文档
图书馆管理系统定义长期以来，人们使用传统的手工操作方式对图书馆进行管理，由于图书的编目和借阅等工作量大，准确性低且不易修改维护，读者借书只能到图书馆以手工方式查找书目，不能满足师学借阅需求，我组采用先进的SQLSEVER创立一套网络化的电子图书馆信息管理系统。
图书管理信息的主要功能有：读者注册、书目查询、图书预定、图书借阅、图书采编、电子读物借阅、读者留言和系统维护等。
该“图书馆管理系统〞的主要设计思想是对信息进行模块化处理，提高图书管理工作效率，对管理的信息标准化，进行科学统计和快速查询，让图书馆更好的为学校的教学和科研提供优质高效的效劳。
该图书馆是一个具有20人以上员工，地理位置分布在学校中央，方便所有师生借阅的地方。
图书馆藏书 20〔相当于20万册〕册，每天的借阅量近2〔相当于2000〕册。
该图书馆管理信息系统效劳对象有两局部人：注册用户和一般读者。
一般读者经注册后成为注册用户，注册用户可以在图书馆借阅图书，其他人员只可查阅图书目录，但不能借阅图书。
用户使用通用的浏览器访问“图书馆管理系统〞，效劳器端采用逻辑效劳和数据库效劳两层，与客户端形成三级系统结构。
为了对系统有一个全面的了解，首先要对系统内部人员结构、组织及用户情况有所了解：图书馆由馆长负责全面工作，下设办公室、财务室、采编室、学术论文室、图书借阅室、电子阅览室、期刊阅览室和技术支持室。
各部门的业务职责如下：办公室〔3人〕：办公室协助馆长负责日常工作，了解客户需求，制定采购方案。
财务室〔2人〕：财务室负责财务方面的工作。
采编室〔5人〕：采编室负责图书的采购，入库和图书编目，编目后的图书粘贴标签，并送图书借阅室上架。
学术论文室〔2人〕：负责学术论文的收集整理。
图书借阅室〔3人〕：提供对读者的书目查询效劳和图书借阅效劳。
电子阅览室〔2人〕：收集整理电子读物，准备提供电子读物的借阅效劳，目前可以提供目录查询和借阅。
期刊阅览室〔2人〕：负责期刊的收集整理和借阅。
软件工程管理中文档撰写
06
软件工程管理文档的评审与改进
文档评审的目的和原则
目的
确保文档的质量、准确性和完整性，提高文档的可读性 和易用性，降低维护成本，促进团队协作和知识共享。
原则
客观、公正、全面、准确、及时、规范。
文档评审的方法和流程
方法
同行评审、专家评审、自我评审等。
流程
明确评审目的和范围、选择合适的评审者、制定评审计 划、进行评审、汇总评审结果并反馈、跟踪改进措施。
VS
方法
可以采用自上而下的方法进行编写，先确 定整体架构和功能模块，再逐步细化各个 部分的设计细节。同时，可以采用迭代式 的方法进行编写，先完成核心部分的设计 文档，再逐步补充和完善其他部分的内容 。
04
软件测试文档
测试文档的定义和作用
定义
软件测试文档是记录软件测试过程、测试结 果和测试结论的正式文件，用于描述软件的 功能、性能和安全等方面的测试情况。
功能需求
详细描述软件系统需要实现的具体功能。
非功能需求
包括性能、可用性、安全性和可维护性等方面的 要求。
约束
限制软件开发的条件或标准，如技术限制、开发环 境等。
假设
对软件开发过程中未明确说明但被认为默认存在 的条件或前提。
格式
可以采用章节、段落、列表等形式进行组织，确保内容 清晰、易于理解和操作。
需求文档的编写技巧和方法
沟通与交流
与利益相关者充分沟通，确保理解其 需求和期望，避免后期更改和返工。
优先级排序
对需求进行优先级排序，确定哪些需 求是核心的、必须实现的，哪些是可 选的、可以稍后考虑的。
细节描述
对每个需求进行详细的描述，包括输 入、处理和输出等，确保开发团队能 够准确理解和实现每个需求。
软件工程之第五、六章总结电脑资料
软件工程之第五、六章总结电脑资料
软件工程的前几章分别是软件、需求分析、软件设计，
【概括】在程序编写这一章，视频中主要围绕程序编写的一些根底、编写方法、还有编写完成后检测的过程。
下来就是首先我们编写程序之前要有一些根本的东西，比方说，我们所使用的语言，它就相当于我们的工具，它说明了“用什么做”，有了工具下边就是方法了，它说明了“怎么去做”。
方法就是利用“结构化程序设计的方法去编程。
这样既简单，又实用。
其次就是结构化程序设计的一些方法、原那么、风格了。
最后，编写完之后应该就是检验的过程了。
比方说检测程序的复杂性的一些方法。
下边是我对这一样的总结导图。
【总结导图】
【第六章概要】编程完成之后，我们的程序是不是可以让顾客满意？是不是有什么问题还需要解决？答复这些问题就需要对我们所编写的程序进行检测，也就是程序测试阶段，。
软件工程管理中文档撰写
文档的主要内容
报告情况：说明发生了什么、当前事情的 状态
解决方案：说明自己将如何处理事情； 请求指示：请求得到上司的指示或指导。 讨论： 你在与上司沟通中碰到的最大难题是什么？ 你以往是怎样面对这些难题的？
文档的八个基本要求（1）
针对性及Biblioteka 性正确性易读性 …
优秀软件文档的特性（3）
• 好的分析一定要基于可靠的数据源，在正确数据基础上做分析，才能找到正确 的结论
• 好的分析报告一定要有解决方案和建议方案。合理的建议和结论对工作更有意 义，管理者不希望你只是个会发现问题 的人。
• 不要害怕或回避“不良结论”，分析就是为了发现问题，并为解决问题提供决 策依据的，发现问题也是你的价值所在。
准确性
统一性
完整性
简洁性
文档的八个基本要求（2）
– 针… 对性
– 针对不同的对 象有不同的写法
– 不要站在自己 的立场上思考别 人的问题
– 不要使用别人 可能不理解的专 业术语
– 对于陌生的术 语要特别描述
正确性
– 没有错字 漏字
– 文档间引用 关系正确
– 文档细节正确 – 观点表达正确
准确性
完整性
视文档为负担
•不愿写 •不会写 •没时间写
要求不到位
•管理者要求不到位 •用户要求不明确 •自身要求不到位
文档撰写不规范
没有软件文档 文档质量不合格 文档与项目错位
文档更新不及时 文档管理混乱
•草草数言应付了事 •艰深复杂难以理解 •格式错误逻辑不清
缺乏考核机制
•偏重项目成果 •忽视文档输出 •文档管理混乱
优秀软件文档的特性（2）
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
6.2.1 功能需求分析
第一级 欢迎使用地铁信息查询系统
中文版
Englis h
6.2.1 功能需求分析
第二级
帮助 返回 1号线 2号线
目的地车站查询 拼音检索车站
6.2.1 功能需求分析
第三级
本线路名
全线线路图 1号线线路图 13 号 线 线 路 图 …… 目的地车站查询
帮助
软件文档写作教程
6.需求分析书案例分析三
地铁综合信息查询系统案例分析 6.1 6.2 6.3 6.4 概述 系统需求 总体结构 用户培训
6.1 概述
6.1.1 建设目标 6.1.2 约束条件 6.1.4 建设原则
6.1.1 建设目标
在新的技术体系架构下，建立符合地铁广大乘客需要的功能 强大的地铁信息查询系统，为乘客提供良好的服务。
1、以地铁运营网络图为主线，以每个车站为查询切入点。 以树状结构图分级，级别不宜超过5级。 2、考虑查询对象的特点，系统应操作简单、生动易理解。 3、以进站与出站为查询出发点的查询。 4、以目的地车站为查询出发点的查询。 5、指导乘客如何使用查询机。 6、嵌入多媒体文件：音频、视频及平面、三维动画文件。 7、查询界面简捷清晰，主要功能突出，图文并茂。 8、广告的布局合理设置，避免视觉疲劳。
业务模式的约束：系统的前后台信息交互过程不是全自动的 过程，需要后台管理员进行大量的录入工作。
6.1.4 建设原则
先进性 实用性 高可靠性 开放性 可维护性 可移植性 扩展性
6.2 系统需求分析
6.2.1 功能需求分析 6.2.2 性能需求分析
6.2.1 功能需求分析
6.4 用户培训
6.4.1 业务培训 6.4.2 技术培训
6.4.1 业务培训
系统开发完成后对系统管理员和系统的维护人员进行全面、 细致的服务，包括各种信息内容的发布、修改、删除、审批 等。对系统的管理进行指导。
6.4.2 技术培训
系统开发完成后负责实现对系统管理用户的基本的技术培训， 保证系统能够顺利的移交给用户进行管理和维护。
同时提供系统的数据接口，实现系统的将来的扩展和完善， 保证系统具备极强的生命周期。
小结
本章以一个企业实际项目的需求文档为案例，从实际应用的 角度来讲述如何撰写规范化的需求分析书。
该项目是一个典型的信息查询系统的开发，在公共交通领域 的信息查询方面具有很强的代表性。
力求通过分析地铁综合信息查询系统的需求分析书，使读者 能够举一反三，融会贯通，明白公共交通类的查询系统的需 求分析书如何撰写，进而推广到如何撰写信息查询类系统的 需求分析书。
6.3 总体结构
6.3.1 技术路线 6.3.2 系统组织架构 6.3.3 多语言的实现
6.3.1 技术路线
系统平台搭建 操作系统：Windows 数据库系统：SqlServer2000 运行环境：JRE 开发语言：Java 应用结构模式：系统的架构模式采用三层架构模式。
同时根据系统的要求，可以将地铁、城铁周边的公交、商业 等信息提供给广大的地铁用户，实现服务于人的目的。
6.1.2 用户特点
用户分类： 普通市民 外来人员（旅游、出差等短期逗留） 外国人
6.1.3 约束条件
域名空间的约束：系统的运行环境、数据存储空间以及应用 程序的存储均受到域名服务商的业务条款约束。
6.3.2 系统组织架构
系统采用基于浏览器模式的B/S（浏览器/服务器）架构，易 于系统的维护和升级。
6.3.3 多语言的实现
系统采用基于struts1.2标准的技术架构体系，利用struts的 标签技术和多语言解决技术实现在业务逻辑上的统一处理与 控制，在信息展现上实现多语言的内容展现。
返回
6.2.1 功能需求分析
第四级
本站名 站内信息 信息公告
目的地查询
帮助
返回
6.2.1 功能需求分析
第五级：站内信息
本站名
车站周边
目的地查询
信息公告
帮助
返回
6.2.2 性能需求分析
性能分析 系统的稳定性 系统的稳定性要求尽量达到24×7的标准，不能时常需要 重新启动服务器，满足用户时时访问的要求。 系统的反应时间 系统的反应时间大部分控制在3秒以内，以提高系统的运 行效率。 系统的并发控制 在一个节点的系统能够支持1000个在线用户，支持100个 并发用户访问。