软件项目提交文档.docVIP

7.5软件项目提交文档 提交过程的文档主要包括用户手册、系统管理员手册以及产品提交文档等。下面的文档模板，仅供参考。 7.5.1 用户手册文档标准 以下为用户手册文档模板 导言 1．1目的 说明文档的目的 1.2范围 说明文档的覆盖范围 1.3缩写说明 定义文档中所涉及的缩略语（若无则填写无） 1.4术语定义 定义文档内使用的特定术语（若无则填写无）。 1.5引用标准 列出文档制定所依据、引用的标准（若无则填写无）。 1.6参考资料 列出文档制定所参考的资料（若无则填写无）。 1.7版本更新信息 记录文档版本修改的过程，具体版本更新记录如表1所列。 表 版本更新记录 修改编号 修改项目 修改后的版本 修改位置 修改内容概述 概述 对系统的特点进行适当的介绍，突出系统的特点及优势。同时，对公示及产品作简要介绍。在介绍产品的同时，扩大公司的知名度与参与影响。 说明系统交付时应同时交付给用户的附件。并且要对手册的章节组织及使用时的注意事项作明确说明。 运行环境 本节说明系统运行时，所需的是、硬件及软件支持环境。由于是用户手册，必须让系统使用者能正确利用相关软硬件设备运行本系统。软硬件说明具体应包含对CPU的要求、使用操作系统以及对应操作系统的内存要求和硬盘所需容量。其他设备（如显卡、声卡、CD-ROM）等的说明可视软件产品的需求而给与列出。 安装与配置 本节应详细描述系呕吐那个在不同操作系统环境下的安装过程及对应过程中的注意事项。要做到详细准确。另外，要注明系统安装时的配置方法。 操作说明 本节应分章节，详细描述系统的使用方法。具体应包含系统功能菜单的各项指令说明。必要时加以图示。对于在使用过程中可能经常遇到的问题，可以视情况增加疑难解答。 技术支持信息 本节给用户购买产品遇到的问题，需要解决时，如何与公司联系。具体包括公司的电话、传真、E-Mail地址和Web网址。 7.5.2 系统管理员手册文档标准 下面是系统管理员手册模板，仅供参考。 导言 1.1 目的 说明文档的目的。 1.2 范围 说明文档覆盖的范围。 1.3 缩写说明 定义文档中所涉及的缩略语（若无则填写无）。 术语定义 定义文档内使用的特定术语（若无则填写无）。 应用标准 列出文档定制所依据、应用的标准（若无则填写无）。 参考文献 列出文档定制所参考的资料（若无则填写无）。 版本信息 记录文档版本修改的过程，具体版本更新记录如下表所列。 表 版本更新记录 修改编号 修改日期 修改后版本 修改位置 修改内容概述 概述 这部分应该对系统进行总括性介绍，突出系统的优点及优势。同时，对公司及产品作简要介绍。在介绍产品的同时，扩大公司的知名度与影响。另外还应对系统版权信息以及手册中使用的一些约定，如：对特殊表达符号、命名约定等进行说明。 另外，要指明此手册的读者对象是系统的管理人员。系统交付时应同时交付给用户的附件。并且要对手册的章节组织及使用时的注意事项进行明确说明。 系统简介 本节应对系统进行较全面的介绍，包括系统结构、系统功能、特点、应用领域、版本信息等 运行环境 这一节详细说明系统运行时，所支持的硬件及软件环境。包括设备厂商、设备型号、网络环境、操作系统及其他必需的软、硬环境。 系统安装 本节应对系统的安装过程进行详细讲述。 系统配置 这一节应详细描述系统的配置过程及此过程中的注意事项。使系统管理员按照手册的说明即可顺利配置本系统。如有必要，应以附录的形式加以详述。 系统启动和关闭 本节对系统启动和关闭过程进行说明，包括相应的注意事项、可能出现的错误以及补救方法。有关系统启动和关闭引发的故障及其处理方法的内容，乐意放在11节的“故障诊断、处理和恢复”中说明，但在本节中必须指明相应参考的章节。 管理命令 本节对于涉及系统管理的命令进行详细讲述。包括命令说明、参数列表、参数说明等。 管理工具 本节讲述本系统中提供的涉及系统管理的工具及其主要使用方法。如果有关工具有相应的手册详细讲述，在本节中必须指明相应参考的章节。 安全策略 这一节因描述系统所提供的安全策略，如用户账号分配，用户管理等内容。 故障诊断、处理和恢复 可能出现的故障应该如何进行诊断和相应的处理方式以及使系统恢复正常的方法。