# 文档索引

## 当前最短阅读路径

1. `README.md`
   - 仓库入口与常用脚本
2. `docs/current/context-reset-brief.md`
   - 当前状态的最短摘要
3. `docs/openclaw/README.md`
   - OpenClaw 集成文档导航
4. `docs/openclaw/openclaw-handoff.md`
   - OpenClaw 接手总览
5. `docs/openclaw/openclaw-orchestration-flow.md`
   - OpenClaw 正式编排手册
6. `docs/design/README.md`
   - 设计文档导航，区分当前有效设计与背景草案
7. `plans/README.md`
   - 规划文档导航
8. `TODO.md`
   - 当前任务状态

## 目录结构

- `docs/README.md`
  - 文档总索引
- `docs/current/`
  - 当前状态、收束入口、阶段导航
- `docs/design/`
  - 当前实现的设计文档
- `docs/design/README.md`
  - 设计文档导航
- `docs/openclaw/`
  - OpenClaw 集成文档、对象规范与历史归档
- `docs/notes/`
  - 较上层的方案笔记与非最终设计
- `docs/notes/README.md`
  - notes 导航
- `docs/archive/`
  - 历史归档，不作为最新事实来源

## 按主题阅读

### 1. 当前状态与导航

- `README.md`
  - 仓库入口与脚本运行方式
- `TODO.md`
  - 当前优先级、已完成项、下一阶段任务
- `docs/current/context-reset-brief.md`
  - 当前阶段状态的最短摘要
- `docs/README.md`
  - 文档索引与阅读顺序
- `plans/README.md`
  - 规划文档导航

### 2. 当前实现设计

- `docs/design/README.md`
  - 设计文档导航与状态说明
- `docs/design/summary-mcp-service-design.md`
  - 早期 content-extract MCP 设计草案，现主要保留背景参考价值
- `docs/design/summary-core-interface-design.md`
  - 摘要/提取内核的接口抽象
- `docs/design/source-schema-design.md`
  - `source`、`item`、`document` 三层 schema
- `docs/design/summary-loop-explained.md`
  - 提取 JSON -> LLM 摘要 JSON -> 校验 的闭环说明
- `docs/design/filter-rule-engine-design.md`
  - 第一版规则过滤引擎设计与落地位置
- `docs/design/filter-rule-engine-usage.md`
  - 规则配置、调用方式与结果解读
- `docs/design/daily-keyword-index-design.md`
  - 日报级词元库与周期性词元清洗 skill 设计
- `scripts/apply_term_suggestions.py`
  - 人工确认后将建议写回 watchlist / change log 的脚本入口（见 `README.md` 用法）
- `docs/design/markdown-sink-design.md`
  - 第一版 Markdown sink 设计与落地位置

### 3. OpenClaw 与下游设计

- `docs/openclaw/README.md`
  - OpenClaw 相关文档导航与归档边界
- `docs/openclaw/openclaw-handoff.md`
  - OpenClaw 接手所需的运行说明、工具入口与已知限制
- `docs/openclaw/openclaw-orchestration-flow.md`
  - OpenClaw 编排层的正式运行手册
- `docs/openclaw/openclaw-candidate-input-field-spec.md`
  - 提供给 OpenClaw 的单篇结构化输入字段说明
- `docs/openclaw/openclaw-delivery-payload-spec.md`
  - 提供给 OpenClaw 的批量投递 envelope 说明
- `docs/openclaw/article-candidate-daily-digest-schema.md`
  - `ArticleCandidateRecord`、`OpenClawCandidateInput` 与 `DailyDigest` 的字段设计与对象关系

### 4. 方案笔记

- `docs/notes/README.md`
  - notes 导航与使用边界
- `docs/notes/reading-pipeline-design-notes.md`
  - 整体阅读流、规则、sink、push 的方案笔记

### 5. 历史归档

- `docs/archive/content-extract-mcp-mvp-archive.md`
  - MVP 阶段归档，部分状态已被后续进展覆盖
- `docs/openclaw/archive/README.md`
  - OpenClaw 历史文档归档说明
- `docs/openclaw/archive/formalization-summary-2026-04-07.md`
  - 第一阶段正式化总结
- `docs/openclaw/archive/openclaw-daily-digest-refactor.md`
  - 早期日报聚合改造背景
- `docs/openclaw/archive/digest-optimization-summary.md`
  - 早期 digest 优化总结
- `docs/openclaw/archive/p1-status-reconciliation-plan-2026-04-14.md`
  - `resume` / 状态收敛问题的阶段修复计划与回填

## 维护原则

- `docs/current/context-reset-brief.md` 记录当前最新状态
- `TODO.md` 记录任务优先级与下一步
- `plans/README.md` 负责规划文档分层与导航
- `docs/design/README.md` 负责设计文档分层与导航
- `outputs/README.md` 记录当前输出目录约定
- `docs/archive/content-extract-mcp-mvp-archive.md` 只当历史快照，不再作为最新事实来源
- 新增阶段性进展，优先更新 `README.md`、`TODO.md`、`docs/current/context-reset-brief.md`