# 用户文档

本文档是 DiAL 的用户使用入口，说明如何阅读配置、部署、expect 规则、故障排查和各 checker 参考。

适用场景：编写 YAML 配置、部署 DiAL、理解拨测结果、排查运行问题、查询某个 checker 的字段和示例。

## 文档索引

| 文档                                     | 内容                                              |
| ---------------------------------------- | ------------------------------------------------- |
| [configuration.md](configuration.md)     | YAML 顶层结构、变量、server、targets 通用字段     |
| [deployment.md](deployment.md)           | 生产构建、Docker、ICMP 权限、发布包运行方式       |
| [expectations.md](expectations.md)       | expect 规则、状态判定、failure、observation       |
| [troubleshooting.md](troubleshooting.md) | 配置校验、变量、ICMP、CMD、Docker、证书和正则问题 |
| [checkers/README.md](checkers/README.md) | 各 checker 的配置项、expect 字段和示例            |

## 按任务阅读

| 任务                  | 建议阅读                                                               |
| --------------------- | ---------------------------------------------------------------------- |
| 首次运行              | [项目快速开始](../../README.md#快速开始)、[配置文件](configuration.md) |
| 编写配置              | [配置文件](configuration.md)、[Checker 参考](checkers/README.md)       |
| 编写 expect           | [校验规则](expectations.md)、对应 checker 文档                         |
| 容器或生产部署        | [部署](deployment.md)、[故障排查](troubleshooting.md)                  |
| 排查启动或运行问题    | [故障排查](troubleshooting.md)、相关 checker 文档                      |
| 查询 checker 专属字段 | [Checker 参考](checkers/README.md)                                     |

## 用户文档更新规则

- 配置结构、变量、server、probes、targets 通用字段变化时，更新 [configuration.md](configuration.md)。
- checker 配置项、expect 字段、示例或运行行为变化时，更新 `checkers/<type>.md` 和 [checkers/README.md](checkers/README.md)。
- expect 模型、状态判定、failure、observation 或快速失败顺序变化时，更新 [expectations.md](expectations.md)。
- 构建产物运行方式、Docker 参数、镜像内置依赖、发布包结构变化时，更新 [deployment.md](deployment.md)。
- 常见错误、运行依赖、权限、证书或配置校验排查方式变化时，更新 [troubleshooting.md](troubleshooting.md)。
- 用户文档只解释“如何使用”和“用户能观察到什么”，实现细节放入 [`../development/`](../development/README.md)。
