SuperAPI AI 工具集

documentation-how

编程与开发

查看项目

更新于 10-16 09:47

技能介绍

用途:本技能面向 Scenescape 仓库的文档维护,回答“在哪里改、每种改动要更新什么”。何时更新文档另见 .github/copilot-instructions.md 的“Documentation Requirements (Always-On)”,本指南只讲 HOW。

文档位置按组件划分:服务概览 docs/user-guide/microservices/<service>/<service>.md;构建说明 docs/user-guide/microservices/<service>/get-started/build-from-source.md;服务 README <service>/README.md;API 规范 docs/user-guide/microservices/<service>/**/_assets/*.yaml 或 api-reference.md;根文档 docs/user-guide/;测试指南 tests/README.md 及各服务测试文档(例如 mapping/tests/README.md)。

更新检查清单:概览中的功能描述(列全选项/变体)、build-from-source.md 的构建命令(含新目标)、API 文档(端点或参数变化)、示例代码、配置示例、前置依赖、测试说明。

示例模式:模型选择类功能需在概览列出全部模型/选项,展示每个变体的构建命令,更新 API 示例与健康检查/状态响应;新服务需建目录结构、写服务概览与构建说明、创建或更新 API 参考、写测试 README,并更新根文档与主 README;配置改动需记录新环境变量、提供 .env 片段、更新构建说明并列出配置文件或 schema 变化;API 改动需更新 OpenAPI/Swagger 或 api-reference.md、服务概览、示例代码,并记录废弃或破坏性变更及迁移指南。

组件示例:Controller 涉及 controller.md、build-from-source.md、api-reference.md 与 _assets/scene-controller-api.yaml、data_formats.md、发布外部源适配器的 how-to、.github/skills/external-source-adapter/SKILL.md、controller/tests/README.md;改动 external_source/external_pose/external_detection 契约时,先改 schema 与 data_formats.md,再确认 how-to 与 skill 中的链接和检查清单仍有效,且不要在 how-to 或 skill 中重复字段表。Manager、Autocalibration 各有对应的概览、构建、API 与测试文档。

跨服务文档:docs/user-guide/ 下的架构概览、安装入门、构建说明、部署(preparation.md、deploy-docker.md、deploy-kubernetes.md、deploy-demo.md)、开发指南、测试与 API 参考索引;当改动影响多个服务、构建或部署流程、测试流程、开发工作流时更新根文档。

限制:本资料未提供安装方式、许可、收费或平台支持信息,暂未提供。禁止输出HTML、添加收录来源或引用导航站名称。