软件产品使用说明书格式

时间:2024.4.21

客户商机信息管理系统

使用说明书

北京阳光伟业科技发展有限公司

20##年5月

文档控制

修改记录

* 修改类型分为 A—Added   M—Modified   D—Deleted

审阅人

存档


目录

1       概述... 4

1.1背景... 4

1.2应用领域与使用对象... 4

1.4参考资料... 4

1.5术语与缩写解释... 4

2       系统综述... 4

2.1系统结构... 4

2.2系统功能简介... 5

2.3性能... 5

2.4版权声明... 5

3       运行环境... 5

3.1硬件设备要求... 5

3.2支持软件... 5

3.3数据结构... 5

4       系统操作说明... 6

4.1安装与初始化... 6

4.2子模块名称1. 6

4.2.1业务需求描述... 6

4.2.2界面截屏以及界面字段解释... 6

4.2.3操作说明... 6

4.3子模块名称2. 6

4.3.1业务需求描述... 6

4.3.2界面截屏以及界面字段解释... 6

4.3.3操作说明... 7

4.4出错处理和恢复... 7

1    概述

1.1背景

为满足新北海信息科技有限公司内部总经理和总监对部门经理和客户经理的工作信息进行监督和反馈,同时能及时抓住有用的商机客户,避免商机资源的流失。

1.2应用领域与使用对象

新北海信息科技有限公司内部总监、总经理、部门经理、客户经理。

1.4参考资料

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

Ø  与该产品有关的已发表的资料

Ø  文档中所引用的资料,所采用的软件标准或规范或业务规则

列出编写本说明书时查阅的Internet上杂志、专业著作、技术标准以及他们的网址

1.5术语与缩写解释

列出本文中用到的专门术语的定义

2    系统综述

2.1系统结构

结合系统所具有的功能包括输入、处理和输出提供该软件的总体结构图表。

2.2系统功能简介

结合本软件的开发实际逐项地说明本软件所有具有各项功能。

2.3性能

给出一般情况下的运行性能指数等。

2.4版权声明

声明版权所有者以及盗版应承当的法律责任。

3    运行环境

3.1硬件设备要求

列出本软件所要求的硬设备的最小配置,如:

1、  处理器的型号、内存、硬盘容量;

2、  所要求的外存储器、媒体、记录格式、设备的型号和台数、联机/脱机;

3、  I/O设备(联机/脱机);

4、  数据传输设备和转换设备的型号、台数。

3.2支持软件

说明为运行本软件所需要的支持软件,如:

1、  操作系统的名称、版本号;

2、  程序语言的编译/汇编系统的名称和版本号;

3、  数据库系统的名称和版本号;

4、  其他支持软件。

3.3数据结构

列出为支持本软件的运行所需要的数据库或数据问卷。

4    系统操作说明

首先用图表的形式说明软件的功能同系统的输入源机构、输出接收机构之间的关系。

4.1安装与初始化

说明为使用本软件而需进行的安装与初始化过程,包括程序的存储形式、安装与初始化过程中的全部操作命令、系统对这些命令的反应与答复。表征安装工作完成的测试实例等。如果有的话,还应说明安装过程中所需用到的专用软件。

4.2子模块名称1

4.2.1业务需求描述

描述该模块能实现什么业务功能

4.2.2界面截屏以及界面字段解释

对设计到该子模块功能的所有UI界面进行截屏,并在各个截屏之后对页面上的字段业务含义进行解释。

4.2.3操作说明

对该子模块的用户操作做一个详细的说明,尽量包含界面上的各个按钮和链接,并对该操作以后会出现什么结果,达到什么功能详加说明。此处为用户手册的重点部分,如果有必要的话,此处可以分为很多更小的模块来分别进行操作说明。

4.3子模块名称2

4.3.1业务需求描述

描述该模块能实现什么业务功能

4.3.2界面截屏以及界面字段解释

对设计到该子模块功能的所有UI界面进行截屏,并在各个截屏之后对页面上的字段业务含义进行解释。

4.3.3操作说明

对该子模块的用户操作做一个详细的说明,尽量包含界面上的各个按钮和链接,并对该操作以后会出现什么结果,达到什么功能详加说明。此处为用户手册的重点部分,如果有必要的话,此处可以分为很多更小的模块来分别进行操作说明。

4.4出错处理和恢复

列出由软件产生的出错编码或条件以及应由用户承担的修改纠正工作。指出为了确保再启动和恢复的能力,用户必须遵循的处理过程。


第二篇:31软件产品功能说明书编写大纲


31软件产品功能说明书编写大纲

软件产品功能说明书编写大纲

目录

1 前言.................................................................................................................................................. 1

1.1

1.2

1.3

1.4

1.5

2 读者对象 ............................................................................................................................. 1 版本信息 ............................................................................................................................. 1 术语与缩略词 ..................................................................................................................... 1 参考文献 ............................................................................................................................. 1 修改历史 ............................................................................................................................. 1 产品概述 .......................................................................................................................................... 2

2.1

2.2 业务特色 ............................................................................................................................. 2 技术特色 ............................................................................................................................. 2

3 运行环境 .......................................................................................................................................... 2

3.1

3.1.1

3.1.2

3.2

3.2.1

3.2.2

3.3

3.3.1

3.3.2 网络环境 ............................................................................................................................. 2 硬件环境 ................................................................................................................. 2 软件环境 ................................................................................................................. 2 服务器环境 ......................................................................................................................... 3 硬件环境 ................................................................................................................. 3 软件环境 ................................................................................................................. 3 工作站环境 ......................................................................................................................... 3 硬件环境 ................................................................................................................. 3 软件环境 ................................................................................................................. 3

4 系统功能说明 .................................................................................................................................. 3

4.1

4.2

4.2.1

4.2.2

4.2.3

4.3

4.4 总体功能模块结构 ............................................................................................................. 3 子系统1功能说明 ............................................................................................................. 4 模块1功能说明 ..................................................................................................... 4 模块2功能说明 ..................................................................................................... 4 模块M功能说明 ................................................................................................... 4 子系统2功能说明 ............................................................................................................. 4 子系统N功能说明 ............................................................................................................ 4

5 技术支持联系方式 .......................................................................................................................... 4 Powerise? 质量服务部 第 2 页 共 6页

软件产品功能说明书编写大纲

1 前言

1.1 读者对象

此处用文字说明的方式,说明本《软件产品功能说明书》的可能用户和读者。

1.2 版本信息

此处以排序列举的形式,给出本软件系统的中文名称、产品代号、委托单位、开发单位、完工时间、版权隶属等信息。

1.3 术语与缩略词

此处以排序列举的形式,给出关于本《软件产品功能说明书》中使用的专用术语、相关长句的缩写、容易引起混淆的概念等。

1.4 参考文献

此处用排序列举的方式,给出编写本《软件产品功能说明书》时所参考的相关资料。例如,《系统需求规格说明书》、《系统概要设计说明书》、《系统详细设计说明书》和《模块开发卷宗》等。

1.5 修改历史

31软件产品功能说明书编写大纲

Powerise? 质量服务部 第 1 页 共 6页

软件产品功能说明书编写大纲

2 产品概述

此处以文字的形式简述产品的功能、适用的行业、业务特色和技术特色等信息。

2.1 业务特色

此处以文字和排序列举的方式说明本应用系统在业务处理方面的先进性、科学性、全面性等。

先总体概述,后排序列举详细说明。

2.2 技术特色

此处以文字和排序列举的方式说明本应用系统在技术采用方面的合理性、先进性、科学性、全面性等。

先总体概述,后排序列举详细说明。

3 运行环境

3.1 网络环境

3.1.1 硬件环境

此处以图形或文字形式给出整个应用系统的网络环境中的硬件设备的名称、规格、型号、性能、配置、数量、组建形式等信息。

3.1.2 软件环境

此处以图形或文字形式给出整个应用系统的网络环境中的网络软件的名称、版本号、配置、数量等信息。主要是网络操作系统、网络管理工具、网络安全性管理等软件。

Powerise? 质量服务部 第 2 页 共 6页

软件产品功能说明书编写大纲

3.2 服务器环境

3.2.1 硬件环境

此处以图形或文字形式给出整个应用系统的服务器的硬件设备的名称、规格、型号、性能、配置、数量、组建形式等信息。

3.2.2 软件环境

此处以图形或文字形式给出整个应用系统的服务器环境中的软件的名称、版本号、配置、数量等信息。主要是服务器操作系统、数据库管理系统、WEB服务器系统、其他服务器端的管理软件等。

3.3 工作站环境

3.3.1 硬件环境

此处以图形或文字形式给出整个应用系统的工作站或终端的硬件设备的名称、规格、型号、性能、配置、数量、组建形式等信息。

3.3.2 软件环境

此处以图形或文字形式给出整个应用系统的工作站或终端环境中的软件的名称、版本号、配置、数量等信息。主要是工作站操作系统、BROWSER浏览器软件、其他工作站或终端软件等。

4 系统功能说明

4.1 总体功能模块结构

此处以文字和功能模块关系的方式概述整个应用系统的功能。

Powerise? 质量服务部 第 3 页 共 6页

软件产品功能说明书编写大纲

4.2 子系统1功能说明

4.2.1 模块1功能说明

此处以文字和图表形式详细说明子系统或功能模块的详细功能信息。

4.2.2

。。。。。。 模块2功能说明

4.2.3 模块M功能说明

4.3 子系统2功能说明

。。。。

4.4 子系统N功能说明

5 技术支持联系方式

此处给出关于应用系统维护和技术支持方面的所有联系方式,主要包括:邮递地址、电话号码、传真号码、E-MAIL地址等信息。

Powerise? 质量服务部 第 4 页 共 6页

更多相关推荐:
软件产品使用说明书格式

客户商机信息管理系统使用说明书北京阳光伟业科技发展有限公司20xx年5月文档控制修改记录1修改类型分为AAddedMModifiedDDeleted审阅人存档2目录1概述411背景412应用领域与使用对象414...

毕业设计(论文)软件使用说明书格式

软件使用说明书学号一软件编制人员正文内容姓名二运行环境112软件环境三本软件安装方法四运行方法五附录

软件需求说明书(有示例)

Windows语音助手软件规格说明书SRS青岛大学FirstDreamTeam小组青岛大学Windows语音助手软件需求说明书1Windows语音助手软件规格说明书SRS青岛大学FirstDreamTeam小组...

软件产品需求规格说明书

软件产品需求规格说明书SoftwareProductRequirementsSpecification1引言11目的本节描述软件产品需求规格说明书SRS的目的如a定义软件总体要求作为用户和软件开发人员之间相互了...

21 - 软件产品规格说明(SPS)

软件产品规格说明SPS说明1软件产品规格说明SPS包含有或引用了可执行软件源文件以及软件支持的信息包括一个计算机软件配置项CSCI已建成的设计信息和编辑构造及修改的过程等2SPS可被用于订购可执行软件和或对应于...

20xx.10.29 岗位说明书【软件开发部经理】

岗位说明书软件开发部经理

软件产品说明书的测试

软件的产品功能说明书对产品最终需要实现的功能作了描述这些功能是最终确定的需要满足的客户需求也包括软件必须具备的能力在规范的软件开发流程中产品功能说明书应在确定用户需求后进行系统概要设计前确定至于为什么要进行产品...

软件需求规格说明书模板V1.1

修订历史版本说明编制批准批准日期11初次编写SEPG目录1引言111背景112参考资料113假定和约束114用户的特点12功能需求121系统范围122系统体系结构二层架构的系统可剪裁本小节23系统总体流程224...

产品说明书格式

一产品说明书的基本含义产品说明书是对产品的结构性能规格用途使用方法维修保养等的说明性文字二产品说明书的写作要点通常来说产品说明书主要包括以下主要内容1产品概况2产品的性能和特点3产品的使用方法4产品的保养与维修...

软件产品使用说明书格式

客户商机信息管理系统使用说明书北京阳光伟业科技发展有限公司20xx年5月文档控制修改记录1修改类型分为AAddedMModifiedDDeleted审阅人存档2目录1概述411背景412应用领域与使用对象414...

软件产品使用说明书格式

NBC可视化协同办公系统使用说明书北京阳光伟业科技发展有限公司20xx年5月1文档控制修改记录修改类型分为AAddedMModifiedDDeleted审阅人存档2目录1概述411背景412应用领域与使用对象4...

《兽药产品说明书范本》第一册勘误表

兽药产品说明书范本第一册勘误表

软件产品说明书(12篇)