42 lines
2.3 KiB
Markdown
42 lines
2.3 KiB
Markdown
# 文档地图
|
||
|
||
> 本目录是 NexDocus 文档的**唯一入口**。仓库根目录只保留 `README.md`（项目总览），其余文档全部在此。
|
||
|
||
## 按角色导航
|
||
|
||
| 你是谁 / 想做什么 | 从这里开始 |
|
||
| --- | --- |
|
||
| 第一次跑起来 | [quickstart.md](quickstart.md) |
|
||
| 部署到服务器（Docker） | [deploy/README.md](deploy/README.md) |
|
||
| 查表结构、写 SQL、排查数据 | [database.md](database.md) |
|
||
| 给使用者介绍功能 | [manual/user-guide.md](manual/user-guide.md) |
|
||
| 写代码前先对齐设计 | [sdd/README.md](sdd/README.md) |
|
||
| 查某个版本改了什么 | [sdd/releases/](sdd/releases/) · [deploy/changelog.md](deploy/changelog.md) |
|
||
| 找运维/开发脚本 | [../scripts/README.md](../scripts/README.md) |
|
||
| 翻历史方案（已与现状不符） | [archive/README.md](archive/README.md) |
|
||
|
||
## 目录结构
|
||
|
||
```
|
||
docs/
|
||
├── README.md # 本文（文档地图）
|
||
├── quickstart.md # 开发环境快速上手
|
||
├── database.md # 数据库设计：18 张表 + 初始化/迁移链路
|
||
├── deploy/
|
||
│ ├── README.md # Docker Compose 部署、升级、备份恢复
|
||
│ └── changelog.md # 部署相关变更记录（端口、存储、脚本迁移等）
|
||
├── manual/
|
||
│ └── user-guide.md # 面向最终使用者的功能手册
|
||
├── sdd/ # 规格驱动开发（SDD）体系：愿景/架构/ADR/DV 规格/发布
|
||
└── archive/ # 历史文档归档，只作背景，不作为实现依据
|
||
```
|
||
|
||
## 文档维护约定
|
||
|
||
1. **新增文档只能落在 `docs/` 下**，根目录不再新增 `*.md`（`README.md` 除外）。
|
||
2. 文档内互链一律用**相对路径**，跨目录引用要能点击跳转；不要写"参见根目录 XXX.md"这类口头引用。
|
||
3. 涉及命令的段落必须与 `scripts/` 的实际行为一致（例如统一写 `./scripts/deploy.sh`，不是 `./deploy.sh`）。
|
||
4. **严禁在文档中写入真实环境的地址、账号、口令**。示例一律使用 `change_me` 之类的占位值。
|
||
5. 代码行为变更时，同一批改动里更新对应文档；做不到就在 `sdd/releases/` 的发布记录里登记待办。
|
||
6. 数据库结构以 `backend/app/models/` 为准，`database.md` 是其可读镜像；两者冲突时以模型为准并回头修文档。
|