菜单
Procedures for updating Scenescape documentation — where to make changes and what to update for each type of modification.
默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。
决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
直接命令不会经过审查 Prompt；运行前请先检查来源。
npx skills add https://github.com/open-edge-platform/scenescape --skill documentation-how命令会保持在同一行。复制前请横向滚动并检查完整内容。
想先保存到本地？可下载 SkillsMP 当前能够提供的文件。
正在显示 SKILL.md
| name | documentation-how |
| description | Procedures for updating Scenescape documentation — where to make changes and what to update for each type of modification. |
For guidance on WHEN to update documentation, see the "Documentation Requirements (Always-On)" section in .github/copilot-instructions.md.
This guide covers the HOW: where to make changes and what to update for each type of modification.
docs/user-guide/microservices/<service>/<service>.md - Feature descriptions, API endpoints, usage examplesdocs/user-guide/microservices/<service>/get-started/build-from-source.md - Build steps, Makefile targets, Docker commands<service>/README.md - Quick start and high-level overview (if exists)docs/user-guide/microservices/<service>/**/_assets/*.yaml or api-reference.md - API specs/references for REST APIsdocs/user-guide/ - Cross-service documentation, architecture guidestests/README.md and service-specific test docs (for example mapping/tests/README.md) - Test setup and execution instructionsWhen making changes, verify and update:
build-from-source.md (include new targets)docs/user-guide/microservices/<service>/ directory structure<service>.md with feature descriptions and API endpointsget-started/build-from-source.md with build instructionsapi-reference.md and/or _assets/*.yaml) if applicabledocs/user-guide/ with cross-service documentation<service>.md).env snippetsbuild-from-source.md with configuration instructions_assets/*.yaml) or api-reference.md<service>.md) with new endpoints/parametersbuild-from-source.mddocs/user-guide/microservices/controller/controller.md): Scene management, object tracking, REST APIdocs/user-guide/microservices/controller/get-started/build-from-source.md): Makefile targets, Docker commandsdocs/user-guide/microservices/controller/api-reference.md and _assets/scene-controller-api.yaml): gRPC/REST endpoint definitionsdocs/user-guide/microservices/controller/data_formats.md): Canonical MQTT contracts, including External Source Input Message Formatdocs/user-guide/how-to-guides/publish-external-source-adapter.md): Procedure for converter scripts (links to data formats; does not duplicate field tables).github/skills/external-source-adapter/SKILL.md): Agent checklist; points at the how-to and data formatscontroller/tests/README.md): Unit, functional, integration test executionWhen changing the external_source / external_pose / external_detection
contract: update the schema and data_formats.md first, then verify links and
checklists in the how-to and .github/skills/external-source-adapter/SKILL.md
still resolve. Do not restate field tables in the how-to or skill.
docs/user-guide/using-intel-scenescape/ and related guides): Web UI features, REST API, database schemadocs/user-guide/get-started/installation.md and root build guides): Django setup, migrations, static filesdocs/user-guide/api-reference.md): REST endpoint definitionsmanager/tests/README.md): UI tests, functional tests, API testsdocs/user-guide/microservices/auto-calibration/auto-calibration.md): Calibration algorithms, input/output formatsdocs/user-guide/microservices/auto-calibration/get-started/build-from-source.md): Build commands, dependenciesdocs/user-guide/microservices/auto-calibration/api-reference.md): REST API for calibration requestsRoot-level documentation in docs/user-guide/:
Update root documentation when: