1. 课程总览与学习目标
本章作为《机器人原型说明书结构指南》的起点,旨在帮助学习者建立对课程全貌的系统认知。通过明确适用角色、交付物清单、前置知识要求以及学习路径概览,确保每位学员在进入具体章节前已对齐学习预期,并掌握自主追踪进度的能力。
1.1 适用角色
本课程面向以下三类核心角色,每类角色的关注点与责任边界有所不同:
| 角色 | 典型职责 | 本课程收益 |
|---|---|---|
| 机器人硬件工程师 | 机械结构设计、选型、装配 | 掌握标准化的说明书结构,提升BOM与装配流程的可追溯性 |
| 嵌入式/系统软件工程师 | 固件开发、传感器集成、通信协议实现 | 学会编写接口说明、数据流文档与API调用示例 |
| 技术文档/产品经理 | 维护说明书版本、确保跨团队一致性 | 建立从需求到验收的完整文档流水线,降低沟通损耗 |
角色建议:若你同时承担硬件与软件工作,建议先通览全课程,再依据当前任务跳转至对应SOP章节。
1.2 交付物清单
完成本课程后,你将独立产出一套完整的《机器人原型说明书》。该说明书包含以下8项核心交付物:
- 产品概述与环境 – 原型定位、运行条件、安全注意
- 机械结构总成 – 爆炸图、BOM表、装配步骤
- 电气系统原理 – 电路框图、线缆表、功耗估算
- 传感器与执行器配置 – 选型依据、安装公差、接线图
- 软件接口说明 – 通信协议、API端点、运行参数
- 操作与维护规范 – 上电流程、日常校准、故障代码
- 安全与合规声明 – 风险评估、认证清单、EMC要求
- 附录与版本记录 – 变更日志、术语表、参考标准
1.3 前置知识
学习者需具备以下基础能力方可顺畅跟进课程:
- 能够阅读机械工程图与基本电路原理图。
- 熟悉至少一种主流机器人操作系统(如 ROS 2、Micro-ROS)的基础概念。
- 具有基础的Markdown/Word文档编辑能力。
重要提醒:本课程不教授机器人设计或编程本身,而是聚焦于“如何将已有设计成果转化为结构化、可复用的说明书”。若你尚未完成原型基本设计,建议先完成至少功能样机原型。
1.4 学习路径概览
课程采用“总-分-总”的SOP结构,共分30章。以下概览图展示整体流程与关键里程碑:
1.5 章节SOP映射
本课程严格遵循流程SOP型课程设计规范,每章均围绕以下8个核心维度展开。以下表格展示了本章(第1章)的完整映射关系:
| SOP维度 | 本章对应内容 | 典型交付物/记录 |
|---|---|---|
| 适用场景 | 团队协作开发机器人原型、需要统一说明书模板 | 适用角色表(参见1.1) |
| 前置条件 | 已掌握前置知识、已完成功能样机 | 前置知识清单(参见1.3) |
| 操作步骤 | 通览全课程 → 标记自身角色 → 对照交付物清单 | 学习路径概览图(参见1.4) |
| 输入输出物 | 输入:前置知识;输出:学习计划确认 | 交付物清单(参见1.2) |
| 责任边界 | 学习者需自行评估角色并规划学习节奏 | 角色职责定义(参见1.1) |
| 记录材料 | 学习路径图、适用角色核对表 | 内联SVG与表格 |
| 异常处理 | 若前置知识不足,暂停并补齐相应基础 | 本节警告提示块 |
| 验收标准 | 学习者能清晰回答:我的角色?我的核心交付物? | 角色与交付物对应关系 |
1.6 快速启动命令
如果你习惯通过命令行管理工程文档,可使用以下命令快速创建课程根目录结构:
mkdir -p robot_proto_doc/{01_overview,02_mechanical,03_electrical,04_sensor_actuator,05_software,06_operation,07_safety,08_appendix}
mkdir -p robot_proto_doc/03_electrical/{schematics,wiring}
mkdir -p robot_proto_doc/05_software/{api,protocol,config}
touch robot_proto_doc/README.md
该命令不会在本课程中重复讲解,建议你从现在起建立文档维护目录。在后续章节中,我们将逐步填充每个子目录下的标准化说明书文件。
学习指引:若你对本章内容已全部理解,且能够回答“交付物清单中哪一项与我的当前工作最相关”,即可进入第2章。第2章将详细讲解机械结构总成的SOP编写方法。