茶亭物联硬件和软件项目研发流程及文档规范手册

版本时间作者说明
V0.102026.07.13王正伟豆包提出需求:硬件和软件的项目流程和文档规范。
V1.002026.07.13王正伟修改格式,补充各阶段的核心关键字。
   

一、总则

1.1 目的

为统一公司硬件、软件研发项目的实施流程,规范全生命周期文档输出标准,把控研发质量、进度与风险,实现研发过程标准化、可追溯、可复用,规避软硬件研发脱节、文档缺失、流程混乱等问题,保障项目高效落地、顺利交付与迭代,特制定本规范。

1.2 适用范围

本规范适用于公司所有自主研发、定制开发的硬件项目、软件项目(含嵌入式软件、上位机软件、后台系统、APP等),以及软硬件结合的一体化研发项目,覆盖项目立项、设计、开发、测试、交付、结项、运维迭代全流程,所有研发参与人员、项目管理人员、质量管理人员必须严格遵照执行。

  • 追溯:每一个研发环节、每一次变更均有记录、有文档、可溯源;
  • 软硬协同:针对软硬件联动项目,明确交叉节点、对接标准与同步机制;
  • 质量可控:各阶段设置评审、校验、测试关卡,未达标不得进入下一阶段;
  • 精简高效:按需输出文档,杜绝冗余无效文档,兼顾规范性与落地性。

二、研发项目通用整体流程(全生命周期)

所有软硬件研发项目统一遵循7大核心阶段,各阶段设置固定准入、准出条件,硬性卡点管控,软硬件专项工作嵌入对应阶段执行。

  • 立项阶段:需求调研、可行性分析、立项评审、项目启动;
  • 需求阶段:需求细化、需求确认、需求评审、需求基线锁定;
  • 设计阶段:总体方案设计、详细软硬件设计、设计评审、方案固化;
  • 发阶段:软件编码、硬件打样/制版、软硬件联调;
  • 测试阶段:单元测试、集成测试、系统测试、压力/可靠性测试、Bug闭环;
  • 交付阶段:版本固化、资料归档、交付评审、上线/量产交付;
  • 结项阶段:项目复盘、资产归档、问题汇总、后续迭代规划、运维支撑。

三、分阶段研发流程细则(硬件+软件差异化)

3.1 立项阶段(软硬件通用)

核心关键字:明确需求,产生立项。

3.1.1 核心流程

市场/业务需求提报 → 项目经理牵头调研 → 技术、成本、风险、可行性分析 → 立项材料编制 → 评审委员会评审 → 立项通过、下达项目任务书、组建项目组。

3.1.2 阶段准出条件

立项评审通过,项目章程发布,项目组人员到位,初步进度计划确定。

3.2 需求阶段(软硬件差异化细化)

核心关键字:明确功能,产生需求。

3.2.1 通用流程

需求收集梳理 → 需求拆解细化 → 需求答疑确认 → 需求评审 → 锁定需求基线,禁止无理由变更。

3.2.2 软件项目专项需求

明确功能需求、性能需求、兼容性需求、安全需求、接口需求、用户操作需求、迭代需求,梳理上下游系统对接关系。

3.2.3 硬件项目专项需求

明确硬件参数、电气性能、结构尺寸、功耗、温湿度适应性、可靠性、量产工艺、成本上限、安规认证、电磁兼容等核心需求。

3.2.4 阶段准出条件

需求评审全员通过,需求文档定稿,建立需求基线,需求变更流程正式启用。

3.3 设计阶段(核心差异化阶段)

核心关键字:明确方案,产生设计。

3.3.1 通用流程

总体方案设计 → 分项详细设计 → 设计自查 → 内部评审 → 正式评审 → 方案定稿、设计基线锁定。

3.3.2 软件项目设计流程

1. 概要设计:系统架构设计、模块拆分、业务流程设计、数据库设计、接口整体规划;

2. 详细设计:各模块逻辑设计、算法设计、页面原型设计、接口详细定义、数据字典设计;

3. 设计评审:架构合理性、性能承载力、安全性、可维护性、可扩展性评审。

3.3.3 硬件项目设计流程

1. 方案设计:总体硬件,核心器件选型、硬件架构规划、功耗与成本预估;

2. 详细设计:原理图设计、PCB布局布线设计、结构适配设计、电源/信号完整性设计;

3. 辅助设计:BOM清单编制、器件替代方案设计、测试点设计、安规防护设计;

4. 设计评审:原理图合理性、PCB工艺可行性、器件通用性、成本、可靠性、量产可行性评审。

3.3.4 阶段准出条件

所有设计文档、图纸、方案评审通过,无重大设计问题,设计基线锁定。

3.4 研发阶段

核心关键字:明确目标,产生研发。

3.4.1 软件开发流程

开发环境搭建 → 模块化编码开发 → 代码自查、注释完善 → 单元测试 → 模块联调 → 版本迭代提交。严格遵循编码规范,定期提交代码仓库,做好版本管控。

3.4.2 硬件开发流程

器件采购 → PCB打样/制版 → 元器件焊接 → 硬件单板调试 → 功能调试 → 性能参数校准 → 问题整改复测 → 样品定型。

3.4.3 软硬件联动项目

完成单板硬件调试后,立即开展软硬件联调,同步解决硬件适配、软件驱动、数据交互等对接问题,形成联调记录。

3.4.4 阶段准出条件

软件开发完成既定功能,单元测试通过;硬件样品调试合格,核心参数达标;软硬件联调无致命问题。

3.5 测试阶段

核心关键字:明确产出,产生测试。

3.5.1 通用测试流程

测试方案/用例编制 → 测试环境搭建 → 多轮测试执行 → Bug提交、分级整改 → 复测闭环 → 测试报告输出。

3.5.2 软件测试专项

覆盖单元测试、集成测试、系统功能测试、性能测试、兼容性测试、安全测试、回归测试,重点验证功能完整性、稳定性、响应速度、容错能力。

3.5.3 硬件测试专项

覆盖硬件功能测试、电气参数测试、功耗测试、高低温可靠性测试、振动测试、EMC电磁兼容测试、安规测试、量产稳定性测试。

3.5.4 阶段准出条件

所有致命、严重Bug全部闭环,一般Bug可控留存,测试通过率达标,正式测试报告评审通过。

3.6 交付阶段

核心关键字:明确可控,产生交付。

3.6.1 软件交付

版本打包固化、代码归档、配置文件整理、部署手册、用户手册编制 → 交付评审 → 上线部署/交付客户。

3.6.2 硬件交付

定型样品确认、量产资料固化(图纸、BOM、工艺文件)、质检标准定稿 → 交付评审 → 小批量试产/正式量产交付。

3.6.3 阶段准出条件

交付资料齐全、版本固化,交付评审通过,完成交付交接。

3.7 结项阶段

核心关键字:明确权责,产生结项。

项目工作总结、进度/成本/质量复盘 → 问题汇总与改进方案输出 → 所有项目资料统一归档 → 迭代需求梳理规划 → 项目结项审批。

四、全阶段文档输出规范(硬件+软件分类清单)

所有文档统一使用公司标准模板,命名、版本、格式、审批流程统一,全程可追溯,分为通用文档、软件专属文档、硬件专属文档三类。

4.1 文档通用规范(强制执行)

4.1.1 命名规范

统一格式:【项目名称】-【阶段】-【文档名称】-【版本号】,示例:【智能温控设备】-【需求阶段】-【软件需求规格说明书】-V1.0

4.1.2 版本规范

初始版本V1.0,小幅修改迭代V1.1、V1.2,重大改版升级V2.0;所有版本必须记录修改日志、修改人、修改时间、修改内容。

4.1.3 格式规范

统一字体、行距、标题层级,图文清晰,表格规范;技术图纸、流程图、架构图矢量清晰,标注完整;所有文档需包含封面、目录、版本记录、正文、审批签字栏。

4.1.4 归档规范

按项目-阶段-文档类型分类归档,电子档+必要纸质版留存,代码、图纸、文档统一存入公司知识库/代码仓库,权限分级管控。

4.2 各阶段通用必备文档

项目阶段必备通用文档核心作用
立项阶段项目立项申请书、可行性分析报告、项目章程、项目进度计划表明确项目价值、可行性、范围、进度、人员,作为项目启动依据
需求阶段需求调研记录、需求规格说明书、需求评审报告、需求变更记录表锁定需求基线,杜绝需求无序变更,统一研发对标标准
设计阶段总体方案设计报告、设计评审报告、设计变更记录表固化整体研发方案,校验设计合理性,记录设计迭代过程
研发阶段开发日志、阶段进度汇报、问题整改跟踪表跟踪开发进度,记录研发问题,保障过程可控
测试阶段测试方案、测试用例、Bug清单及整改报告、测试总结报告标准化开展测试,闭环质量问题,出具质量验收依据
交付阶段交付清单、交付评审报告、用户验收报告明确交付内容,完成交付验收,留存交付凭证
结项阶段项目复盘报告、项目总结报告、全套资料归档清单沉淀项目经验,归档研发资产,支撑后续迭代优化

4.3 软件项目专属文档规范

除通用文档外,软件项目需额外输出以下专属文档,缺一不可:

  • 软件概要设计说明书:包含系统架构、模块划分、业务流程、接口总体规划、技术栈选型说明;
  • 软件详细设计说明书:包含各模块逻辑流程、算法设计、功能细节、页面交互逻辑;
  • 数据库设计说明书:包含数据表结构、字段定义、关联关系、数据字典、索引设计;
  • 接口设计说明书:包含内外接口定义、请求参数、返回参数、调用方式、异常处理规则;
  • 代码规范文档&代码自查报告:统一编码规范,记录代码自查、优化情况;
  • 部署运维手册:包含环境搭建、版本部署、配置修改、故障排查、日常运维流程;
  • 用户操作手册:面向客户/使用者,详细说明功能操作、使用流程、常见问题解答。

4.4 硬件项目专属文档规范

除通用文档外,硬件项目需额外输出以下专属文档,量产项目全部必填:

  • 硬件详细设计说明书:包含硬件整体架构、核心器件选型说明、各单元电路设计原理、参数指标;
  • 原理图文件&原理图清单:完整可编辑原理图、电路模块说明、信号流向标注;
  • PCB设计文件&PCB工艺说明:PCB图纸、布局布线说明、生产工艺要求、阻抗控制标准;
  • BOM物料清单:精准标注物料型号、规格、品牌、用量、替代料、供应商、单价;
  • 硬件测试报告:包含电气性能、功耗、可靠性、温湿度、EMC、安规等全项测试数据与结论;
  • 硬件调试记录:记录调试过程、问题现象、根因分析、整改方案、复测结果;
  • 量产工艺文件:包含焊接工艺、组装流程、质检标准、老化测试规范、量产注意事项;
  • 结构适配说明文档:硬件与结构外壳、安装尺寸、散热适配、防水防尘适配说明。

五、核心管控规范(关键硬性要求)

5.1 需求变更管控

项目进入需求基线后,禁止口头变更需求。所有需求变更必须提交《需求变更申请单》,经项目经理、技术负责人、甲方(如有)评审通过后,方可执行变更,同步更新所有关联文档,全程留痕追溯。

5.2 设计评审管控

软件架构设计、硬件原理图/PCB设计必须开展正式评审,无评审记录、评审未通过不得进入开发/打样阶段,杜绝带病设计、盲目开发。

5.3 版本管控

软件代码、硬件图纸、所有文档均实行版本管控,旧版本留存备份,禁止直接覆盖修改;正式交付版本统一冻结,标记为最终交付版本,严禁私自改动。

5.4 质量闭环管控

测试、调试过程中发现的致命、严重问题,必须100%闭环整改;一般问题需明确整改计划与风险说明,由质量负责人确认留存,严禁带重大问题交付。

5.5 软硬件协同管控

软硬件联动项目需建立同步机制,设计、开发、测试阶段定期同步进度,硬件改版、软件驱动变更必须双向同步,避免出现软硬件适配脱节、版本不匹配问题。

六、文档审批权限规范

  • 立项、结项、复盘类文档:项目经理初审、部门负责人复审、公司技术负责人终审;
  • 需求、设计核心文档:研发负责人初审、技术总监复审、项目组全员评审确认;
  • 测试、交付类文档:测试负责人/研发负责人初审、项目经理复审、甲方(如有)验收确认;
  • 日常过程文档:对应负责人编制、项目经理审核归档。