Coursera 笔记

Module 01 · The Software Development Lifecycle

Software Documentation软件文档概述

Coursera ↗

欢迎来到 软件文档 课程！在观看完本视频后，您将能够：

  • 列举不同的文档格式 📄🎥🎨
  • 比较并对比 产品文档 与 过程文档 📊
  • 描述文档的类别与类型 🗂️
  • 解释 标准操作程序（SOP）的目的 🛠️

什么是软件文档？

软件文档 是描述软件产品的相关信息，解释软件的功能和使用方法。
这些文档可以是 文字、视频 或 图形 格式，均与软件产品的开发和使用相关。无论是开发过程还是产品使用，文档都起着至关重要的作用。文档适用于软件开发生命周期（SDLC）的各个阶段。

文档的受众

文档可以为不同类型的受众编写，如：

  • 终端用户（End Users）
  • 软件开发人员（Software Developers）
  • 质量保证工程师（QA Engineers）
  • 系统管理员（System Administrators）
  • 其他相关利益方（Other Stakeholders）

文档的两大分类

文档可以分为 产品文档 和 过程文档 两大类：

  • 产品文档 关注软件产品的功能。
  • 过程文档 描述如何完成一个任务。

过程文档 应提供执行业务过程所需的质量要求。

产品文档的类型

接下来，我们将详细讨论五种常见的 产品文档 类型：
需求文档、设计文档、技术文档、质量保证文档 和 用户文档。

1. 需求文档(Requirements Documentation)

需求文档通常在 SDLC的规划阶段 编写，目标受众是开发团队，包括开发人员、架构师和质量保证人员。
需求文档 详细描述了软件系统预期的功能和特点。它包括：

  • 软件需求规格说明书（Software Requirements Specifications, SRS）
  • 系统需求规格说明书（System Requirements Specifications, SysRS）
  • 用户验收规格说明书（User Acceptance Specifications）

2. 设计文档(Design Documentation)

设计文档 由软件架构师和开发团队编写，用来解释如何构建软件以满足需求。
设计文档包含两类：

  • 概念性设计（Conceptual Design）
  • 技术性设计（Technical Design）

3. 技术文档(Technical Documentation)

技术文档包含代码中的注释，帮助其他开发人员阅读代码并理解其行为。
它还可能包括工作文档，解释代码的工作原理，以及在项目实施过程中记录的工程师思想和想法。

4. 质量保证文档(Quality Assurance Documentation)

质量保证文档 包含所有与测试团队的策略、进度和指标相关的文件。
常见的测试文档类型包括：

  • 测试计划（Test Plans）
  • 测试数据（Test Data）
  • 测试场景（Test Scenarios）
  • 测试用例（Test Cases）
  • 测试策略（Test Strategies）
  • 可追溯性矩阵（Traceability Matrices）

可追溯性矩阵 将测试用例与需求进行映射，确保所有需求都得到了验证。

5. 用户文档(User Documentation)

用户文档 面向最终用户，旨在解释如何操作软件，帮助用户安装和解决系统问题。
用户文档包括：

  • 常见问题解答（FAQ）
  • 安装指南和帮助文档
  • 教程和用户手册

标准操作程序（SOP）

标准操作程序（SOP）通常与 过程文档 一起使用。
过程文档提供了对流程的总体概述，而 SOP 则会详细描述完成特定任务的步骤。

SOP的作用

SOP文档 详细解释了如何完成一个常见但复杂的任务，且这些任务通常是 组织特定的。
例如，对于软件工程师来说，使用代码仓库提交代码是一项常识。然而，不同组织可能有不同的步骤来将代码合并到主分支。SOP文档 会详细解释这些步骤。

SOP可以采用以下几种形式：

  • 流程图（Flowchart）
  • 层级大纲（Hierarchical Outline）
  • 步骤说明（Step-by-Step Instructions）

文档更新的重要性

无论是哪种类型的文档，都必须保持 最新 状态。
例如，当一个基于云的应用程序的用户界面发生变化时，相关的在线文档必须及时更新。

企业需要为文档更新分配足够的资源。在软件开发生命周期（SDLC）中，文档的更新通常发生在 维护阶段。
理想情况下，文档也应该定期审查，以确保其准确性和有效性。

总结

在本视频中，您学习了：

  • 文档有三种格式：文字、视频 或 图形。
  • 过程文档 描述如何完成任务，而 产品文档 关注软件的功能。
  • 产品文档的类型包括：需求文档、设计文档、技术文档、质量保证文档 和 用户文档。
  • 标准操作程序（SOP） 是详细说明特定组织程序的书面指令。