文档章节

用户操作手册

村长杨京京
 村长杨京京
发布于 2016/09/18 11:46
字数 1014
阅读 32
收藏 1

1.引言

1.1编写目的

【阐明编写手册的目的,指明读者对象。】

 

1.2项目背景

【应包括项目的来源、委托单位、开发单位和主管部门。】

1.3定义

【列出手册中所用到的专门术语的定义和缩写词的原文。】

1.4参考资料

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

a.  项目的计划任务书、合同或批文;

b.  项目开发计划;

c.  需求规格说明书;

d.  概要设计说明书;

e.  详细设计说明书;

f.  测试计划;

g.  手册中引用的其他资料、采用的软件工程标准或软件工程规范。】

2.软件概述

2.1目标

2.2功能

2.3性能

a.  数据精确度【包括输入、输出及处理数据的精度。】

b.  时间特性【如响应时间、处理时间、数据传输时间等。】

c.  灵活性【在操作方式、运行环境需做某些变更时软件的适应能力。】

3.运行环境

3.1硬件

【列出软件系统运行时所需的硬件最小配置,如

a.  计算机型号、主存容量;

b.  外存储器、媒体、记录格式、设备型号及数量;

c.  输入、输出设备;

d.  数据传输设备及数据转换设备的型号及数量。】

3.2支持软件

【如:

a.  操作系统名称及版本号;

b.  语言编译系统或汇编系统的名称及版本号;

c.  数据库管理系统的名称及版本号;

d.  其他必要的支持软件。】

4.使用说明

4.1安装和初始化

【给出程序的存储形式、操作命令、反馈信息及其含意、表明安装完成的测试实例以及安装所需的软件工具等。】

4.2输入

【给出输入数据或参数的要求。】

4.2.1数据背景

【说明数据来源、存储媒体、出现频度、限制和质量管理等。】

4.2.2数据格式

【如:

a.  长度;

b.  格式基准;

c.  标号;

d.  顺序;

e.  分隔符;

f.  词汇表;

g.  省略和重复;

h.  控制。】

4.2.3输入举例

4.3输出

【给出每项输出数据的说明。】

4.3.1数据背景

【说明输出数据的去向、使用频度、存放媒体及质量管理等。】

4.3.2数据格式

【详细阐明每一输出数据的格式,如:首部、主体和尾部的具体形式。】

4.3.3举例

4.4出错和恢复

【给出:

a.  出错信息及其含意;

b.  用户应采取的措施,如修改、恢复、再启动。】

4.5求助查询

【说明如何操作。】

5.运行说明

5.1运行表

【列出每种可能的运行情况,说明其运行目的。】

5.2运行步骤

【按顺序说明每种运行的步骤,应包括:】

5.2.1运行控制

5.2.2操作信息

a.  运行目的;

b.  操作要求;

c.  启动方法;

d.  预计运行时间;

e.  操作命令格式及说明;

f.  其他事项。

5.2.3输入/输出文件

【给出建立或更新文件的有关信息,如:】

a.  文件的名称及编号;

b.  记录媒体;

c.  存留的目录;

d.  文件的支配【说明确定保留文件或废弃文件的准则,分发文件的对象,占用硬件的优先级及保密控制等。】

5.2.4启动或恢复过程

6.非常规过程

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

7.操作命令一览表

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

8.程序文件(或命令文件)和数据文件一览表

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

9.用户操作举例

© 著作权归作者所有

上一篇: Java编码规范
村长杨京京
粉丝 161
博文 878
码字总数 907544
作品 0
杭州
程序员
私信 提问
2016年11月5日工作总结

今天主要落实了针对青年之声、e路惠、长发展利农商城、省工会4个项目申请软件著作权的事,现在知道的是申请软件著作权我们需要提供申请软件的用户操作手册,及源代码的电子版。 小倪、崔巍、...

Mandarava
2016/11/05
2
0
Vertical Mapper 3.0

Vertical Mapper 3.0(用于分析空间上连续数据的趋势,可以生成渲染效果的图象(grid),也可以生成3D(三维)效果图; Vertical Mapper可以在嵌在MapInfo Pro.中运行,也可以配合MapInfo MapX运行。前...

张加
2009/09/05
346
0
VMware操作实验室(Hands-on Labs)

网上有很多介绍搭建VMware企业虚拟计算软件学习环境的文章,例如, 在一台物理主机上安装ESXi企业虚拟计算软件,然后创建3台虚拟机。接着在每台虚拟机中安装ESXi企业器虚拟计算软件,并通过v...

pinxie2014
2014/05/30
0
0
原创C#多数据库组件(SQL+Oracle+MySQL)及用户操作手册|CSFramework.DB.dll

我们在开发软件过程中,特别是基于数据管理应用相关的系统,一般采用一种数据库,如Microsoft SQL Server,超大型系统有的使用Oracle, 部分Web系统采用开源的MySQL等,由于各种业务场景以及...

孙中吕
01/07
0
0
linux入门之帮助篇

linux入门之帮助篇 很多人初级接触Linux系统认为都是命令行操作,尤其很多人英文不好对更是望而却步。Linux下命令繁多且选项更多,想去记忆到每个命令和选项用法是不现实的,在这里我想给大家...

higesky
2017/03/19
0
0

没有更多内容

加载失败,请刷新页面

加载更多

mysql-connector-java升级到8.0后保存时间到数据库出现了时差

在一个新项目中用到了新版的mysql jdbc 驱动 <dependency>     <groupId>mysql</groupId>     <artifactId>mysql-connector-java</artifactId>     <version>8.0.18</version> ......

ValSong
今天
5
0
Spring Boot 如何部署到 Linux 中的服务

打包完成后的 Spring Boot 程序如何部署到 Linux 上的服务? 你可以参考官方的有关部署 Spring Boot 为 Linux 服务的文档。 文档链接如下: https://docs.ossez.com/spring-boot-docs/docs/r...

honeymoose
今天
6
0
Spring Boot 2 实战:使用 Spring Boot Admin 监控你的应用

1. 前言 生产上对 Web 应用 的监控是十分必要的。我们可以近乎实时来对应用的健康、性能等其他指标进行监控来及时应对一些突发情况。避免一些故障的发生。对于 Spring Boot 应用来说我们可以...

码农小胖哥
今天
8
0
ZetCode 教程翻译计划正式启动 | ApacheCN

原文:ZetCode 协议:CC BY-NC-SA 4.0 欢迎任何人参与和完善:一个人可以走的很快,但是一群人却可以走的更远。 ApacheCN 学习资源 贡献指南 本项目需要校对,欢迎大家提交 Pull Request。 ...

ApacheCN_飞龙
今天
5
0
CSS定位

CSS定位 relative相对定位 absolute绝对定位 fixed和sticky及zIndex relative相对定位 position特性:css position属性用于指定一个元素在文档中的定位方式。top、right、bottom、left属性则...

studywin
今天
8
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部