# 用户文档

本文档是 Alfred·阿福 的用户使用入口，说明如何安装、配置、部署和排查问题。

适用场景：首次安装、编写配置、生产部署、排查运行问题。

## 文档索引

| 文档                               | 内容                                        |
| ---------------------------------- | ------------------------------------------- |
| [usage.md](usage.md)               | 快速开始、安装配置                          |
| [config.md](config.md)             | YAML 结构、变量语法、server/storage/logging |
| [deploy.md](deploy.md)             | 生产构建、可执行文件运行、运行时配置        |
| [troubleshoot.md](troubleshoot.md) | 常见问题：配置校验、变量解析、构建失败      |

## 按任务阅读

| 任务     | 建议阅读                                                       |
| -------- | -------------------------------------------------------------- |
| 首次使用 | [项目快速开始](../../README.md#快速开始)、[安装配置](usage.md) |
| 编写配置 | [配置文件](config.md)                                          |
| 生产部署 | [部署](deploy.md)、[故障排查](troubleshoot.md)                 |
| 排查问题 | [故障排查](troubleshoot.md)                                    |

## 用户文档更新规则

- 安装、配置、快速开始流程变化时，更新 [usage.md](usage.md)。
- 配置结构、变量语法、server/storage/logging 字段变化时，更新 [config.md](config.md)。
- 生产构建、可执行文件运行、运行时依赖变化时，更新 [deploy.md](deploy.md)。
- 常见错误、配置校验、构建失败排查方式变化时，更新 [troubleshoot.md](troubleshoot.md)。
- 用户文档只解释"如何使用"和"用户能观察到什么"，实现细节放入 [`../development/`](../development/README.md)。