《软件开发 软件模块功能说明模版》由会员分享，可在线阅读，更多相关《软件开发 软件模块功能说明模版（8页珍藏版）》请在金锄头文库上搜索。
1、文档编制编写日期系统主设计师审核审核日期项目经理审核审核日期技术总工批准批准日期文档修订控制目录1.引言 41.1. 目的41.2. 定义41.3.参考资料42.功能概述43.网管命令43.1.句法惯例43.2.命令模式53.3.命令举例53.3.1. command-name54.参数说明55.性能说明56.业务开展说明56.1.组网及运营环境说明56.2.业务流程说明56.3.内部实现流程说明66.4.业务配置说明66.5.配置示例67.故障排除67.1.手段及步骤67.2. FAQ68. 遗留问题和已知BUG79. 附录 71. 引言1.1. 目的本文档的面向对象主要是测试、售前、售后、
2、工程、市场推广等非研发类人员，他们不关心功能的内部实现， 只关注功能的外在表现，如何满足局方需求、如何组网、如何开展业务、如何开局、如何排除故障等。本文档需对功能的外在表现进行完整的说明，上述人员可从本文档中提取自己感兴趣的部分，对文档中不理 解的地方，可反馈给文档编写人员。功能说明中内容，也会成为用户手册、FAQ、售后支持等文档的素材。因此本文档的内容，也尽量按这些文 档的格式进行整理。1.2. 定义此处说明本文档中名词的定义。1.3. 参考资料列出此文档的参考资料。考虑到文档的读者，参考资料中不需列出设计文档，只列出此类人员可以获得的各类公开文档、RFC等。2.功能概述描述此功能的概况。3
3、. 网管命令本节描述与此功能相关的网管命令。格式按照用户手册中命令的格式书写。下面的内容是命令格式的详细说 明。3.1. 句法惯例惯例描述举例常规字体表示关键字ip-pool倾斜字体表示参数pool-name被| 符号分离的内容选择符号左边或右边的内容pppoe |dhcp被 括起的内容表示可选参数internal | external被括起的内容表示必须的参数authentication | accounting3.2. 命令模式本系统的命令行模式提供用户模式、特权模式、全局配置模式、子配置模式四个模式。所有的命令都是与模 式相关的，也有一些命令可以在多个模式下执行。3.3. 命令举例3.3
4、.1. command-name描述：描述此命令完成的功能。语法： command-name parameter1 parameter2 parameter】 参数1说明 parameter2 参数 2 说明使用模式：此命令的使用模式，如 User Exec、Privileged Exec、Global Configuration 等4. 参数说明在功能中，可能有一些重要的参数限制，有些参数可以调整，有些在代码中写死。在本节列出这些参数并讲 明其含义。举个例子，参数包括（但不限于）：功能支持的用户数、断线检测缺省时间间隔、任务监控模块重启系统的时 间间隔等。5. 性能说明本节描述功能的性能。如
5、果功能没有性能指标，可跳过此节。6. 业务开展说明本节说明开展业务时的组网、业务流程、内部实现流程、配置方式、配置示例等。 对不需开展业务的功能，可跳过此节。6.1. 组网及运营环境说明本小节说明本项业务的组网要求及开展业务的运营环境要求。6.2. 业务流程说明本小节所讲的业务流程，指在开展此业务时，最终用户所看到的一整套业务流程。可以按照用户使用该业务 的顺序，描述用户操作以及操作的结果。业务流程说明应条理清晰，分类明确，易于理解，可采用示意图、流程图、表格等多种形式进行讲解。6.3. 内部实现流程说明本小节讲述内部实现流程，基于本文档面向的读者，内部实现流程不需讲述技术细节，而且尽量做到通
6、俗易 懂。之所以描述内部实现流程，是为了使相关人员对此功能的实现方式有最基本的了解，在回答客户提问、排除 故障时，有一定的技术储备。如果可以，本小节可以与“业务流程说明”小节合并在一起说明。6.4. 业务配置说明本小节讲述业务的配置方法，可以参考用户手册中讲解配置的方法，使说明清晰易懂。 用户手册讲解配置的方法，大体如下：1. 列出开展业务所需的全部配置步骤，注明每一步是必选还是可选；2. 分步讲解每步配置的缘由、配置方法、删除配置的方法、检验配置是否正确的方法等；3. 如果不同类型的用户，配置方法差异较大，尽量分别说明，以免造成混乱；4. 可以多利用表格、图示等方式进行说明，利用表格进行差异
7、比较，比文字方式清晰很多6.5. 配置示例可以参考用户手册中讲述配置示例的方法。可以采用案例分析的方法，具体的分析一个局方的需求，然后把此需求转化为具体的配置，这样更有利于相 关人员的操作。在配置示例中，可以包括示例组网、完整的配置文件、脚本等。如果配置文件、脚本较大，可以将之放在附 录，或采用附件的方式。7. 故障排除7.1. 手段及步骤本节讲述排除故障的手段及步骤，利用的手段包括debug信息、show信息、sniffer抓包等，按步骤讲解, 使相关人员能够较顺利的排除故障。7.2. FAQ常问问题解答：如果每天都被问到同样的问题，感到很不爽的话，把它放在这儿吧。8.遗留问题和已知 BUG本节讲述已知的bug，以及遗留尚未解决的问题。9.附录
