作者:158文章网日期:
返回目录:范文示例
软件设计说明书编写规范
一、 编写目的
二、 应用文档
三、 要求及内知容
2.1 编写格式要求
2.2 说明书内容
2.2.1 说明书目的
2.2.2 参考资道料及文档
2.2.3 设计原则
2.2.4 接口专描述
2.2.5 功能描述
2.2.6 接口协议
2.2.7 编程协定
2.2.8 数据结构
2.2.9 逻辑结构
2.2.10 程序流程
2.2.11 源文件列表
2.2.12 其他
2.3 文档修订历史
四、 编写文档注意事属项
五、 样例及模板文档
有的,网上可以搜到挺多,我不知道怎么提供给你下载,这个你可以参考参考。
软件使用说明书模板
1. 引言
1.1编写目的【阐明编写手册的目的。指明读者对象。】
1.2项目背景【说明项目来源、委托单位、开发单位及主管部门】
1.3 定义【列出e799bee5baa6e79fa5e98193e78988e69d83337手册中使用的专门术语的定义和缩写词的原意】
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举例
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. 用户操作举例
详细设计就是把项目里每个知功能点都要完完整整列出来。
好比用户注册:在XX页面输入用户名、密码、电话、地址。
提交道之后会返回什么版样消息。出错会提示什么情况。
最后还要加个流程图。
而需求只需要写明权大概功能点要达到什么要的目的就可以了。没这么细。
使 用 说 明 书
使用前请仔细阅读本说明书
一产品简介
本门禁控制器是专门为各类电控门锁及保安系统而设计的它选用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.如果门被非法打开则会启动报警系统同时蜂鸣器鸣叫警示
出厂设置此功能为关e799bee5baa6e79fa5e98193e78988e69d83364闭
(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正常情况下电锁是从电源控制器接出