lanyuanxiaoyao
763d814543
建立 docs/user/ 和 docs/development/ 分层文档结构： - docs/README.md 文档总路由、归属矩阵、影响分析规则 - docs/user/ 模板使用、配置、部署、故障排查 - docs/development/ 架构、后端、前端、构建发布开发规范 - README.md 轻量化为项目入口和索引 - 删除 DEVELOPMENT.md，内容拆分至专题文档 - 更新 openspec/config.yaml 首读入口和文档影响分析规则 - 修正 docs/prompts/README.md 过时引用和边界说明
32 lines
1.9 KiB
Markdown
32 lines
1.9 KiB
Markdown
# 用户文档
|
|
|
|
本文档是 my-app 的用户使用入口，说明如何使用模板、配置、部署和排查问题。
|
|
|
|
适用场景：使用本模板创建新项目、编写配置、生产部署、排查运行问题。
|
|
|
|
## 文档索引
|
|
|
|
| 文档 | 内容 |
|
|
| ---------------------------------- | ------------------------------------------- |
|
|
| [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)。
|