软件开发,软件模块功能说明模版

　 文 档 编 制

　 编写日期

　 系统主设计师审核

　 审核日期

　 项目经理审核

　审核日期

　 技术总工批准

　批准日期

　文档模板修改纪录表 日期 修改人 修改内容描述

　文档修订控制

　序号 版本号 修订日期 修订概述 修订人 备注

　 目 目

　录 1. 引言 .............................................................................................................................................................................. 4 1.1. 目的 ................................................................................................................................................................... 4 1.2. 定义 ................................................................................................................................................................... 4

　1.3. 参考资料 ........................................................................................................................................................... 4 2. 功能概述 ....................................................................................................................................................................... 4 3. 网管命令 ....................................................................................................................................................................... 4 3.1. 句法惯例 ........................................................................................................................................................... 4 3.2. 命令模式 ........................................................................................................................................................... 5 3.3. 命令举例 ........................................................................................................................................................... 5 3.3.1. command-name ..................................................................................................................................... 5 4. 参数说明 ....................................................................................................................................................................... 5 5. 性能说明 ....................................................................................................................................................................... 5 6. 业务开展说明 ............................................................................................................................................................... 5 6.1. 组网及运营环境说明 ....................................................................................................................................... 5 6.2. 业务流程说明 ................................................................................................................................................... 5 6.3. 内部实现流程说明 ........................................................................................................................................... 6 6.4. 业务配置说明 ................................................................................................................................................... 6 6.5. 配置示例 ........................................................................................................................................................... 6 7. 故障排除 ....................................................................................................................................................................... 6 7.1. 手段及步骤 ....................................................................................................................................................... 6 7.2. FAQ ................................................................................................................................................................... 6 8. 遗留问题和已知 BUG ................................................................................................................................................. 7 9. 附录 .............................................................................................................................................................................. 7

　1. 引言 1.1. 目的 本文档的面向对象主要是测试、售前、售后、工程、市场推广等非研发类人员，他们不关心功能的内部实现，只关注功能的外在表现，如何满足局方需求、如何组网、如何开展业务、如何开局、如何排除故障等。

　本文档需对功能的外在表现进行完整的说明，上述人员可从本文档中提取自己感兴趣的部分，对文档中不理解的地方，可反馈给文档编写人员。

　功能说明中内容，也会成为用户手册、FAQ、售后支持等文档的素材。因此本文档的内容，也尽量按这些文档的格式进行整理。

　1.2. 定义 此处说明本文档中名词的定义。

　1.3. 参考资料 列出此文档的参考资料。

　考虑到文档的读者，参考资料中不需列出设计文档，只列出此类人员可以获得的各类公开文档、RFC 等。

　2. 功能概述 描述此功能的概况。

　3. 网管命令 本节描述与此功能相关的网管命令。格式按照用户手册中命令的格式书写。下面的内容是命令格式的详细说明。

　3.1. 句法惯例

　 惯 惯

　例

　 描

　述

　举

　例 例

　常规字体

　表示关键字

　ip-pool

　倾斜字体

　表示参数

　pool-name

　被| 符号分离的内容

　 选择符号左边或右边的内容

　pppoe | dhcp

　被[ ]括起的内容

　 表示可选参数

　[internal | external]

　被{}括起的内容

　 表示必须的参数

　{authentication | accounting}

　3.2. 命令模式 本系统的命令行模式提供用户模式、特权模式、全局配置模式、子配置模式四个模式。所有的命令都是与模式相关的，也有一些命令可以在多个模式下执行。

　3.3. 命令举例 3.3.1. command-name 描述：描述此命令完成的功能。

　语法：

　command-name parameter1 parameter2 ·parameter1－ 参数 1 说明 ·parameter2－ 参数 2 说明 使用模式：此命令的使用模式，如 User Exec、Privileged Exec、Global Configuration 等

　4. 参数说明 在功能中，可能有一些重要的参数限制，有些参数可以调整，有些在代码中写死。在本节列出这些参数并讲明其含义。

　举个例子，参数包括(但不限于)：功能支持的用户数、断线检测缺省时间间隔、任务监控模块重启系统的时间间隔等。

　5. 性能说明 本节描述功能的性能。如果功能没有性能指标，可跳过此节。

　6. 业务开展说明 本节说明开展业务时的组网、业务流程、内部实现流程、配置方式、配置示例等。

　对不需开展业务的功能，可跳过此节。

　6.1. 组网及运营环境说明 本小节说明本项业务的组网要求及开展业务的运营环境要求。

　6.2. 业务流程说明 本小节所讲的业务流程，指在开展此业务时，最终用户所看到的一整套业务流程。可以按照用户使用该业务的顺序，描述用户操作以及操作的结果。

　业务流程说明应条理清晰，分类明确，易于理解，可采用示意图、流程图、表格等多种形式进行讲解。

　6.3. 内部实现流程说明 本小节讲述内部实现流程，基于本文档面向的读者，内部实现流程 不需讲述技术细节，而且尽量做到通俗易懂。

　之所以描述内部实现流程，是为了使相关人员对此功能的实现方式有最基本的了解，在回答客户提问、排除故障时，有一定的技术储备。

　如果可以，本小节可以与“业务流程说明”小节合并在一起说明。

　6.4. 业务配置说明 本小节讲述业务的配置方法，可以参考用户手册中讲解配置的方法，使说明清晰易懂。

　用户手册讲解配置的方法，大体如下：

　1. 列出开展业务所需的全部配置步骤，注明每一步是必选还是可选； 2. 分步讲解每步配置的缘由、配置方法、删除配置的方法、检验配置是否正确的方法等； 3. 如果不同类型的用户，配置方法差异较大，尽量分别说明，以免造成混乱； 4. 可以多利用表格、图示等方式进行说明，利用表格进行差异比较，比文字方式清晰很多；

　6.5. 配置示例 可以参考用户手册中讲述配置示例的方法。

　可以采用案例分析的方法，具体的分析一个局方的需求，然后把此需求转化为具体的配置，这样更有利于相关人员的操作。

　在配置示例中，可以包括示例组网、完整的配置文件、脚本等。如果配置文件、脚本较大，可以将之放在附录，或采用附件的方式。

　7. 故障排除 7.1. 手段及步骤 本节讲述排除故障的手段及步骤，利用的手段包括 debug 信息、show 信息、sniffer 抓包等，按步骤讲解，使相关人员能够较顺利的排除故障。

　7.2. FAQ 常问问题解答：如果每天都被问到同样的问题，感到很不爽的话，把它放在这儿吧。

　8. 遗留问题和已知 BUG 本节讲述已知的 bug，以及遗留尚未解决的问题。

　9. 附录

推荐访问:软件 模版 模块