# 文档范围与版本

> 说明公开文档的内容边界和版本策略。

Canonical page: /reference/documentation-policy



## 公开范围 [#公开范围]

本站发布产品使用、插件开发和稳定 SDK 契约。以下内容默认不公开：

* 架构决策记录和未完成方案。
* 部署拓扑、内部域名及凭据配置。
* 遥测实现、故障报告和内部验证记录。
* 尚未稳定的实验功能。

## 版本策略 [#版本策略]

当前文档描述最新发布版本。页面涉及特定版本时会在正文中明确标注；在出现需要长期维护的兼容分支前，不建立多版本站点。

## 事实来源 [#事实来源]

* 用户可见入口和文案以当前 Desktop 路由、界面和 i18n 资源为准。
* SDK、RPC、CLI 和配置字段以包公开导出、类型声明和可执行参数为准。
* `content/docs/` 是公开解释的唯一来源，不直接发布仓库内部 ADR、实施日志或验证记录。
* 示例必须使用公开入口；不能通过深度导入内部 `src/**` 让示例暂时可运行。

每次影响公开行为、配置、权限、协议或入口的变更，都应检查 `apps/docs-site/docs-coverage.json` 中对应领域并更新页面或验证状态。

## 内容类型 [#内容类型]

不同页面解决不同问题，避免把所有信息堆进一个超长入口：

| 类型   | 回答的问题              | 必须包含                      |
| ---- | ------------------ | ------------------------- |
| 快速开始 | 怎样尽快完成第一次成功任务？     | 前置条件、最小步骤、预期结果、下一步        |
| 指南   | 某项能力何时使用，状态和边界是什么？ | 适用条件、操作步骤、验证方式、常见恢复       |
| 实战示例 | 一项完整工作怎样从输入走到验收？   | 起始状态、可复制任务、预期产物、验收证据、修正路径 |
| 参考   | 稳定字段、命令或合同究竟是什么？   | 精确取值、默认值、兼容边界和事实来源        |

示例中的占位路径、域名和模型 ID 必须明确标注；可执行代码只使用公开入口。页面应链接到更深层解释，而不是在快速开始和示例中复制整份参考合同。

## 发现问题 [#发现问题]

提交文档问题时，请提供页面地址、错误内容、使用的 Vetta 版本以及期望行为。不要在问题中包含访问密钥、个人数据或内部服务地址。