Ⅰ 软件测试说明书怎么写啊
下面这个你看下,内容有点多,部分条款按照自己公司习惯和要求修改1. 引言1.1编写目的:编写此文档的目的是进一步定制软件开发的细节问题,便于用户与开发商协调工作.本文档面向的读者主要是项目委托单位的管理人员.希望能使本软件开发工作更具体.1.2项目背景1.2.1项目委托单位:****公司1.2.2开发单位:***公司1.3定义1.4参考资料2. 任务概述2.1目标:<1> 决策支持:根据公司的要求及时提供所需报表及文件,并在适当时候对各部门领导给予销售及进货等方面的提示<2>提高效率:利用软件进行管理,避免人工管理的失误以及 延迟性,从而实现高效率的管理.2.2运行环境:<1> 硬件方面:Pentium级处理芯片1兆显存的兼容显卡256色,800*600的兼容显示器标准兼容打印机<2>软件方面: WIN95操作系统2.3条件与限制:编程用计算机一台完成期限2000/7/1无资金供给3. 数据概述数据流程图如下: 3.1静态数据:包括系统登录密码,各数据库所在位置,系统分析原始数据3.2 动态数据:包括各数据库内各项显示数据,用户登录信息,系统时间3.3数据库描述:人事管理数据库:公司内人员的个人详细信息,包括档案信息销售管理数据库:当日销售记录及以前的销售统计,用于销售分析财务管理数据库:公司内部账目及收支情况详表技术管理数据库:公司所需各技术档案的详细记录(包括文档) 3.4 数据字典:<1>数据流词条描述:1.数据流名:登录信息来源:用户的输入去向:系统内部检验部分组成:用户名,密码流通量:每次登录输入一次2.数据流名:登录结果来源:系统去向:用户组成:返回信息流通量:每次登录返回一次3.数据流名:输入修改信息来源:用户去向:系统判断部分组成:根据各数据库内容而不同流通量:依用户输入而定 4.数据流名:反馈信息来源:系统判断部分去向:用户组成:系统经判断后发回的字符数据流通量: 依系统当前信息而定5.数据流名:识别信息来源:系统内部检验部分去向:系统判断部分组成:系统各数据库的标识信息流通量:用户每次输入流通一次6.数据流名:处理信息来源:系统判断部分去向:各数据库处理部分组成:读取/修改标识,读取/修改的变量名称流通量:用户每次输入流通一次7.数据流名:读取修改来源:系统判断部分去向:系统各数据库组成:读取/修改标识,读取/修改内容流通量: 用户每次输入流通一次<2>数据文件词条描述:1.数据文件名:人事数据简述:存储人员信息数据文件组成:人员的各项信息(以CString类型为主)2.数据文件名:销售数据简述:存储当日及从前的销售记录数据文件组成:销售的各项信息3.数据文件名:财务数据简述:存储财务管理信息数据文件组成:财务管理的各项记录4.数据文件名:技术数据简述:存储公司内部使用的技术档案信息数据文件组成:技术档案名称,内容<3>加工逻辑词条描述:1.加工名:检验简要描述:判断用户的许可性输入数据流:登录信息输出数据流:登录结果加工逻辑:判断是否与系统内部用户信息相符合2.加工名:判断简要描述:判断用户的操作并进行相应的读取/存储工作 输入数据流:输入修改信息输出数据流:反馈信息加工逻辑:判断用户的操作->调用数据库->读取/修改->反馈3.加工名:人事档案管理简要描述:对人事数据库进行相应要求的操作,并与判断部分交互输入数据流:处理信息,读取修改输出数据流: 读取修改, 处理信息加工逻辑:判断用户要读取/修改的内容->反馈用户所需信息4.加工名:销售统计简要描述:对销售数据库进行相应要求的操作,并与判断部分交互输入数据流:处理信息,读取修改输出数据流: 读取修改, 处理信息加工逻辑:判断用户要读取/修改的内容->反馈用户所需信息5.加工名:财务统计简要描述:对财务数据库进行
推荐两个相关的WANG 站 (本内容来自 猜字谜 http://www.caizimi.com.cn 原文地址: 谜语大全及答案 http://www.mzxl.cn)
Ⅱ 软件着作权申请中的文档(设计说明书或用户手册)怎么写
中国版权保护中心接收登记的文档包含两种:操作说明书或设计说明书。
设计说明书适合没有界面的嵌入式软件,插件软件,后台运行软件以及游戏软件。一般包含结构图,软件流程图,函数说明,模块说明,数据接口,出错设计等。
操作说明书适合管理类软件,有操作界面,一般应包含登录界面,主界面,功能界面截图,截图之间有相应的文字说明,能全面展示软件的主要功能。
格式要求:
一、说明书应提交前、后各连续30页,不足60页的,应当全部提交。
二、说明书页眉应标注软件的名称和版本号,应当与申请表中名称完全一致,页眉右上应标注页码,说明书每页不少于30行,有图除外,另外截图应该清晰完整。
Ⅲ 如何编写软件设计说明书
文字超过1万字,请到我提供的网址下载
1.1目的
编写详细设计说明书是软件开发过程必不可少的部分,其目的是为了使开发人员在完成概要设计说明书的基础上完成概要设计规定的各项模块的具体实现的设计工作。
1.2背景
一、 软件名称
Ⅳ 软件功能说明书怎么写
使 用 说 明 书
使用前请仔细阅读本说明书
一产品简介
本门禁控制器是专门为各类电控门锁及保安系统而设计的它选用MICROCHIP最新CPU及存储芯片
所有资料不会因断电而丢失采用HOMMARD最新技术功能强大拥有四个密码层具备超级用户密码
及被胁持密码
门状态监视输出报警防拆一亿组密码组合被胁持密码等完善的保安措施让用户更加安全开门
按钮门铃超级用户可接常开或常闭锁等强大功能让用户更加方便
本产品提供了一种安全自动的出入口通行管制方式是商务机构办公室住宅小区等场所的理想装置
二技术参数
序号 项目 指标
1 作电源 直流电压12V10% 电流 < 0.1A
2 最大负载 报警输出100mA 电锁输出5A
3 外型尺寸 116mm116mm20mm
4 重 量 160g
5 环境温度 -2055
6 相对湿度 30%90%
三声光指示
LED指示灯
事 件 红 灯 绿 灯
正常状态 每秒闪烁一次
开 锁 亮
键入按键 亮
进入编程 亮 快速闪烁
编程确认 亮 亮
报 警 闪烁
内置蜂鸣器
事 件 说 明 鸣 音
键入按键有效 一次短鸣 嘀
输入密码有效 两次短鸣 嘀嘀
输入密码错误 一次长鸣 嘀
报 警 状 态 连续长鸣 嘀嘀嘀
四设置使用方法
1缺省密码编程密码为9999使用密码为1234
2进入编程状态
按 * 编程密码 # 进入编程状态
3功能设置需在编程状态下
(1)修改编程密码
按 0 新密码 # 重复新密码 # 密码位数可1-8位
(2)修改使用密码
按 1 新密码 # 重复新密码 # 密码位数可1-8位
(3)设置开门时间
按 2 X X #
注XX为00-99单位为秒出厂设置为06
(4)设置报警时间
按 3 X X #
注XX为00-99单位为分出厂设置为05
(5)设置门状态监视
按 4 0 0 # 关闭此功能
按 4 0 1 # 开启此功能
注门状态监视需配合门磁开关开启此功能时有如下两种作用:
a.如果输入正确密码开门后忘了关门则蜂鸣器会鸣叫提示使用者关门
b.如果门被非法打开则会启动报警系统同时蜂鸣器鸣叫警示
出厂设置此功能为关闭
(6)设置安全模式
按 5 0 0 # 关闭此功能
按 5 0 1 # 如连续十次输入错误密码系统锁死10分钟
按 5 0 2 # 如连续十次输入错误密码启动报警系统
注出厂设置此功能为关闭
(7)储存设置并退出编程状态
按 *
注每次设置完成后必须在1分钟内按 * 储存设置
4使用方法
1用户输入使用密码即可启动电控门锁开门
2如果输入有误连按两次 * 即可取消
3如果因误操作而引发报警需输入正确的密码来关闭报警
4如果忘记密码了可使用主板上的跳线开关RESET来恢复出厂设置先关闭电源将跳线开关拨
到ON位置再接通电源将跳线开关拨回OFF位置即可恢复出厂设置
5扩展功能
1编程密码可扩展为超级用户使编程密码可控制多个不同使用密码的键盘只需输入编程密码后
按 # 也可开门
2 用密码可扩展为被胁持密码如使用者被胁持时只需在输入
密码时将最后一位数的数值加1即可例如使用密码为1234则输入1235 # 后能启动电控锁开门
但同时亦启动报警信号输出
附安装接线图
注1在安装接线时请先关闭电源勿带电操作
2正常情况下电锁是从电源控制器接出
Ⅳ 软件概要设计说明书怎么写
通用的软件概要设计说明书国家有标准。例如概要设计说明书(GB8567-88)包括如下内容:
1引言
1.1编写目的
1.2背景
1.3定义
1.4参考资料
2总体设计
2.1需求规定
2.2运行环境
2.3基本设计概念和处理流程
2.4结构
2.5功能器求与程序的关系
2.6人工处理过程
2.7尚未问决的问题
3接口设计
3.1用户接口
3.2外部接口
3.3内部接口
4运行设计
4.1运行模块组合
4.2运行控制
4.3运行时间
5系统数据结构设计
5.1逻辑结构设计要点
5.2物理结构设计要点
5.3数据结构与程序的关系
6系统出错处理设计
6.1出错信息
6.2补救措施
6.3系统维护设计
根据具体项目内容可以有所微调。
Ⅵ 软件使用手册怎么写
在网上复制给你的
引言
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.l数据背景
【说明输出数据的去向使用频度、存放媒体及质量管理等。】
4.3.2数据格式
【详细阐明每一输出数据的格式,如:首部、主体和尾部的具体形式。】
4.3.3举例
Ⅶ 系统文档说明书怎么写具体的,求大神
软件的使用文档分为两种常见的写法,一种是俗称“点点点”的帮助手册类使用文档,告知用户每一步需要点击的按钮,用系统的截图及指示去展现;另一种是偏需求文档的形式,告知用户为什么这样操作,怎么操作。下面具体分析两种写法风格的场景选择及写发分析。
帮助手册类使用文档
此类使用文档多用于业务逻辑简单的系统,大多数的逻辑在页面上可以展示,用户只需要知道系统的使用流程,在哪些模块实现哪些操作即可。用系统截图+箭头/符号的视觉指引来引导点击区域,附带着一些注意事项类的文字,基本可说明使用情况。
Ⅷ 软件文档怎么写
1.0概述 这部分提供对整个设计文档的概述。描述了所有数据,结构,接口和软件构件级别的设计。
1.1 目标和对象 描述软件对象的所有目标。
1.2 陈述范围 软件描述。主要输入,过程功能,输出的描述,不考虑详细细节。
1.3 软件内容 软件被置于商业或者产品线中,讨论相关的战略问题。目的是让读者能够对“宏图”有所了解。
1.4 主要系统参数 任何商务软件或者产品线都包含软件规定、设计、实现和测试的说明和规范。
2.0 数据设计 描述所有数据结构包括内部变量,全局变量和临时数据结构。
2.1 内部软件数据结构 描述软件内部的构件之间的数据传输的结构。
2.2 全局数据结构 描述主要部分的数据结构。
2.3 临时数据结构 为临时应用而生成的文件的描述。
2.4 数据库描述 作为应用程序的一部分,描述数据库结构。
3.0 结构化和构件级别设计 描述程序结构。
3.1 程序结构 详细描述应用程序所选定的程序结构。
3.1.1 结构图 图形化描述结构。
3.1.2 选择性 讨论其它可供考虑的结构。选定3.1.1中结构类型的原因。
3.2 构件描述 详细描述结构中的每个软件构件。
3.2.1 构件过程叙述(PSPEC) 描述构件的过程。
3.2.2 构件接口描述 详细描述构件的输入和输出。
3.2.3 构件执行细节 每个构件的详细演算描述。
3.2.3.1 接口描述
3.2.3.2 演算模型(e.g., PDL)
3.2.3.3 规范/限制 ]
3.2.3.4 本地数据结构
3.2.3.5 在3.2.3.6设计中包含的执行结果
3.3 软件接口描述 软件对外界的接口描述
3.3.1机器对外接口 与其他机器或者设备的接口描述。
3.3.2系统对外接口 对其它系统、产品和网络的接口描述。
3.3.3与人的接口 概述软件与任何人的界面。
4.0 用户界面设计 描述软件的用户界面设计。
4.1 描述用户界面 详细描述用户界面,包括屏幕显示图标、图片或者类型。
4.1.1 屏幕图片 从用户角度描述界面。
4.1.2 对象和操作 所有屏幕对象和操作的定义。
4.2 界面设计规范 用户界面的设计和实现的规范和标准。
4.3 可见构件 实现的GUI可见构件说明。
4.4 UIDS描述 用户界面开发系统描述。
5.0约束、限制和系统参数 会影响软件的规格说明、设计和实现的特殊事件。
6.0测试标准 测试策略和预备测试用例描述。
6.1 测试的类别 规定实施测试的类别,包括尽量详细的描述。这里是针对黑盒测试现象的描述。
6.2期待软件反馈 测试期待的结果描述。
6.3执行界线 特殊执行需要的说明。
6.4 重要构件确认 决定性构件或者需要特殊注意的构件的测试确认。
7.0附录 设计说明的补充信息。
7.1系统可跟踪矩阵 一个定期回归系统规格跟踪软件需求的矩阵。
7.2 产品战略 如果规格说明书是为一个产品设计的,描述相关的产品战略。
7.3 使用分析算法 描述所有分析活动所使用到的分析算法。
7.4 补充信息 (如果有需要特别说明的)
Ⅸ 软件需求说明怎么写
近来学校的一些科研项目又在申报了,一些学弟开始Q我一些软件工程上书面的问题。大概的总结了下,写到这里。本文涉及到的是需求分析部分的书写,主要是根据国家标准文档中的要求来的。
在互联网公司或者一些敏捷开发的公司里,其实大家都是秉承着重开发,重讨论,而轻文档的态度。这个轻文档并不是指没有文档或者几乎不做文档,而是在严格的文档流程中解脱出来,只把最最实际的部分写出来。这个特征是有互联网本身迭代周期短,版本发布快等特点决定的。而在实际的兼职项目的时候,同学们就要注意了,最重要的应该就是在签合同的时候一定要附上最清楚的一份需求分析,虽然这份需求说明可能不是按照某些标准文档而来的,描述清楚每个功能达到的效果,而这个效果一定要让客户点头确认,而不能出现“应该是”、“可能是”、“也许是”这样的模糊回答。否则在项目后期就会比较难过了。在学校申请的项目和大型公司项目开发中,是重视文档流程的,一部一部来。所以还是看情况来对待文档的深度和标准。
一、目录:目录要用word的“引用”—>”目录”,自动生成目录,一般都是要三级目录。通常这部分基本都不需要改结构,直接更新页码即可。
二、内容部分。国家标准软件需求说明书G856T-88下载
1引言
1.1编写目的
说明编写这份软件需求说明书的目的,指出预期的读者。
(这部分说明需求分析报告的概况,例如:本X需求分析报告是为S系统而编写的。+S系统的两句话概述。+本X报告旨在使U1(需求者)明确S系统的要求和细节,给U2(开发人员)了解需求实现的难度和困难,最终提供给U3(审核人、管理者)讨论和审核,达到沟通效果)
1.2背景
说明:
a.待开发的软件系统的名称;
b.本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络;
c.该软件系统同其他系统或其他机构的基本的相互来往关系。
(这部分可以将a,b,c分为2部分,例子如下:
1.2.1项目概况
本需求分析报告所预期开发的软件系统是:S。S是(不是则无)SS系统的某一个功能子模块,S和S1、S2等系统之间的联系,以及概述其他系统的状态等等。
1.2.2任务分配
a.任务提出者:xxx
b.软件开发者:xx
c.产品使用者:xx
d.文档编写者:xx
e.预期产品使用者:xx
)
1.3定义
列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
(这部分很简单,就是描述专业词汇,比如
1. XML(Extensible Markup Language)即可扩展标记语言,它与HTML一样,都是SGML(Standard Generalized Markup Language,标准通用标记语言)。
2. Word2,解释。。。
)
1.4参考资料
列出用得着的参考资料,如:
a.本项目的经核准的计划任务书或合同、上级机关的批文;
b.属于本项目的其他已发表的文件;
c.本文件中各处引用的文件、资料、包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的来源。
2任务概述
2.1目标
叙述该项软件开发的意图、应用目标、作用范围以及其他应向读者说明的有关该软件开发的背景材料。解释被开发软件与其他有关软件之间的关系。如果本软件产品是一项独立的软件,而且全部内容自含,则说明这一点。如果所定义的产品是一个更大的系统的一个组成部分,则应说明本产品与该系统中其他各组成部分之间的关系,为此可使用一张方框图来说明该系统的组成和本产品同其他各部分的联系和接口。|
(
本模块开发主要是为SS的整体服务,完成SS工作中的XX部分以及相关的工作。其涉及的范围就是,从下达A、B命令后,到给出C结果的过程。具体描述:B1,来完成B11功能;B2,来完成B22功能;等等。本部分是(否)耦合在分词工具包其他部分中的,主要为嵌入方式和先后方式相互交互。
图
图1.该系统的组成同其他各部分的联系和接口
)
2.2用户的特点
列出本软件的最终用户的特点,充分说明操作人员、维护人员的教育水平和技术专长,以及本软件的预期使甩频度。这些是软件设计工作的重要约束
(例如:二次开发和系统调用人员:具有很高的专业知识水平,理解XX的运行机制。可以对开放代码进行阅读和分析,以完成其系统独特的需求,提供给这部分用户开放API手册和Debug版本的源代码即可;预期这部分用户会占本系统总用户量的多大部分。
xx使用者:具有一定的计算机操作能力和知识,了解xx领域的相关概念和用途。提供给这部分用户操作手册即可。预期这部分使用者主要是来简单的xx操作。
维护人员:具有较高的计算机专业水平,可以对常见的系统Bug进行追踪和分析,具有一定的测试能力。这部分用户主要是采用了本系统之后的后期工作维护者。
等等
)
2.3假定和约束
列出进行本软件开发工作的假定和约束,例如经费限制、开发期限等。
(这部分重要是对你有的技术力量、资金状况、人力资源等情况的假设,以使得你可以在什么样的情况和时间范围内完成工作。工期约束,经费约束,人员约束,地理约束,设备约束等几个方面列举说明。)
3需求规定
3.1对功能的规定
用列表的方式(例如IPO表即输入、处理、输出表的形式),逐项定量和定性地叙述对软件所提出的功能要求,说明输入什么量、经怎样的处理、得到什么输出,说明软件应支持的终端数和应支持的并行操作的用户数。
(例如:
INPUT输入
PROCESS处理
OUTPUT输出
LOAD负载量
A
预处理,做怎样的动作,
AA
CC
B
BBBB
Bb
v
C
CCCC
cc
v
表一、xx模块IPO表
对IPO表的简单文字描述。
)
3.2对性能的规定
3.2.1精度
说明对该软件的输入、输出数据精度的要求,可能包括传输过程中的精度。
(例如:
Xx目标处理:1Byt–10M,包括左右边界值。
yy精度范围:….
ZZ的精度:由于xx的特殊性,本系统均采用xx型来进行字符统计运算,概率部分以及其他比率部分精度精确到0.0x%。
)
3.2.2时间特性要求
说明对于该软件的时间特性要求,如对:
a.响应时间;
b.更新处理时间;
c.数据的转换和传送时间;
d.解题时间;等的要求。
(这部分只要一一列举就可以:
由于xxx过程中,需要大量xxxx操作或怎样,故xx解题时间占总时间的最大部分。其次就是xx转换和存储的开销。其具体时间特性要求,如下:
a.xx响应时间:xxms左右;
b.yy更新处理时间:yy;
c.zz数据的转换和传送时间:zz;
d.vv解题时间:vv。
等等
)
3.2.3灵活性
说明对该软件的灵活性的要求,即当需求发生某些变化时,该软件对这些变化的适应能力,如:
a.操作方式上的变化;
b.运行环境的变化;
c.同其他软件的接口的变化;
d.精度和有效时限的变化;
e.计划的变化或改进。
对于为了提供这些灵活性而进行的专门设计的部分应该加以标明。
(这部分按列举来即可,由于本模块第一目的是用于xxx,其次则是xxxx。故本模块的灵活性在于实际应用者的不同。当需求发生某些变化时,该软件对这些变化的适应能力。具体情况如下:
f.操作方式上的变化:采用集成运行制和独立运行制两种模式,集成运行制是把本模块嵌入到分词工具包的主框架中,提供给用户具有一定UI的可操作软件;独立运行制是可以独立运行于后台,并提供给各种程序调用的模式的工作方式,以增强其生命力。
g.运行环境的变化:主采用Windows平台的编译版本运行和调试,在时间允许的情况下,同步开发支持SUSE Linux的服务器版本。;
h.同其他软件的接口的变化:在尽量保证接口不出现变动的情况下,允许接口的重载和再定义。但接口的命名规则是统一的;
i.精度和有效时限的变化:精度在必须调整的条件下,可以上下浮动10个百分点;有效时限则依据现实的测试情况允许稍大范围的变化。
j.计划的变化或改进:工作时间安排会存在必然的浮动,这部分要协同分词工具包课题设计组其他成员一同来进行商定,前期的计划可以稍微有些变动,后期的安排尽量按照计划执行。
等等
)
3.3输人输出要求
解释各输入输出数据类型,并逐项说明其媒体、格式、数值范围、精度等。对软件的数据输出及必须标明的控制输出量进行解释并举例,包括对硬拷贝报告(正常结果输出、状态输出及异常输出)以及图形或显示报告的描述。
(这部分可以把输入输出分为3.3.1输入要求和3.3.2输出要求,如下给出一个单元的例子。
XXX输出
数据名称:XXX输出数据
实际含义:用于XX,表示XXXX
数据类型:Character(字符串)
数据格式:XX
数据约束:由于xxx,,大小在xx以内
)
3.4数据管理能力要求
说明需要管理的文卷和记录的个数、表和文卷的大小规模,要按可预见的增长对数据及其分量的存储要求作出估算。
(
根据实际系统要求列举即可
Name名称
Number数量
Size大小
Increase增长
词典xx
xx
xxxx
并行执行,其大小依据实际xx大文本而增长
)
3.5故障处理要求
列出可能的软件、硬件故障以及对各项性能而言所产生的后果和对故障处理的要求。
(包括软件压力,内存不足,硬件损坏等,这部分可以根据网络到其常见故障。)
3.6其他专门要求
如用户单位对安全保密的要求,对使用方便的要求,对可维护性、可补充性、易读性、可靠性、运行环境可转换性的特殊要求等。
(例如安全保密性:密钥更换等;预期扩展:扩展兼容等;OS更换:Slackware转SUSE等
)
4运行环境规定
4.1设备
列出运行该软件所需要的硬设备。说明其中的新型设备及其专门功能,包括:
a.处理器型号及内存容量;
b.外存容量、联机或脱机、媒体及其存储格式,设备的型号及数量;
c.输入及输出设备的型号和数量,联机或脱机;
d.数据通信设备的型号和数量;
e.功能键及其他专用硬件
(列举说明即可)
4.2支持软件
列出支持软件,包括要用到的操作系统、编译(或汇编)程序、测试支持软件等。
(操作系统和版本:xxxx
支撑环境和版本:xxxx
备用IDE环境和版本:xxxx
与该软件有关的软件组件:xxxx
后续可能扩展环境:xxxx
)
4.3接口
说明该软件同其他软件之间的接口、数据通信协议等。
(例如:
a.用户和主程序调用接口(图中接口1)。这个接口采用封装API形式和函数调用形式,分别以外部调用和内部调用的方式为不同用户提供使用本机械分词工具的入口。例如以xxxx方式调用DLL文件,以xxxx方式调用函数。如下图2所示。
图2.软件接口调用图
b.xx接口(图中接口2)。这里是一个xxx的接口调用过程。xxxx
)
4.4控制
说明控制该软件的运行的方法和控制信号,并说明这些控制信号的来源。
(例如:
下面通过图表的形式,将本模块以及涉及到本模块的软件模块的运行方法、控制信号,以及这些控制信号的来源,其中箭头所指方向对应的模块的控制信号来自箭头另一方向的模块,具体情况如下:
图3 .控制流程图
图3的具体说明情况如下表所示:
Name模块名称
Method运行方式
Signal控制信号
Forward控制去向
主程序模块
运行框架
用户调用或运行
1.调用xx模块
2.调用xx方法
3.调用标准输出模块
xxx模块
xxx
xxx调用
Xxx模块
)
附录:软件设计文档国家标准(GB8567–88)软件设计文档国家标准(GB8567–88)GB8567——88
操作手册(GB8567——88).doc 数据库设计说明书(GB8567——88).doc
测试分析报告(GB8567——88).doc 数据要求说明书(GB856T——88).doc
测试计划(GB8567——88).doc 图1.doc
概要设计说明书(GB8567——88).doc 文件给制实施规定的实例(GB8567-88).doc
开发进度月报(GB8567——88).doc 详细设计说明书(GB8567——88).doc
可行性研究报告(GB8567——88).doc 项目开发计划(GB856T——88).doc
模块开发卷宗(GB8567——88).doc 项目开发总结报告(GB8567——88).doc
软件需求说明书(GB856T——88).doc 用户手册(GB8567——88).doc
Ⅹ 产品说明书怎么写
1、标题。通常是产品名称后面加上说明书三个字,如《VCD说明书》。如果有些是侧重介绍使用方法,称为使用说明书,即产品名称加上使用说明,如vcd使用说明。
2、正文。正文要详细介绍产品的有关知识:产地、原料、功能、特点、原理、规格、使用方法、注意事项、维修保养等知识。当然,不同产品,其说明书侧重的内容也不同。
一般的产品说明书分为⑴家用电器类。⑵日用生活品类。⑶食品药物类。⑷大型机器设备类。⑸设计说明书。
3、附文。附文一般包括厂名、地址、电话、电挂、电传、联系人和生产日期等。出口产品在外包装上要写明生产日期、中外文对照。