形成性考核作业
学 号: 20
姓 名:
课程代码: 110121
课程名称: 软件文档编写
评阅教师:
第 3 次任务
共 3 次任务
作业说明:
1.做作业之前首先在封面填上自己的学号和,做完作业后请写上作业完成时间。
2.学习完第六、七、八单元知识后必须完成本次作业,并请在规定时间通过学习平台提交Word文档形式的电子作业,本次作业占形成性考核总成绩的40%。
作业容:
一、填空题(每题2分,共20分)
1、软件产品文档包括软件用户手册、____软件操作手册___、软件产品规格说明书和软件版本说明。
2、软件文档的管理过程分为文档的形成、标识文档类型、____文档的控制_________和文档的修改管理这4个部分。
3、文档修改活动大致可以分为建议、评议、___审核______、批准和实施这5个步骤:
4、软件文档的管理,可以从技术角度和____管理______角度提出和形成各自有效的管理方法。
5、从技术角度,文档的管理维护有两种方式:采用手工、静态的管理方式和__采用新方法、新工具___。
6、由于软件文档的对象复杂性,将面向对象技术和分布式系统管理思想结合,作用在对分布式符合文档的对象管理上,产生了两个新的重要概念:域和_____访问规则________。
7、将系统中具有相似属性的成员集合,以形成___管理域___。
8、__动态__文档是由各种文档元素对象(文字、图形、图像、工作表等)以及一些控制信息组成。
9、Microsoft Visio是一款专业的关于图标解决方案的办公绘图软件,其具有__简单性__和便捷性等特性。
10、Microsoft Visio提供了各种模板,包括业务流程的流程图、网络图、工作流图、_数据库模型图_和软件图等。
二、问答题(每题5分,共30分)
1、请简述编制产品文档的基本要求有哪些?
产品文档面向的是软件产品的具体用户和维护人员等,因此编制的文档应该通俗易懂,避免使用生僻的专业术语。
1、描述规准确
2、叙述简练生动
3、语言严密严实
4、容系统完整
2、请简述一般操作手册应包含哪些容。
操作手册是指导用户具体操作的文档手册,提供操作指定的计算机及其外部设备所需的信息
操作手册的容和形式也有不同,形式上有技术指导书、操作规程等类型,容伸缩性较大。一般应包含下列容:
1、引言 2、操作原理 3、操作说明 4、注意事项 5、附录
3、目前许多CASE系统都提供文档支持和管理工具,其中比较典型的原型系统有哪些?
HyperCASE、CONIC、SystemFactorroject、青鸟系统
4、请简述软件文档的维护一般有哪些形式?
改正性维护
适应性维护
完善性维护
预防性维护
5、请简述动态文档包括哪些容?
动态文档是有各类文档元素对象(文字、图形、图像、工作表等)以及一些控制信息组成,包括以下容:
1、文档对象信息2、文档行为信息3、文档的附加信息4、
6、请列举出现在市面上常见的项目管理软件。
市面上常见的项目管理软件大致可以按照用户对象分为两个档次:
1、专供项目管理人士使用的高档项目管理软件。
售价一般在2000美元以上。如Primaver公司的P3、Gores公司的
Artemis、ABT公司的WorkBench和Welcom公司的OpenPlan等.
2、价格便宜的低档项目管理软件。
这类软件功能一般不太齐全.适用于中小项目。如Time Line、ProjectScheduler、SureTrak、Prject2000等。
三、操作编写题(每题25分,共50分)
1、使用Microsoft Visio进行绘图,参照开放平台课程辅导中第八单元中所给的文档例,编制并完善《省高评委专家库信息管理系统》的概要设计说明书。
(不能直接从PDF截图,要在PDF的基础上进行详细的扩充,并编写在此word文档中)。
高评委专家库信息管理系统文档编制
本附录以省高评委专家库信息管理系统 (Expert 2002) 为实例介绍概要设计说明书和详细设计说明书的编制, 因篇幅有限, 不能提供详细文档, 仅供学习文档写作时参考。 本软件已获国家局计算机软件著作权 (登记号: 200217443) , 并获第三届省人事科研成果一等奖和第四次全国人事科研成果二等奖。 图 B1 为系统的启动界面。
本系统文档编号由文档字母标志、 软件项目名称、 文档类型、 文档生成日期等组成,如概要设计说明书的编号为: W13_EXPERT_SSD_020830 , 详细设计说明书的编号为:WD_EXPERT_DSD_020930 。
图 B1 系统启动界面
文档编号: WD_EXPERT_SSD_020830
实用软件文档写作
版 本 号: V1.0
概要设计说明书
项目名称 省高评委专家库信息管理系统( Expert 2002 )
项目负责人 元 鸣
项目开发单位 工业大学、 时空信息技术
2002 年 8 月 30 日
高评委专家库信息管理系统文档编制
概要设计说明书修改历史记录表如表 B1 所示。
表 B1 概要设计说明书修改历史记录
设计状态 | 摘要 | 设计人 | 设计日期 | 审核人 | 审核日期 | 批准人 | 批准日期 |
创建 | 元鸣 | 2002.8.30 | |||||
一、 引言
1 . 目的
2. 背景
3. 参考资料
二、 总体设计
I . 需求规定
2. 运行环境
3. 基本设计概念和处理流程
4. 结构
5. 功能需求与程序的关系
三、 接口设计
1 . 用户接口
2. 外部接口
3. 部接口
四、 系统数据结构设计
五、 数据结构与程序的关系
六, 系统出错处理设计
1 . 出错信息
2. 补救措施
高评委专家库信息管理系统文档编制
一、 引言
1. 目的
本文档将概要描述省高评委专家库信息管理系统中的功能模块, 主要包括专家管理、 查询统计、 打印、 评委抽取、 系统维护、 用户管理。
2. 背景
为进一步深化职称改革, 完善专业技术职务聘任制度, 建立健全公开、 公平、 公正的人才评价机制, 推进评审工作社会化, 按照专业技术资格评价和管理办法要求, 省人事厅决定组建全省跨行业、跨地区、 跨部门的高级专业技术职务任职资格评审委员会专家库。 工业大学、 时空信息技术受省人事厅委托开始研制省高级专业技术职务任职资格评审委员会专家库信息管理系统(以下简称省高评委专家库信息管理系统 ), 系统主要用于高评委专家库专家的管理和每年度的评审委员会和评议组专家的随机抽取。
3. 参考资料
①《需求说明书》 。
②《系统功能说明书》 o
③《省人事厅关于组建高级专业技术职务任职资格评审委员会专家库有关事项的通知》 (浙人
专(2002)148 号)。
④《项目委托书》 。S
二、 总体设计
1. 需求规定
本系统完成高评委专家库中专家的信息管理、 每年度评审委员会及评议组的随机抽取以及相关的辅助功能, 包括数据上报、 专家查询统计、 工作证打印、 聘书打印、 高评委以及专业组的新建等, 如表B2 所示。
表 B2 高评委专家库信息管理系统容
系 统 名 称 | 模 块 | 功 能 |
省高评委 专家库信息管 理系统 | 专家管理 | 信息浏览、 专家录入、 专家删除、 数据导入、 数据导出 |
查询统计 | 简单查询、 综合查询、 综合统计 | |
打印 | 花名册打印、 工作证打印、 专家聘书打印 | |
评委抽取 | 委员会抽取、 评议组抽取 | |
系统维护 | 高评委的新增、 删除和修改; 评议组的新增、 删除和修改; 代码维护, 专家历史任职维护 | |
用户管理 | 用户设置、 修改密码 |
(1) 硬件平台
硬件最低要求: CPU P Ⅲ 500 以上 PC 服务器, 存 128MB 以上, 硬盘 4GB 以上。
(2) 软件平台
操作系统: Windows98 、 Windows NT 、 Windows 2000 、 Windows XP 。
数据库系统: SQL Server 7. 0、 SQLServer2000( 企业版、 个人版 )。
(3)开发环境
Delphi 5 . 5。
实用软件文档写作
3. 基本设计概念和处理流程
本系统主要的业务处理流程如图 B2 所示。
4. 结构
系统功能结构如图 B3 所示。
(1)系统维护模块
本子系统主要完成专家库中高评委的新建、 修改、 撤销; 每个高评委下专业组的添加、 修改、 撤销; 数据库代码维护, 专家历史任职维护以及树视图定制。
①新建高评委有两种方式: 按专业(学科)组建; 按现有专业技术职务系列和所设的职务类别或相近专业(二级学科)类别组建。 在第一种组建方式中下设若干专业审议组: 在第二种组建方式中不设专业审议组, 其委员人选应在 60 人以上。
②新建专家组用于在高评委下设置新的专家组, 为了数据维护和数据交换方便, 专家组统一编码,设置新的专家组时需要从专家组代码库中选取。
③代码维护是对数据库中使用的代码表进行添加, 删除以及修改, 以保证系统正确有效地运行。
④任职维护是对专家的历史任职进行维护, 主要包括浏览、 删除等。
⑤树视图定制是实现专家人员动态分类管理的途径, 通过该模块用户可以定制树视图, 方便用户管理。
高评委专家库信息管理系统文档编制
(2)专家管理模块
①信息浏览模块是专家管理的主要部分, 通过信息浏览模块可以浏览系统的主要信息, 包括高评
委信息、 高评委下专家组信息以及人员的基本信息和历史任职信息等, 此外, 通过信息浏览可以修改专家的基本信息和照片, 可以彻底删除专家成员: 另外还提供人员查找功能和打印功能。
②专家录入模块包括专家基本信息录入和照片获取, 该模块要提供良好的用户交互界面, 如采用
代码树方便用户选择基本选项, 出生年月和性别可以从自动读出。 为了提高输入效率, 模块采用自动记忆功能, 基本信息自动记忆上一个人的基本信息, 提高录入效率。
③专家删除模块根据实际需要设置两种删除方式: 专家移入历史库和从数据库中彻底删除。 该模
块要提供集合操作方式。
④数据导出、 数据导入模块提供数据交换功能, 以 Access 为中间文件, 可以用于数据备份, 也可用于数据报盘系统。
(3)查询统计模块
①简单查询; 首先选择查询的围 (当前专家库、 历史专家库和所有专家库 ), 然后指定单个信息项进行查询。
②综合查询: 多字段联合查询。 可以对专家库中的专家的多个信息项进行联合查询, 该模块提供
模板功能, 可以把常用的查询保存为模板, 方便用户以后使用。
③综合统计: 为了实现较灵活的统计, 本统计分为一维统计和二维统计。 所谓的一维统计就是统
计结果是一维的, 只有水平方向。 二维统计分为水平统计项和垂直统计项, 使用时, 用户要先规划好统计的表格, 然后先形成水平统计项, 再形成垂直统计项。 另外本模块还提供了模板功能, 把常用的统计方案保存为统计模板。
(4)评委抽取模块
人员抽取是本系统的重点。 在当前的某高评委专家库中随机抽取若干人组成高级专业评审委员会。
本模块强调抽取的随机性。 抽取的原则是:
①主任委员从 3 名主任委员候选人中抽取, 副主任委员从未抽到的两名主任委员和 3 名副主任委
员候选人中抽取, 委员从未抽取到的主任委员候选人和副主任委员候选人及委员候选人中抽取。
②专业评议组从专业评议候选人中抽取, 其中组长是本年度委员, 委员和专家组成员可重复。
③正副高级合一的评委会, 正高级的专家应占 2/ 3。
④评委会中 45 周岁以下的评委占 1/ 3。
⑤评审对象为本单位或系统围以本单位为主的评委会, 外单位同行专家应大于 1/ 2。
⑥上一年度执行评委应随机保留 1/ 2, 另 1/ 2 从专家库其他成员中随机抽取。
抽取结果为: 主任委员一名, 副主任委员 1~2 人, 委员约 23 名, 每个评议组约 7 人。
抽取算法如下。
Step1 : 随机抽取上一年度执行评委的 1/ 2 作为该次的评审委员。
Step2: 抽取主任委员一名。
Step3 : 抽取副主任委员一名或两名 (或数字由用户输入 )。
Step4: 抽取委员 10 名(或数字由用户输入 )。
Step5 : 循环抽取每个专业组成员 7 名(或数字由用户输入 )。
Stcp6: 输出该次抽取。
Step7 : 结束抽取。
(5)用户管理模块
用户管理模块包括两部分。
①设置用户: 主要功能包括增加用户, 设置相应的用户账号和登录密码, 删除用户, 修改用户名。
该模块只有系统管理员权限的用户才能够操作。
②修改密码: 针对每个用户来设置; 每个用户都可以修改自己的登录密码。
(6)打印模块
打印模块的设置主要考虑专家管理的特殊性, 主要设置花名册打印、 委员聘书打印、 工作证打印 3
个模块。
5. 功能需求与程序的关系
功能需求与程序的关系如表 B3 所示。
三、 接口设计
1. 用户接口
本系统采用图形用户接口, 以鼠标和键盘为用户接口, 方便用户对专家数据的操作, 此外采用动态树视图技术, 满足不同用户对专家库中专家的分类管理需求。
2. 外部接口
本系统提供基于 Access 的数据导入和导出功能, 方便各高评委单位和人事厅专技处的数据交换。
3. 部接口
系统基于 C/ S 模式开发, 系统与数据库服务器之间以 BDE 连接。 保证数据库系统的物理性。
四、 系统数据结构设计
限于篇幅, 这里仅给出本系统设计主要表的逻辑结构, 其他相关代码表结构在此从略。
(1) 基本信息( expert_baseinfo ) (见表 B4)
(2) 高评委专家照片信息 (expert_picture) ( 见表 B5)
表 B5 高评委专家照片信息表
(7) 专家成员历史任职情况表 (expert_history) ( 见表 B10)
表 B10 专家库成员历史任职情况表
五、 数据结构与程序的关系
说明各个数据结构与访问这些数据结构的形式, 如表 B12 所示。
表 B12 功能模块与相应数据表之间的关系表
六、 系统出错处理设计
1. 出错信息
系统应对以下错误做出正确处理:
①无法与数据库连接时, 若不能够正确连接, 则应做出正确处理。
②专家入库前必须建立相应的高评委和专业时, 若不满足条件, 则应做出正确处理。
③随机抽取委员会及评议组时, 必须对抽取结果的各种可能状态以及无法满足抽取条件时做出正确处理。
2. 补救措施
①提示数据库无法连接信息。
②若要把专家加入某个高评委下, 则必须先新建高评委, 以及新建高评委下的专业组, 若不满足
该条件, 则提示用户必要的信息。
③提示无法抽取的各种情况, 以使用户明确无法抽取的原因。
2、使用Microsoft Visio进行绘图,参照开放平台课程辅导中第八单元中所给的文档例,编制并完善《省高评委专家库信息管理系统》的详细设计说明书。
(不能直接从PDF截图,要在PDF的基础上进行详细的扩充,并编写在此word文档中)。
文档编号: WD_ EXPERT _DSD_020930
版 本 号: V1.0
详细设计说明书
项目名称 省高评委专家库信息管理系统( Expert 2002 )
项目负责人 元 鸣
项目开发单位 工业大学、 时空信息技术
2002 年 9 月 30 日
详细设计说明书修改历史记录表如表 B13 所示。
表 B1 3 详细设计说明书修改历史记录
设计状态 | 摘要 | 设计人 | 设计日期 | 审核人 | 审核日期 | 批准人 | 批准日期 |
创建 | 元鸣 | 2002.9.30 | |||||
1 . 编写目的
2. 背景
3. 定义
4. 参考资料
二、 程序系统的结构
三、 程序设计说明
1 . 程序描述
2. 功能
3. 性能
4. 输入项
5. 输出项
6. 算法
7. 流程逻辑
8. 接口
9. 存储分配
10 . 注释设计
11 . 条件
12 . 测试计划
一、 引言
1. 编写目的
本文档是程序员代码编写的基础。 本文档的读者是设计人员和程序员。
2. 背景
①待开发的软件系统的名称: 省高评委专家库信息管理系统。
②本项目的任务提出者: 省人事厅专业技术人员管理处。
③开发者: 工业大学、 时空信息技术。
④用户: 省各高评委单位。
3. 定义
高评委: 高级专业技术职务任职资格评审委员。
4. 参考资料
①《省人事厅关于组建高级专业技术职务任职资格评审委员会专家库有关事项的通知》 (浙人
专(2002) 148 号) 。
②《项目委托书》
③《系统功能说明书》 。
④《需求说明书》 。
⑤《概要设计说明书》 。
二、 程序系统的结构
本系统屏幕功能区域设计如图 B4 所示。
图 B4 屏幕功能区域设计
本系统每个子系统所包含的单元文件名称及其程序层次结构如表 B14 所示, 对于特别简单的程序模块, 其程序层次结构非常简单, 在此从略, 仅给出较为复杂的程序层次结构。
表 B1 4 程序层次结构图
三、 程序设计说明
1. 程序描述
限于篇幅, 本程序设计说明仅以“新建高评委模块” 为例说明如何书写程序设计说明, 其他模块
可参考本设计说明。
“新建高评委模块” 用于组建一个新的高级职称评审委员会, 建立新的高评委是本软件的第一步,
只有当新的高评委建立后, 才可以建立其隶属的专业组, 然后再录入专家。
2. 功能 (见表 B15)
表 B1 5
3. 性能
本模块对程序性能没有特殊要求。
4. 输入项
高评委代码: 字符类型。
高评委名称: 字符类型。
高评委类型: 按专业组建 /按职务类别或相近专业 (二级学科) 组建。
高评委权限: 正高职称 /副高职称 /正副合一。
设计时间: datetime 类型。
所评资格名称: 字符类型。
材料接受单位: 字符类型。
备注: 字符类型。
5. 输出项
提交数据成功。
6. 算法
本程序没有采用特殊的算法。
7. 流程逻辑
新建高评委的流程逻辑, 如图 B17 所示。
该模块与主模块及其他模块的关系如下:
①该模块直接被主模块调用, 生成窗体, 供用户输入数据使用。
②该模块直接调用数据库连接模块, 取得数据库连接。
9. 存储分配
无特殊要求。
10. 注释设计
①加在程序单元首部, 说明本程序的作用。
②对程序中的变量代表的意思、 围进行注释。
③对程序中的函数或过程所起的作用进行注释。
11. 条件
①输入项中的高评委代码必须是 4 位字符, 且不能与数据库中高评委代码重复。
②高评委类型、 高评委权限和设计时间不允许为空。
12. 测试计划
①若高评委代码长度不是 4 位时, 则提示“代码必须是 4 位”。 若是, 则满足要求。
②若高评委名称为空, 则提示“请输入新建高评委的名称” 。 若是, 则满足要求。
③若高评委代码与数据库中已有的高评委代码重复, 则提示“请重新输入高评委代码” 。 若是, 则
满足要求。
④出现写数据库错误, 则提示无法连接的具体原因。 若是, 则满足要求。
作业完成时间:2019年 04月15 日
评阅意见:
评阅得分:
评阅教师:
评阅时间: 年 月 日