| name | project-indexer |
| description | 为软件项目生成全面的索引文档,链接任务、文档和代码,提供项目导航。在创建项目文档索引、组织多阶段开发、管理复杂分析或建立项目知识库时使用。 |
项目索引器
生成全面的项目索引,链接任务、文档和代码,为多阶段软件项目提供导航。
使用场景
- 创建分析报告的索引
- 组织多阶段项目文档
- 链接 Issues 到实施任务
- 建立项目知识库
- 创建可读的项目导航
- 管理复杂的技术调研
索引类型
1. 分析报告索引
多轮分析的结构:
# 项目分析索引
## 执行摘要
- 项目概述
- 关键发现摘要
- 风险评估
## 文档索引
### 第一轮:需求分析
- 文档 1(路径、行数、关键发现)
- 文档 2(路径、行数、关键发现)
### 第二轮:架构设计
...
## 严重问题摘要
| ID | 问题 | 来源 | 严重程度 |
## 快速参考
| 想了解 X | 阅读文档 Y |
## 下一步
- 立即行动
- 前置条件
- 风险缓解
2. 任务追踪索引
项目实施的结构:
## 📋 任务索引
### 父任务
- Epic: #XX
- 任务索引: #YY
### 实施阶段
- [ ] 阶段 1:基础 → #ZZ
- [ ] 阶段 2:核心 → #AA
### 参考文档
| 类型 | 路径 |
|------|------|
| 分析 | `docs/analysis/...` |
| 设计 | `docs/design/...` |
### 关键决策
| 决策 | 状态 | 文档 |
索引生成流程
1. 收集来源
识别所有项目资产:
- 分析文档
- 设计文档
- 代码文档
- 任务/Issues
- 决策记录
2. 提取元数据
对于每个文档:
3. 创建交叉引用
构建关系矩阵:
- 文档 → 主题
- 任务 → 相关文档
- 问题 → 来源
4. 生成导航
创建快速查找表:
- "如果你想了解 X,阅读 Y"
- 决策日志
- 下一步行动
设计原则
1. 仅引用路径
正确:仅引用文档路径
参见:`docs/design/architecture.md`
错误:复制内容
架构使用微服务模式...
2. 解耦内容
索引与内容独立更新:
3. 任务列表作计划
任务列表应该:
任务层级
Epic (#61)
└── 任务索引 (#62)
├── 阶段 1 (#63)
├── 阶段 2 (#64)
└── 阶段 3 (#65)
└── 实施 PR
参考文档
详见 references/index-template.md 获取完整模板。