104 行
2.4 KiB
Markdown
104 行
2.4 KiB
Markdown
# 规范-文档索引与可发现性
|
||
|
||
> **位置**: `docs/开发规范/规范-文档索引与可发现性.md`
|
||
> **版本**: v1.0
|
||
> **日期**: 2026-07-08
|
||
> **关联**: AGENTS.md、docs/index.md
|
||
|
||
---
|
||
|
||
## 1. 总索引维护
|
||
|
||
`docs/index.md` 为文档总入口，必须保持最新。每个 agent 新增/修改文档后，必须同步更新索引。
|
||
|
||
### 1.1 索引格式
|
||
|
||
```markdown
|
||
## 设计文档（GDD）
|
||
|
||
| 编号 | 文档 | 状态 | 最后更新 |
|
||
|------|------|------|----------|
|
||
| GDD-00 | [决策总索引](设计文档/GDD-00-决策总索引.md) | ✅ v2.6 | 2026-07-06 |
|
||
| GDD-01 | [种族系统设计](设计文档/GDD-01-种族系统设计.md) | ✅ v2.14 | 2026-07-06 |
|
||
```
|
||
|
||
### 1.2 索引更新规则
|
||
|
||
- 新增文档 → 在对应分类末尾追加一行
|
||
- 修改文档 → 更新「状态」和「最后更新」列
|
||
- 废弃文档 → 状态改为 `❌ 已废弃`，保留链接（避免死链）
|
||
|
||
---
|
||
|
||
## 2. 文档间导航
|
||
|
||
### 2.1 快速导航（每份文档头部）
|
||
|
||
```markdown
|
||
> 📎 快速导航:
|
||
> [上一篇: GDD-01 种族系统] | [下一篇: GDD-03 战斗系统] | [索引: 决策总索引]
|
||
```
|
||
|
||
### 2.2 相关文档链接
|
||
|
||
每份文档头部「关联文档」栏必须列出所有引用或被引用的文档：
|
||
|
||
```markdown
|
||
> **关联文档**: GDD-02（底层核心机制）、GDD-23（能量体系）、PRD-05（战斗系统需求）
|
||
```
|
||
|
||
---
|
||
|
||
## 3. 关键词索引
|
||
|
||
`docs/开发规范/关键词索引.md`（可自动生成）维护关键词到文档的映射：
|
||
|
||
```markdown
|
||
| 关键词 | 相关文档 |
|
||
|--------|----------|
|
||
| 能量体系 | GDD-02 ✅158, GDD-23, PRD-01 §2, PRD-05 §2.8 |
|
||
| 天启机制 | GDD-08 ✅122, GDD-08 ✅160, PRD-02 §2.2, PRD-10 §2.5 |
|
||
| 死亡惩罚 | GDD-02 ✅25, PRD-06 §2.8 |
|
||
| 拍卖系统 | GDD-14, PRD-06 §2.3 |
|
||
```
|
||
|
||
---
|
||
|
||
## 4. 决策速查
|
||
|
||
在 `GDD-00` 中增加按主题分类的决策索引：
|
||
|
||
```markdown
|
||
## 按主题索引
|
||
|
||
### 能量体系
|
||
| 决策 | 主题 |
|
||
|------|------|
|
||
| ✅158 | 能量双轨模型 |
|
||
| ✅159 | 四档恢复梯度 |
|
||
| ✅112 | 能量循环替代体力 |
|
||
|
||
### 战斗系统
|
||
| 决策 | 主题 |
|
||
|------|------|
|
||
| ✅1 | ATB 即时制 |
|
||
| ✅165 | 降维护佑 PVP 系数 |
|
||
```
|
||
|
||
---
|
||
|
||
## 5. 文档状态标记
|
||
|
||
| 标记 | 含义 |
|
||
|------|------|
|
||
| ✅ | 已确认定稿 |
|
||
| 🔄 | 审阅中/待更新 |
|
||
| ❓ | 有待确认事项 |
|
||
| ❌ | 已废弃/被取代 |
|
||
|
||
---
|
||
|
||
## 6. 版本记录
|
||
|
||
- **v1.0**（2026-07-08）: 初始版本，覆盖索引维护、文档导航、关键词索引、决策速查
|
