AI小龙虾OPENCLAW技术团队使用指南 V2.0

硬核技术，钳力全开！

核心理念与团队定位

1. 团队使命：聚焦前沿AI与机器人技术（尤其是“具身智能”方向），研发像小龙虾OPENCLAW一样灵活、坚固、智能的软硬件系统解决方案。
2. 文化：
   • 开放 (Open)：开源协作,知识共享。
   • 坚韧 (Resilient)：像小龙虾外壳，直面挑战,快速迭代。
   • 精准 (Precise)：像虾钳,问题定位与解决力求精准。
   • 协同 (Synergistic)：软硬件紧密配合,如一体。

核心工具栈 (Tech Stack)

代码与版本控制

• 主仓库：GitLab (内部搭建，用于私有项目) / GitHub (用于开源项目)。
  • 分支模型：采用 Git Flow 或 主开发分支 + 功能分支 简化模型。
  • Commit规范：使用 [模块前缀] 描述 格式，如 [firmware] 修复舵机抖动bug。
• 代码审查：所有合并请求必须经过 至少一名 核心成员审查，使用GitLab/GitHub的MR/PR功能。

项目管理与协作

• 任务看板：Jira 或 GitLab Issues。
  • 史诗 -> 特性 -> 用户故事/任务 三级拆分。
  • 状态流：Backlog -> To Do -> In Progress -> Code Review -> Testing -> Done。
• 文档与知识库：Confluence 或 Wiki.js。

  必须维护！包含：项目设计文档、API文档、部署手册、问题排查记录、技术分享。

• 即时通讯：Slack 或 飞书/钉钉（国内团队）。
  • 创建频道：#general, #dev-random, #hardware-lab, #ai-models, #urgent-issues。

持续集成/持续部署 (CI/CD)

• 平台：GitLab CI/CD 或 Jenkins。
• 关键流水线：
  • 代码检查流水线：触发代码风格检查、静态分析。
  • 固件构建流水线：自动编译MCU固件,生成二进制文件。
  • 模型训练流水线：自动化数据预处理、模型训练与轻量化测试。
  • 系统镜像构建流水线：为机器人主控板生成完整的OS镜像。

硬件与实验室

• 原型机管理：每台原型机有唯一ID，在Wiki中记录状态（如：OPENCLAW-PROTO-03， 位置：Lab A3， 状态：测试中）。
• 零件库：使用 SnapEDA 或内部数据库管理元器件。
• 3D打印/机加工：文件统一存储在 硬件设计/结构件 目录,版本号与固件对应。

标准开发流程

1. 需求与设计：
   • 在项目管理工具中创建“史诗”或“特性”。
   • 召开 设计评审会，产出设计文档（系统架构图、接口定义、关键算法说明）。
2. 开发：
   • 从主分支创建 功能分支。
   • 遵循代码规范，编写单元测试（针对软件）。
   • 硬件开发需同步更新原理图和BOM。
3. 代码审查与合并：
   • 推送代码,创建合并请求。
   • 审查者检查代码逻辑、风格、潜在BUG及测试覆盖。
   • 通过后，由提交者本人执行合并。
4. 集成与测试：
   • 自动流水线进行构建和基础测试。
   • 硬件团队进行烧录与功能测试。
   • AI团队进行模型性能评估。
   • 进行 系统集成测试,记录测试报告。
5. 发布：
   • 为稳定版本打标签 v1.2.0。
   • 发布固件镜像、模型文件、API更新日志。

关键技术领域规范

AI/ML 子团队

• 数据管理：使用 DVC 进行数据版本控制，原始数据->标注数据->训练集/测试集路径必须清晰。
• 模型仓库：使用 MLflow 或 Weights & Biases 跟踪实验，记录超参数、指标和模型文件。
• 模型部署：统一输出为 ONNX 或 TensorRT 格式,供边缘设备调用。

嵌入式/固件子团队

• 编码标准：遵循 MISRA C/C++ 关键规则,使用静态分析工具。
• 日志系统：实现分级日志（DEBUG, INFO, ERROR），通过UART或网络输出,便于现场调试。
• 安全：OTA升级需验签,关键参数存储于受保护存储区。

机器人软件（ROS）子团队

• ROS版本：统一使用 ROS 2 Humble/H 或指定版本。
• 包管理：每个功能一个独立的ROS包,依赖清晰。
• 消息接口：自定义消息格式需团队评审,保持向后兼容。

沟通与会议

• 每日站会：15分钟，回答“昨天做了什么？今天计划？有何阻塞？”,建议在早上进行。
• 周会：复盘本周进展，同步下周计划,进行技术简短分享。
• 设计评审会：在重大项目开始前召开，必须举行。
• 复盘会：项目里程碑或重大问题解决后召开,总结经验教训。

新成员入门清单

1. 第一日：
   • 获取账户（GitLab, Wiki, 通讯工具）。
   • 阅读本指南和团队Wiki的“入门”章节。
   • 配置开发环境（使用团队提供的 Docker 镜像或安装脚本）。
2. 第一周：
   • 认领一个简单的 good first issue。
   • 在导师指导下完成第一次代码提交与合并。
   • 熟悉硬件实验室安全规范。
3. 第一个月：
   • 独立负责一个完整的小功能模块。
   • 在周会上做一次技术分享。

重要原则

• 文档优先：做任何事之前，先想想是否需要/更新文档。
• 问题透明：遇到阻塞，及时在相关频道提出,附上日志和错误信息。
• 安全第一：硬件操作、实验室纪律、数据安全、代码安全永不妥协。
• 尊重工具：工具流程是提高效率的保障,请严格遵守。

让我们像OPENCLAW一样，紧密协作，精准发力，共同攻克技术难关！

如有任何疑问或建议，请随时在 #dev-random 频道提出或更新此指南文档。

(本指南存放于团队Wiki首页，需定期维护更新)

标签： AI小龙虾OPENCLAW 技术团队使用指南