软件模块详细设模板.doc

技 术 文 件 技术文件名称：XXX 技术文件编号： 版 本： 拟 制 审 核 会 签 标准化 批 准 中兴软件技术（南昌）有限公司 版本变更记录 文件编号 版本号 拟制人/修改人 拟制/修改日期 更改理由 主要更改内容 （写要点即可） 注1：每次更改归档文件（指归档）时，需填写此表。 注2：文件第一次归档时，“更改理由”、“主要更改内容”栏写“无”。目录 版本变更记录 ii 目录 iii 1 引言 1-2 1.1 编写目的 1-2 1.2 适用范围 1-2 1.3 预期读者和阅读建议 1-2 1.4 参考资料 1-2 1.5 引用标准文件 1-2 2 术语、定义与缩略语 2-2 2.1 术语、定义 2-2 2.2 缩略语 2-3 3 模块一 3-3 3.1 模块描述 3-3 3.2 标准模块（可选） 3-3 3.3 模块设计 3-3 3.4 类定义 3-3 3.4.1 类一 3-3 3.5 单元定义（可选） 3-5 3.5.1 单元一 3-5  说 明 本模版中用“”引起来的蓝色斜体字为撰写模版内容的使用说明或解释，请在完成之后删除这部分内容。 本模版中列出应该填写内容框架，为了通用则不可避免牺牲应对具体情况的灵活性，若其中部分栏目的内容不适用，则必须在该栏目中填写“无”，禁止删除栏目或空白，以免产生缺失或遗漏的误导。 本模版的解释权归公司技术管理部所有。  引言 编写目的 定义XXX项目需求开发和管理的相关约定和活动。 适用范围 适用于XXX项目需求开发和管理。 预期读者和阅读建议 预期读者和阅读建议见表1。 表 1 读者分类 阅读重点 备注 无 参考资料 无。 引用标准文件 无。 术语、定义与缩略语 术语、定义 术语、定义见表2 表 2 术语/定义 说明 无 缩略语 缩略语见表3。 表 3 缩略语 原文 中文含义 无 用户管理模块 模块描述 要求：从模块在系统中的位置，实现原理及方式、实现的主要功能等方面来描述该模块的概貌。 实现的原理及方式： 实现的主要功能： 查找好友：用户能够根据自己的需求对在线的用户进行查找。 添加好友：用户可以把查找到的好友添加到自己的好友列表里面，从而可以和好友进行通讯。 删除好友：用户也可以对自己不想要通讯的用户进行删除。 标准模块（可选） 要求：说明在产品模块库、事业部模块库中对标准模块查询结果、指出引用的标准模块的内容和应用方式、描述本模块中可能抽象的公用模块及其应用范围 Z模块设计 要求：主要用文字、图表等形式详细描述该模块的状态迁移、信号流程、程序流程、界面安排、进程关系、异常处理、错误处理等方面。 详细说明本模块中的可测试性设计，包括提供的测试接口，测试内容和范围等。 类定义 CSearchUser 描述 要求：简述此类下列相关内容： 实现功能 在模块中起到的作用 引用此类应注意的事项。 实现功能： 引用包列表或头文件 要求：简述此类下列相关内容： 例如： java.util.Vector com.ztenc.xxx 。 继承（实现）关系 要求：继承（实现）的类（接口）的包的完整路径。例如：java.util.Vector 属性 要求：描述属性名称、含义、数据类型、访问类型、修饰符以及初始值。 m_UserID 含义 例如：用户名。 用户ID 数据类型 例如：java.lang.String。 访问类型 例如：private。 public 修饰符 例如：无。 初始值 例如：null。 m_UserName 含义 例如：用户名。 用户昵称 数据类型 例如：java.lang.String。 访问类型 例如：pr