project-wiki

# Project Wiki Skill

为 Vibe Coding 项目（人类描述意图，Agent 写代码）生成和维护结构化 wiki。wiki 是 Agent 的输入物料，直接决定输出质量。

---

## 执行流程

### 初始化（wiki/ 不存在或为空）

1. **扫描** `wiki/` 目录，列出已有文件
2. **对照必要文件清单**（见下方"文件体系"），识别缺失项
3. **与用户确认**将要创建的文件列表
4. **生成骨架**：从本 Skill 的 `assets/` 目录读取对应模板，填入用户上下文（不确定的部分留 `<!-- TODO: ... -->` 占位）
5. **更新导航**：如已有 `01-project-roadmap.md`，追加新阶段索引行
6. **标记新鲜度**：每个生成的文件头部加 `<!-- Last verified: YYYY-MM-DD | Current stage: X -->`
7. **注入维护规则**：将下方"日常维护规则"章节的内容追加到项目 `CLAUDE.md`（已有则合并差异，不替换整个文件）。这一步不能跳过——wiki 的日常同步依赖这些规则写入 CLAUDE.md

### 重构 / 更新（wiki/ 已有文件）

1. **扫描** `wiki/` 下所有文件和子目录，检查编号方案（紧凑 or 展开）、新鲜度标记
2. **诊断**：
   - 缺编号前缀？信息重叠？已完结 stage 未归档？内容与代码不一致？
   - **膨胀检测**：stage 文件超 300 行、其他文件超 500 行 → 建议拆分
   - **散落文件**：wiki 根目录中不属于任何编号区段的文件（如 `ui-audit-*.md`）→ 建议归入合适的子目录（`reviews/`）或运维区段（`8x`）
   - **命名一致性**：`specs/` 下混有 `task-spec-*` 和 `spec-*` → 不强制迁移，但新建一律用 `spec-*`；spec 散落在 wiki 根目录 → 建议迁入 `specs/`
   - **自定义子目录**：识别 `plugins/`、`images/` 等项目特有目录，标记为已知自定义目录，不报为异常
3. **生成改动清单**（重命名 / 合并 / 拆分 / 归档 / 迁移 / 更新内容），与用户确认
4. **执行改动**
5. **验证一致性**：文件间引用链接有效、roadmap 索引与实际文件对应
6. **检查维护规则**：确认项目 `CLAUDE.md` 中已有 wiki 维护规则，缺失则追加（不替换整个文件）

---

## 文件体系

### 编号体系

编号按**"战略 → 架构 → 规范 → 阶段 → 运维 → 日志"**分层。根据项目规模选择紧凑或展开方案：

**紧凑方案**（≤5 个 stage，适合多数项目）：

```
wiki/
├── 00-product-proposal.md
├── 01-project-roadmap.md
├── 02-system-architecture.md       # 紧凑方案用 0x 统一放战略+架构
├── 03-design-principle.md
├── 04-api-reference.md
├── 1x  阶段 Stages
│   ├── 10-stage-a.md
│   ├── 11-stage-b.md ...
├── 80-known-pitfalls.md
├── 85-backlog.md
├── 90-changelog.md
├── specs/ · refs/ · reviews/ · archive/
```

**展开方案**（>5 个 stage 或需要更多分层空间）：

```
wiki/
├── 0x  战略 Strategy       — 全局视角
│   ├── 00-product-proposal.md
│   ├── 01-project-roadmap.md
│   ├── 02-business-model.md
│   └── 03-technical-pillars.md
├── 2x  架构 Architecture   — 系统是怎么建的
│   ├── 20-system-architecture.md
│   └── 21-design-principle.md
├── 3x  接口 API
│   └── 30-api-reference.md
├── 4x  规范 Conventions
│   ├── 40-conventions.md
│   └── 41-dev-pitfall-patterns.md
├── 6x  阶段 Stages         — 各阶段详细 spec
│   ├── 60-stage-a.md ...
├── 8x  运维 Operations
│   ├── 80-known-pitfalls.md
│   ├── 81-postmortem-*.md
│   ├── 84-design-exploration.md
│   └── 85-backlog.md
├── 9x  日志 Log
│   └── 90-changelog.md
├── specs/ · refs/ · reviews/ · archive/
```

**选择规则：** 初始化时问用户，或根据已有文件自动识别。两种方案的文件内容和模板完全相同，只是编号前缀不同。关键是**一个项目内保持一致**，不混用。

**项目特有子目录：** wiki 可能出现 skill 未预设的子目录（如 `plugins/`、`images/`），这是正常的项目演化。扫描时将它们识别为"自定义目录"，不报为异常，不强制重命名。

### 核心模型：Why / What / How / Look × 全局 / 阶段

| | 全局（稳定，新阶段才改） | 阶段（增量更新） |
|---|---|---|
| **Why** | `product-proposal` | — |
| **What** | `project-roadmap` — 功能索引 | `stage-X` — 设计决策 |
| **How** | `system-architecture` — 架构 + 类型 | `stage-X` — API、数据模型、受影响文件 |
| **Look** | `design-principle` — 视觉语言 | — |

**关键规则：** stage 文件同时包含 What 和 How。一个功能的设计决策、API 契约、数据模型放在一个文件里。全局文件只做索引和导航，不重复 stage 的细节。

### 规划层级

| | Roadmap (`01`) | Backlog (`85`) |
|---|---|---|
| 时间跨度 | 月 / 季度级 | 周 / 迭代级 |
| 粒度 | 方向、里程碑、大功能 | 具体任务、bug、小需求 |
| 回答 | 我们要去哪里？ | 下一步做什么？ |

**使用时机：** 开始任务前先对照 roadmap 确认阶段匹配，再从 backlog 取具体任务执行。任务完成后在 backlog 打勾，发版时从已完成条目整理写入 changelog。

### 必要文件（第一梯队）

| 编号 | 文件 | 写给谁 | 核心内容 |
|------|------|--------|---------|
| 00 | `product-proposal.md` | Agent + 你 | 产品愿景、产品定位、**不做什么**、目标用户、功能矩阵、路线图叙事 |
| 01 | `project-roadmap.md` | Agent + 你 | 阶段总览表、全量功能索引（功能×状态×stage链接）、里程碑 |
| 20 | `system-architecture.md` | Agent | 技术栈、目录结构、数据流、核心类型、环境变量（300-500 行） |

### 按需文件（第二梯队）

| 编号 | 文件 | 何时需要 |
|------|------|---------|
| 02 | `business-model.md` | 有商业化/变现需求时 |
| 03 | `technical-pillars.md` | 有明确的技术壁垒或研究方向时 |
| 21 | `design-principle.md` | 有自定义视觉语言时（非默认 UI 库样式） |
| 30 | `api-reference.md` | API 超过 5 条路由，或 stage 归档后仍需查 API 细节 |
| 40 | `conventions.md` | 有明确的编码偏好/约束（库选择、命名、错误处理模式等） |
| 41 | `dev-pitfall-patterns.md` | 踩坑积累到需要系统性记录时 |
| 6X | `stage-X.md` | 功能复杂度超过一句话能说清（150-300 行） |
| — | `specs/spec-{name}.md` | 小功能 / 改进点的 spec；完成后移入 `archive/specs/` |
| — | `refs/ref-{topic}.md` | 外部机制调研、技术选型对比、第三方 API 文档摘要 |
| — | `reviews/review-{date}-{subject}.md` | 代码审查、spec 评审、设计评审的结论与 action items |
| 80 | `known-pitfalls.md` | 踩坑即记，不等阶段结束 |
| 81 | `postmortem-*.md` | 多个 bug 互相关联、暴露系统性问题时（单点问题用 pitfalls，系统性问题用 postmortem） |
| 84 | `design-exploration.md` | 有 UI 设计探索、原型记录等创意过程产物时 |
| 85 | `backlog.md` | 有临时 bug、技术债、改进想法需要追踪时 |
| 90 | `changelog.md` | 发版时从 `85-backlog.md` 已完成条目整理写入，面向用户描述变更，不记内部实现细节 |

> 每个文件的详细说明和"为什么需要"的论证见 `references/file-reference.md`。

### Stage 文件生命周期

阶段完全交付且后续阶段不再引用其 API/数据模型时 → 移入 `wiki/archive/`，`01-project-roadmap.md` 中保留索引行并标注 `[archived]`。

**归档判断标准：** 同时满足以下两条才归档：① 该 stage 已完结超过一个阶段；② 当前及未来 stage 文件中无对它的跨引用。不确定时保留，宁可冗余不要断链。

### 子目录管理

四个子目录各有独立的命名规范、生命周期和归档规则。

#### specs/ — 任务规格

活跃的功能 spec，是比 stage 文件更细粒度的任务描述。

| 项目 | 规则 |
|------|------|
| 命名 | `spec-{feature-name}.md`（推荐）。历史遗留的 `task-spec-*.md` 也可接受，不强制迁移 |
| 位置 | 放在 `wiki/specs/` 下。发现散落在 wiki 根目录的 spec → 重构时提示迁入 `specs/` |
| 创建时机 | 功能复杂度介于"backlog 一行"和"stage 文件一整章"之间 |
| 内容 | 背景、目标、边界、验收标准、受影响文件列表 |
| 归档 | 实现完成 → 移入 `archive/specs/`，backlog 对应项打勾 |
| 状态追踪 | **位置即状态**：在 `specs/` = 活跃，在 `archive/specs/` = 完成。无需维护 Status 头标记 |

#### refs/ — 参考资料

外部知识的内部镜像——第三方 API 行为、协议格式、技术选型调研等。

| 项目 | 规则 |
|------|------|
| 命名 | 描述性文件名即可（如 `git-sync-workflow.md`、`npx-skills-mechanism.md`）。`ref-` 前缀可选 |
| 创建时机 | 外部知识在 2+ 个文件/对话中被重复查阅 |
| 内容 | 机制说明、关键 API 摘要、与本项目的集成点、踩坑备注 |
| 归档 | 不主动归档；集成方案废弃时标记 `<!-- Deprecated: YYYY-MM-DD | Reason -->` |
| 引用 | stage/spec 中通过 `→ 详见 [refs/xxx.md](./refs/xxx.md)` 链接，不复制内容 |

#### reviews/ — 评审记录

代码审查、spec 评审、设计评审的结论存档。

| 项目 | 规则 |
|------|------|
| 命名 | `review-{YYYY-MM-DD}-{subject}.md`（如 `review-2026-03-18-auth-spec.md`） |
| 创建时机 | spec 评审完成后、重大代码变更 review 后、设计方案评审后 |
| 内容 | 评审对象（链接到 spec/PR）、结论（通过/修改/拒绝）、action items、遗留讨论点 |
| 归档 | action items 全部完成 → 移入 `archive/reviews/` |
| 联动 | 创建 review 后，在对应 spec 头部追加 `<!-- Reviewed: YYYY-MM-DD → reviews/review-xxx.md -->` |

#### archive/ — 归档目录

已完结文档的长期存储。保留完整历史以便溯源，但不污染活跃目录。

```
archive/
├── specs/      — 已完成的 spec（保留原