技术写作/用户文档
文档分类
- 流程文档 指导系统的开发、测试、维护和改进。经理、工程师、测试员和营销专业人士使用它们。这些文件使用技术术语和行业特定的术语。
- 产品文档 为客户提供使用产品所需的信息。它们主要是包括一些技术解释的教材。他们使用日常术语来代替技术术语，使新手或局外人更容易理解系统。
流程文档
对于大型软件项目，技术作者甚至在开发开始之前就开始准备文档。技术作家必须在SDLC期间制作不同类型的文件，例如：
- 测试计划
- 设计规格
- 项目计划
以下是提供系统开发和维护相关信息的流程文件：
- 估算、计划和时间表：经理通常准备此类产品文档，描述如何管理和控制软件。
- 报告：这些文件报告了开发过程中的资源使用情况。
- 标准和惯例：这些文件概述了如何实现流程需求。工作文件：这些是项目最重要的技术通信文件。工作文件记录了从事该项目工作的开发人员的想法和想法。他们解释了实施设计背后的基本原则。工作文件还描述了实施战略。
- 电子邮件和备忘录：这些文档包含经理和软件开发人员之间的通信。这些是软件历史学家的主要兴趣所在。
启动阶段缩进线项目提案营销研究可行性分析
分析和规划阶段
发展阶段
- 详细设计
- 代码注释
- 测试用例
- 版本控制记录
集成与测试阶段
- 自上而下的测试
- 自下而上的测试
- 混合（“三明治”）测试
- 大爆炸、风险最强等。
交付阶段
- 安装和维护手册（请参阅下面的产品文档）
- 培训交付
- 故障诊断和问题跟踪
- 发布说明（取决于方法）
维修阶段
- 更新和补丁
- 发布说明
- 故障诊断和知识库
改进阶段
- 项目会计
- 经验教训
产品文档
产品文档提供了有关产品的全面描述和信息。与流程文档相比，产品文档的使用寿命相对较长。技术作者在开发产品时开始准备产品文档。编写产品文档和开发产品是一个同时进行的过程。产品文档可以分为：
- 用户文档：用户文档是为最终用户编写的。它包含有关如何使用特定产品的详尽信息。
- 系统文档：主要面向系统和维护工程师。
用户文档
技术作者构建文档，使其适应不同的用户任务，并满足具有不同经验和专业知识的用户的需求。技术作者必须能够区分最终用户和系统管理员。
- 最终用户使用该软件来完成他们的工作。用户可以使用该软件编写书籍、管理保险单或驾驶飞机。最终用户对学习软件的复杂细节不感兴趣。他们只想知道如何利用该软件执行特定任务。
- 系统管理员为最终用户管理软件。系统管理员的工作可以是多方面的；他们可以在系统需要工作站网络时担任网络经理，如果是大型主机系统，他们可以担任运营商，也可以作为技术专家为最终用户解决软件问题。
用户文档的类型
技术作家为不同类型的用户准备文档。通常，用户文档有四种基本类型：
- 功能描述-功能描述列出功能，描述复杂的GUI，并提供有关系统所提供服务的信息。本文应提供软件的详细概述。最终用户应该能够在阅读介绍性手册后决定这是否是他们正在寻找的软件。
- 管理员手册
- 系统要求
- 安装-系统安装文档是为系统管理员准备的；此文档应提供有关如何安装系统的信息。系统安装文档应包含系统文件和所需硬件配置的说明。它还应该提供有关如何操作系统、如何自定义依赖配置的文件以及如何建立永久文件的详细信息。
- 配置-系统配置文档适用于系统管理员或用户。本文提供有关如何配置系统或软件以供最终使用的信息。您可以根据需求和信息量将此文档与系统安装文档相结合。
- 用户手册-用户手册应向受众介绍该特定系统。它应该概述系统的正常功能，并应该提供有关如何开始和使用各种应用程序的说明。说明应通过示例进一步说明。
- 系统参考-系统参考文档应提供有关系统设施、如何使用这些设施、错误消息列表以及如何从错误中恢复的信息。系统参考手册应以描述性风格编写。它为最先进或技术含量最高的用户提供详细信息。