软件开发系统操作手册案例.docx

软件开发系统操作手册案例.docx

《软件开发系统操作手册案例.docx》由会员分享，可在线阅读，更多相关《软件开发系统操作手册案例.docx（15页珍藏版）》请在冰豆网上搜索。

软件开发系统操作手册案例

XXXX系统

操作手册

修改历史

日期

版本

作者

修改内容

评审号

变更控制号

2022-12-22

V1.0

**

*******

******

V1.0.1

1

前言

编写目的

阐明编写本文档的目的，指出读者对象。

编写本用户手册目的是为了帮助Comm贸易公司人员掌握如何使用人力资源管理系统（HRM），以便确保HRM系统顺利运行。

文档阅读对象：

人力资源管理系统（HRM）的用户、测试人员。

项目背景

可包括：

a.本软件项目的委托单位、开发单位和主管部门；b.本软件系统与其它系统的关系。

本软件项目的委托单位：

Comm贸易公司；

开发单位：

Dsoft软件公司。

系统介绍：

人力资源管理系统（HRM）是Comm贸易公司针对企业内部人力资源、薪金发放等人资管理业务出现的问题定制的。

该软件的开发，完全以Comm贸易公司的使用需求为基础。

定义

列出本文档中所用到的专门术语的定义和缩写词的原意、容易引起混淆的概念等。

HRM：

HumanResourceManagement人力资源管理系统。

参考资料

列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：

a.本项目经核准的工作任务陈述、合同或上级机关的批文；b.项目开发计划；c.软件需求规格说明书；d.概要设计说明书；e.详细设计说明书；f.本文档中所引用的资料、采用的标准和规范。

《项目合同》、《工作任务陈述（SOW）》、《项目计划》、《系统需求说明书》、《概要设计说明书》、《详细设计说明书》。

2软件概述

功能

列出本软件系统所具备的基本功能，并加以概述。

人力资源管理系统（HRM）分为以下六大模块：

人事管理、工资管理、职位变更管理、离职管理、培训管理、辅助系统，各模块的基本功能如下：

人事管理模块：

包括人员档案、个人档案和部门机构的维护（人员的新增、修改、查看功能；个人档案的修改、查看功能，以及部门机构的新增、删除、修改、查看功能）。

工资管理模块：

包括基本工资的设置；考勤、考核资料的导入；以及最终工资报表的查询和打印。

职位变更管理：

包括职位空缺的维护（新增、删除、修改、查看、审核），应聘人员的登记、面试安排和考评；员工推荐的登记和考评；人事和领导的审批；调职记录的维护（新增、删除、修改、查看）。

离职管理模块：

包括离职的申请、审批以及离职信息的维护。

培训管理模块：

包括培训课程、培训讲师档案的维护；培训需求的维护（收集、审核）；以及培训课程的安排、培训考核和培训反馈的维护。

辅助系统模块：

包括数据的备份、还原；员工的权限设置；个人密码修改；以及退出系统功能。

性能

数据精确度

逐项说明输入、输出及处理数据的精度。

公共说明：

根据数据的有效性，针对不同的信息定义了不同的数据输入要求、预期输出结果以及数据精确度。

例如：

类型

输入

输出

数据精度

170

170

数字格式，精度为3

时间特性

如响应时间、处理时间、数据传输时间和转换时间等。

响应时间：

页面首次访问响应时间为<5s，非首次访问响应时间为<3s；

处理时间：

页面处理时间为<3s；

数据传输时间和转换时间：

页面数据传输时间和转换时间为<3s；

注：

考虑到设备、环境的问题（如：

计算机性能、网络带宽等），其时间特性有所不同。

这里我们以正常、稳定的设备、环境为准。

适应性

说明当操作方式、运行环境发生某些变化时，本软件的适应能力。

服务器端：

须安装有WEB服务管理软件（例如IIS），DotNetFramework2.0框架组件，否则将无法运行该系统。

客户端：

拥有浏览器（例如：

IE）并支持页面脚本（例如：

JavaScript），即可浏览该系统，反之，则无法浏览该系统。

安全保密

说明该软件在安全保密方面的设计考虑和实际达到的能力。

页面权限：

在安全保密方面，根据不同的员工设置了页面的访问权限（即正常显示和无权访问两种）。

数据保密：

由于涉及到数据敏感问题（例如工资、密码），防止被意外获取，对这些敏感数据进行了加密。

3运行环境

硬件环境

列出本软件系统运行时所需的硬件最小配置，如a.计算机型号、主存容量；b.外存储器、媒体、记录格式、设备型号及数量；c.输入、输出设备；d.数据传输设备及数据转换设备的型号及数量；e.网络环境描述。

最低硬件要求：

WEB服务器

机器类型

硬件配置

台式PC、笔记本电脑

CPU奔腾IV1.6G，内存256M以上，硬盘10G以上，网络适配器（以不同方式接入网络，例如：

LAN,WAN,Internet/Intranet）

客户端

机器类型

硬件配置

台式PC、笔记本电脑

一般配置即可，另网络适配器（以不同方式接入网络，例如：

LAN,WAN,Internet/Intranet），显示器800*600

软件环境

列出本软件系统运行时所需的软件最小配置，如a.操作系统名称及版本号；b.语言编译系统或汇编系统的名称及版本号；c.数据库管理系统的名称及版本号；d.网络管理工具、网络安全管理软件名称及版本号；e.其它必要的支持软件。

最低软件要求：

WEB服务器

操作系统

其他应用软件

Windows2003EnterpriseServer

.NetFramework2.0

客户端

操作系统

其他应用软件

Windows系列操作系统

IE6.0或以上

4使用说明

数据说明

列出所有输入输出数据及参数的数据背景（数据来源、存储媒体、出现频度、限制等）、数据格式（长度、格式基准、标号、顺序、分隔符等）及数据实例。

数据背景

输入数据

输出数据

数据来源

键盘输入或鼠标选择

数据库SQLSERVER2005

存储媒体

无

数据库SQLSERVER2005

出现频度

高

高

限制

无

必须连接数据库

数据格式（举例）

数据实例

长度

格式基准

标号

顺序

分隔符

10

日期格式

无

Yyyy-mm-dd（年-月-日）

-

界面说明

窗口或命令行

采用贴图或其它明了的方式列出本软件系统所有窗口或命令行，并给出详细描述。

HRM系统登录界面，包括输入用户名和密码，以及登录按钮。

成功登录HRM系统后的主界面，分为顶部（公司LOGO或宣传栏），左部（HRM系统各项功能菜单），右部（内容主体部分）。

数据显示列表，包含显示了数据的主要部分，以及新增、删除、修改和查看的链接功能。

例如：

上图为职位空缺列表的显示。

新增显示：

根据要求，填写或选择内容，并提交数据；当然在未提交前可通过重置按钮进行重新录入。

删除显示：

当点击某一删除链接时，将跳出信息提示对话框（确认是否删除）。

以更为友好的界面、窗口和提示来与用户交互。

修改显示：

根据要求，修改内容，并提交数据；当然在未提交前可通过重置按钮恢复原始数据。

查看显示：

只能查看信息，无法做任何修改，这对只有查看此功能的用户提供了更好的方式。

而对于没有页面访问权限的用户，HRM系统提供了如下的提示：

热键

列出本软件系统所使用的一般操作热键和与具体界面相关的特殊操作热键。

HRM系统属于B/S模式，通过鼠标选择和键盘录入数据，通过Tab键可以依次选择供输入的文本框、供下拉的列表框和供点击的按钮。

出错和恢复

列出出错信息及其含意以及用户应采取的措施，如修改、恢复、再启动等。

可能出现是错误信息：

序号

可能出现的错误信息（截图、简单描述）

错误分析

解决措施

1

1、WEB服务管理软件损坏（iis等）；

2、网络不正常。

1、修复WEB服务管理软件；

2、查看网络连接是否正常。

2

点击某一链接（“退出”链接除外）时，页面跳转向HRM系统的登录界面

用户登录超时。

重新登录即可。

帮助

说明如何在系统中查询帮助。

HRM系统完全根据人事管理流程，界面友好，操作简单易懂，目前暂无帮助系统。

5操作说明

系统操作描述

列出本软件系统所具备的功能及对应的操作。

HRM系统主界面

操作1

详细说明为完成操作1所要进行的步骤，必要时给予采用贴图等方式给予操作实例。

操作2

。

。

。

。

。

。

用户操作举例

提供由若干单步操作组成的复杂操作的应用举例，如系统维护、备份数据等。

6非常规过程

提供应急或非常规操作的必要信息及操作步骤，如出错处理操作、向后备系统切换操作以及用户须知的操作和注意事项。

HRM系统提供了数据的备份功能，允许对数据进行不定期的备份。

当出现不可预料的毁灭性的数据破坏时，将可以使用“辅助系统”模块下的“数据管理”进行时间选择性的数据恢复。

7操作命令一览表

按字母顺序逐个列出全部操作命令的格式、功能及参数说明。

。

无

8程序（命令）文件及数据文件一览表

按文件名字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。

HRM系统的文件夹结构：

详细内容：

文件夹名称

文件名称

标识符

说明

根文件夹以及其下的文件，包括WEB显示页（.aspx、.html）、配置文件（.config、.xml）

bin

bin

应用程序扩展

css

css

样式文件

images

images

图片文件

script

script

页面脚本文件

ui

ui_compensation

ui_compensation

页面显示文件

ui_dimmision

ui_dimmision

页面显示文件

.

.

.

.

.

.

.

.

.

.

.

.