开发文档那些事儿

软件需求说明书

阶段：项目立项初期

作用：收集用户需求，将需求转化为可实现的作用需求，为开发提供产品原型

可见：内部公开，这个文档一般由产品人员（前端FAE）主导，项目相关人员评审

输入：FAE前端的需求描述

阶段：程序开发初期

作用：提供一个概括性的软硬件、机械系统蓝图，里边描述硬件需要什么板卡（采集、处理、控制等）、软件划分为多少个功能模块（嵌入式软件、上位机软件、web服务器、驱动开发等等），需要达到什么标准，整个软硬件系统的大致工作流程、输入输出

可见：内部公开，这个文档一般由系统工程师（架构师）主导和设计，软硬件开发人员进行评审

输入：软件需求说明书、专家（架构师）判断、已有的产品文档资产

阶段：程序开发初期

作用：对系统概要设计里边描述的软件模块（子系统）进行详细地设计 –> 包括用什么库、什么通信协议、输入输出、工作流程等

可见：内部公开，这个文档一般由不同职责地软件工程师设计，最终汇总成一份详细地文档或者多份

输入：软件需求说明书 / 系统概要设计、专家（架构师）判断、已有的产品文档资产、工程师开发经验

阶段：软件发版本给测试，走测试流程

作用：为测试提供设计的约束 / 参考，就是告诉测试人员，哪些行为是正确的，预期的效果是怎么样的，要达到什么样的性能要求，可以根据软件的功能模块来划分测试工作，如：采集模块、分析模块、显示模块 ……

可见：内部公开，一般由软件学科代表形成初稿给到测试人员，测试人员再形成自己地测试方案

输入：软件需求说明书 / 系统概要设计

阶段：产品已经小批量或者大规模交付客户使用，这时候产品的软件功能已经比较稳定（不会有大范围变更）

可见：外部可见，产品人员（手册工程师）形成，客户能通过这个文档熟悉产品的功能

输入：软件需求说明书、软件详细设计文档