参与共建
本站采用 Git + Markdown + 评审 的多人维护方式。研发、产品、算法与技术支持人员可以并行编辑,所有变更都有版本记录。
贡献流程
- 从主分支创建内容分支。
- 在
wiki/docs中编辑或新建 Markdown 文档。 - 本地运行网站,检查链接、目录和代码示例。
- 发起合并请求,请产品或技术负责人审核。
- 审核通过后合并,由部署流程自动发布。
写作约定
- 一页只解决一个明确问题,标题使用用户能理解的词。
- 参数必须注明型号、版本、单位和测试条件。
- 命令与代码需要实际运行验证;截图不得包含敏感数据。
- 不确定内容用“待确认”标注,不把推测写成产品承诺。
- 重大变更在页面顶部记录版本和生效日期。
角色建议
产品负责人审核规格与型号;硬件 / 固件负责人审核接口和协议;算法负责人审核数据与指标;文档维护人负责结构、链接和发布质量。