Просмотр исходного кода

docs: 精简README并拆分模块文档

lingfengQAQ 3 месяцев назад
Родитель
Сommit
f545f71095
7 измененных файлов с 359 добавлено и 842 удалено
  1. 30 842
      README.md
  2. 15 0
      docs/README.md
  3. 60 0
      docs/architecture.md
  4. 72 0
      docs/commands.md
  5. 47 0
      docs/genres.md
  6. 99 0
      docs/operations.md
  7. 36 0
      docs/rag-and-config.md

+ 30 - 842
README.md

@@ -4,223 +4,55 @@
 [![Python](https://img.shields.io/badge/Python-3.10+-blue.svg)](https://www.python.org/)
 [![Claude Code](https://img.shields.io/badge/Claude%20Code-Compatible-purple.svg)](https://claude.ai/claude-code)
 
-基于 Claude Code 的长篇网文辅助创作系统,解决 AI 写作中的「遗忘」和「幻觉」问题,支持 **200 万字量级** 连载创作。
+## 项目简单介绍
 
----
+`Webnovel Writer` 是基于 Claude Code 的长篇网文创作系统,目标是降低 AI 写作中的“遗忘”和“幻觉”,支持长周期连载创作。
 
-## 目录
+详细文档已拆分到 `docs/`:
 
-- [核心理念](#核心理念)
-- [系统架构](#系统架构)
-- [快速开始](#快速开始)
-- [命令详解](#命令详解)
-- [双 Agent 架构](#双-agent-架构)
-- [六维并行审查](#六维并行审查)
-- [RAG 检索系统](#rag-检索系统)
-- [题材模板](#题材模板)
-- [配置说明](#配置说明)
-- [项目结构](#项目结构)
-- [故障恢复](#故障恢复)
-- [版本历史(精简)](#版本历史精简)
-- [Star 趋势](#star-趋势)
-- [License](#license)
-
----
-
-## 核心理念
-
-### 防幻觉三定律
-
-| 定律 | 说明 | 执行方式 |
-|------|------|---------|
-| **大纲即法律** | 遵循大纲,不擅自发挥 | Context Agent 强制加载章节大纲 |
-| **设定即物理** | 遵守设定,不自相矛盾 | Consistency Checker 实时校验 |
-| **发明需识别** | 新实体必须入库管理 | Data Agent 自动提取并消歧 |
-
-### 创意约束系统 (v5.4.2 引入)
-
-| 机制 | 说明 |
-|------|------|
-| **三轴混搭** | 题材基础 + 规则限制 + 角色矛盾(至少2/3非默认) |
-| **反套路触发器** | 每项目必选至少1条反常规规则 |
-| **镜像对抗** | 反派与主角共享欲望/缺陷,采取相反道路 |
-| **约束继承** | 大纲规划时继承创意约束,每N章触发 |
-
-### 追读力机制 (v5.3 引入)
-
-**约束分层系统**:
-
-| 层级 | 说明 | 处理方式 |
-|------|------|---------|
-| **Hard Invariants** | 不可违反的硬约束 | 必须修复,无法跳过 |
-| **Soft Guidance** | 可违反的软建议 | 可通过 Override Contract 跳过 |
-
-**Hard Invariants (4条)**:
-- HARD-001: 可读性底线 - 读者必须能理解发生了什么
-- HARD-002: 承诺违背 - 上章钩子必须有回应
-- HARD-003: 节奏灾难 - 不可连续N章无推进
-- HARD-004: 冲突真空 - 每章必须有问题/目标/代价
-
-**Override Contract 机制**:
-- 违反软建议时需记录理由和偿还计划
-- 每个 Override 产生债务,利息为可选机制(默认不自动计算)
-- 逾期债务会影响后续章节评分(仅在开启追踪时生效)
-
-### Strand Weave 节奏系统
-
-三线交织的叙事节奏控制:
-
-| Strand | 含义 | 理想占比 | 说明 |
-|--------|------|---------|------|
-| **Quest** | 主线剧情 | 60% | 推动核心冲突 |
-| **Fire** | 感情线 | 20% | 人物关系发展 |
-| **Constellation** | 世界观扩展 | 20% | 背景/势力/设定 |
-
-**节奏红线**:
-- Quest 连续不超过 5 章
-- Fire 断档不超过 10 章
-- Constellation 断档不超过 15 章
-- 每章声明 1 个主导 Strand(可交织其他 Strand)
-
----
-
-## 系统架构
-
-```
-┌─────────────────────────────────────────────────────────────┐
-│                      Claude Code                             │
-├─────────────────────────────────────────────────────────────┤
-│  Skills (7个)                                                │
-│  ┌──────────┐ ┌──────────┐ ┌──────────┐                     │
-│  │  init    │ │   plan   │ │  write   │ │  learn   │        │
-│  └──────────┘ └──────────┘ └──────────┘ └──────────┘        │
-│  ┌──────────┐ ┌──────────┐ ┌──────────┐                     │
-│  │  review  │ │  query   │ │  resume  │                     │
-│  └──────────┘ └──────────┘ └──────────┘                     │
-├─────────────────────────────────────────────────────────────┤
-│  Agents (8个)                                                │
-│  ┌─────────────────┐  ┌─────────────────┐                   │
-│  │  Context Agent  │  │   Data Agent    │                   │
-│  │     (读取)      │  │     (写入)      │                   │
-│  └─────────────────┘  └─────────────────┘                   │
-│  ┌───────┐ ┌───────┐ ┌───────┐ ┌───────┐ ┌───────┐ ┌───────┐│
-│  │ 爽点  │ │ 一致性│ │ 节奏  │ │  OOC  │ │ 连贯性│ │追读力 ││
-│  └───────┘ └───────┘ └───────┘ └───────┘ └───────┘ └───────┘│
-├─────────────────────────────────────────────────────────────┤
-│  Data Layer                                                  │
-│  ┌──────────┐ ┌──────────┐ ┌──────────┐                     │
-│  │state.json│ │ index.db │ │vectors.db│                     │
-│  │ (状态)   │ │ (索引)   │ │ (向量)   │                     │
-│  └──────────┘ └──────────┘ └──────────┘                     │
-└─────────────────────────────────────────────────────────────┘
-```
-
----
+- 架构与模块:`docs/architecture.md`
+- 命令详解:`docs/commands.md`
+- RAG 与配置:`docs/rag-and-config.md`
+- 题材模板:`docs/genres.md`
+- 运维与恢复:`docs/operations.md`
+- 文档导航:`docs/README.md`
 
 ## 快速开始
 
-### 前置要求
-
-| 依赖 | 版本要求 | 说明 |
-|------|---------|------|
-| Python | >= 3.10 | 数据处理脚本运行环境 |
-| Claude Code | 最新版 | Anthropic 官方 CLI 工具 |
-| Git | 任意版本 | 版本控制和章节备份 |
-
-### 1. 通过 Marketplace 安装插件(推荐)
+### 1) 安装插件(官方 Marketplace)
 
 ```bash
-# 添加 GitHub 仓库为 marketplace(用户级,全局可用)
 claude plugin marketplace add lingfengQAQ/webnovel-writer --scope user
-
-# 安装插件(指定 marketplace,避免重名冲突)
 claude plugin install webnovel-writer@webnovel-writer-marketplace --scope user
-
-# 安装 Python 依赖(必做)
-python -m pip install -r https://raw.githubusercontent.com/lingfengQAQ/webnovel-writer/HEAD/webnovel-writer/scripts/requirements.txt
-
-# 可选:确认安装状态
-claude plugin list
 ```
 
-> 若你只想当前项目生效:在项目目录执行,并把 `--scope user` 改为 `--scope project`。
+> 仅当前项目生效时,将 `--scope user` 改为 `--scope project`。
 
-PowerShell 同样可用(命令一致):
+### 2) 安装 Python 依赖
 
-```powershell
-claude plugin marketplace add lingfengQAQ/webnovel-writer --scope user
-claude plugin install webnovel-writer@webnovel-writer-marketplace --scope user
+```bash
 python -m pip install -r https://raw.githubusercontent.com/lingfengQAQ/webnovel-writer/HEAD/webnovel-writer/scripts/requirements.txt
 ```
 
-**官方插件机制说明**:
-- Marketplace 清单位于仓库根目录 `.claude-plugin/marketplace.json`。
-- 插件清单位于 `webnovel-writer/.claude-plugin/plugin.json`。
-- 运行时 Skills/Agents 统一通过 `CLAUDE_PLUGIN_ROOT` 定位资源,不再依赖旧的 `.claude/scripts` 路径探测。
+### 3) 初始化小说项目
 
-推荐:统一使用 `webnovel.py` 作为 CLI 入口,避免 `PYTHONPATH` / `cd` / 参数顺序导致的报错。
-
-**Python 依赖说明**:
-
-| 包名 | 用途 |
-|------|------|
-| aiohttp | 异步 HTTP 客户端,用于 Embedding/Reranker API 调用 |
-| filelock | 文件锁,防止 state.json 并发写入冲突 |
-| pydantic | Schema 校验和数据验证 |
-| pytest | 单元测试(可选) |
-| pytest-cov | 覆盖率统计(可选) |
-
-### 2. 初始化项目
+在 Claude Code 中执行:
 
 ```bash
-# 在 Claude Code 中执行
 /webnovel-init
 ```
 
-系统会引导你完成:
-- Deep 初始化信息采集(完整建模)
-- 选择题材类型
-- 设计金手指/核心卖点
-- 生成项目结构和设定模板
-- 自动写入当前项目绑定(workspace pointer + 全局 registry)
-
-> 说明:如果你只使用 `/webnovel-*` 命令,**不需要手动解析 PROJECT_ROOT**。
-> 只有在你要手动执行 Python CLI 时,才需要下面这一步。
+说明:`/webnovel-init` 会在当前 Workspace 下按书名创建 `PROJECT_ROOT`(子目录),并在 `workspace/.claude/.webnovel-current-project` 写入当前项目指针。
 
-### 3. (可选)手动 CLI 时解析项目根
+### 4) 配置 RAG 环境(必做)
 
-```bash
-export WORKSPACE_ROOT="${CLAUDE_PROJECT_DIR:-$PWD}"
-
-if [ -z "${CLAUDE_PLUGIN_ROOT}" ] || [ ! -d "${CLAUDE_PLUGIN_ROOT}/scripts" ]; then
-  echo "ERROR: 未设置 CLAUDE_PLUGIN_ROOT 或缺少目录: ${CLAUDE_PLUGIN_ROOT}/scripts" >&2
-  exit 1
-fi
-export SCRIPTS_DIR="${CLAUDE_PLUGIN_ROOT}/scripts"
-
-# 把“工作区根”解析为“真实书项目根”
-export PROJECT_ROOT="$(python "${SCRIPTS_DIR}/webnovel.py" --project-root "${WORKSPACE_ROOT}" where)"
-echo "${PROJECT_ROOT}"
-```
-
-### 4. 配置 RAG 环境(必做)
+进入初始化后的书项目根目录,创建 `.env`:
 
 ```bash
-# 进入书项目根目录
-cd "${PROJECT_ROOT}"
-
-# 复制模板并填写 API Key(/webnovel-init 会生成 .env.example)
 cp .env.example .env
 ```
 
-PowerShell 可用:
-
-```powershell
-Set-Location $env:PROJECT_ROOT
-Copy-Item .env.example .env -Force
-```
-
-`.env` 至少配置以下字段(建议全部配置):
+最小配置示例:
 
 ```bash
 EMBED_BASE_URL=https://api-inference.modelscope.cn/v1
@@ -232,684 +64,40 @@ RERANK_MODEL=jina-reranker-v3
 RERANK_API_KEY=your_rerank_api_key
 ```
 
-说明:
-- 若未配置 Embedding Key,RAG 语义检索会降级为 BM25。
-- 支持用户级全局配置文件:`~/.claude/webnovel-writer/.env`(项目级 `.env` 优先)。
-
-### 5. 规划大纲
+### 5) 开始使用
 
 ```bash
-# 规划第1卷大纲
 /webnovel-plan 1
-```
-
-### 6. 开始创作
-
-```bash
-# 创作第1章
 /webnovel-write 1
-```
-
-### 7. 质量审查(可选)
-
-```bash
-# 审查第1-5章
 /webnovel-review 1-5
 ```
 
----
-
-## 命令详解
-
-### /webnovel-init - 项目初始化
-
-初始化项目结构、题材模板、世界观设定。
+## 更新简介
 
-**初始化模式**:
-
-当前默认执行 **Deep 模式**(完整初始化流程,约 30-45 分钟)。
-
-**产出文件**:
-- `.webnovel/state.json` - 项目状态
-- `设定集/` - 世界观、力量体系、角色卡
-- `大纲/总纲.md` - 故事框架
-
----
-
-### /webnovel-plan [卷号] - 大纲规划
-
-制定详细的卷大纲,规划爽点分布和节奏。
-
-```bash
-/webnovel-plan 1        # 规划第1卷
-/webnovel-plan 2-3      # 规划第2-3卷
-```
-
-**产出**:
-- `大纲/第N卷-节拍表.md`(Promise/Catalyst/危机递增/中段反转/最低谷/大兑现+新钩子)
-- `大纲/第N卷-详细大纲.md`
-- 每章:目标/阻力/代价/本章变化/章末未闭合问题/爽点/Strand/钩子/反派层级/关键实体
-- 新增实体预告
-
----
-
-### /webnovel-write [章号] - 章节创作
-
-采用双 Agent 架构的自动化章节创作。
-
-```bash
-/webnovel-write 1       # 创作第1章
-/webnovel-write 45      # 创作第45章
-```
-
-**创作流程 (v5.4.1)**:
-
-```
-Step 1: Context Agent 搜集上下文 → 创作任务书(含追读力策略)
-        ↓
-Step 1.5: 章节设计(开头/钩子/爽点/微兑现规划)
-        ↓
-Step 2A: 生成粗稿(3000-5000字)
-        ↓
-Step 2B: 风格适配器(网文化改写)
-        ↓
-Step 3: 默认 4 Agent 审查(关键章扩展到 6)+ 保存审查指标(review_metrics)
-        ↓
-Step 4: 网文化润色
-        ↓
-Step 5: Data Agent 提取实体/更新索引/记录追读力元数据
-        ↓
-Step 6: Git 自动提交备份
-```
-
-**写作模式**:
-- **标准模式**: 完整执行 Step 1-6
-- **快速模式** (`--fast`): 跳过 Step 2B
-- **极简模式** (`--minimal`): 跳过 Step 2B + 仅 3 个核心审查(无追读力数据)
-
-**产出**:
-- `正文/第N章-标题.md`
-- `.webnovel/summaries/ch{NNNN}.md` - 章节摘要(独立存储)
-
----
-
-### /webnovel-review [范围] - 质量审查
-
-对已完成章节进行多维度深度扫描。
-
-```bash
-/webnovel-review 1-5    # 审查第1-5章
-/webnovel-review 45     # 审查单章
-```
-
-**审查维度**:
-- 爽点密度与质量
-- 设定一致性
-- 节奏 Strand 分布
-- 人物 OOC 检测
-- 场景连贯性
-
-**产出**:
-- `审查报告/第{start}-{end}章审查报告.md`(审查报告正文)
-- `.webnovel/index.db`:写入 `review_metrics`(用于趋势统计与写作建议)
-- `.webnovel/state.json`:追加 `review_checkpoints`(记录已审查区间与报告路径)
-
----
-
-### /webnovel-query [关键词] - 信息查询
-
-查询角色、境界、伏笔、系统状态等运行时信息。
-
-```bash
-/webnovel-query 萧炎         # 查询角色信息
-/webnovel-query 伏笔         # 查看待回收伏笔
-/webnovel-query 紧急         # 查看紧急伏笔
-```
-
----
-
-### /webnovel-resume - 任务恢复
-
-在任务中断时检测中断点并提供安全恢复选项。
-
-```bash
-/webnovel-resume
-```
-
-**恢复选项**:
-- 从断点继续
-- 回滚到上一个安全点
-- 重新开始当前步骤
-
----
-
-## 双 Agent 架构
-
-### Context Agent(创作任务书工程师)
-
-**职责**:为写作准备精准的创作任务书(人话版)
-
-**工作流程**:
-1. 读取本章大纲,分析需要什么信息
-2. 从 `state.json` 获取主角状态快照
-3. 从 `state.json → chapter_meta` 读取上章钩子/模式
-4. 调用 `index.db` 查询相关实体和别名
-5. 调用 RAG 语义检索相关历史场景
-6. 搜索设定集获取相关设定
-7. 评估伏笔紧急度
-8. 推断角色动机/情绪
-9. 组装**创作任务书**
-
-**输出结构(7个板块)**:
-1. **本章核心任务**(冲突一句话、必须完成、绝对不能)
-2. **接住上章**(上章钩子、读者期待、开头建议)
-3. **出场角色**(状态、动机、情绪底色、说话风格、红线)
-4. **场景与力量约束**(地点、可用能力、禁用能力)
-5. **风格指导**(本章类型、参考样本、最近模式、本章建议)
-6. **连续性与伏笔**(时间/位置/情绪连贯;必须处理/可选伏笔)
-7. **追读力策略**(钩子类型/强度、微兑现建议、差异化提示;有债务时附带说明)
-
----
-
-### Data Agent(数据链工程师)
-
-**职责**:从正文中语义化提取实体并同步状态
-
-**工作流程**:
-1. **实体提取**:识别角色/地点/物品/招式/势力
-2. **实体消歧**:
-   - 高置信度 (>0.8):自动采用
-   - 中置信度 (0.5-0.8):采用但记录 warning
-   - 低置信度 (<0.5):标记待人工确认
-3. **写入存储**:更新 `index.db` + `state.json`
-4. **场景切片**:按地点/时间/视角切分场景
-5. **向量嵌入**:调用 RAG 存入向量库
-6. **记录章节元数据**:钩子/模式/结束状态写入 `chapter_meta`
-7. **生成章节摘要**:写入 `.webnovel/summaries/ch{NNNN}.md`
-
-**输出格式**:
-```json
-{
-  "entities_extracted": [...],
-  "state_changes": [...],
-  "scenes": [...],
-  "warnings": [...],
-  "stats": {
-    "new_entities": 3,
-    "updated_entities": 2,
-    "scenes_created": 4
-  }
-}
-```
-
----
-
-## 六维并行审查
-
-| Checker | 检查内容 | 关键指标 |
-|---------|---------|---------|
-| **High-point Checker** | 爽点密度与质量 | 6种执行模式、滚动窗口评估(30/40/30 仅作参考) |
-| **Consistency Checker** | 战力/地点/时间线 | 设定即物理定律 |
-| **Pacing Checker** | Strand 比例分布 | Quest/Fire/Constellation |
-| **OOC Checker** | 人物言行是否符合人设 | 角色卡片对照 |
-| **Continuity Checker** | 场景转换流畅度 | 伏笔回收情况 |
-| **Reader-pull Checker** | 追读力检查 | 钩子强度、模式重复、读者期待 |
-
-### 爽点八大执行模式 (v5.3)
-
-| 模式 | 模式标识 | 典型触发 |
-|------|---------|---------|
-| 装逼打脸 | Flex & Counter | 嘲讽 → 反转 → 震惊 |
-| 扮猪吃虎 | Underdog Reveal | 示弱 → 暴露 → 碾压 |
-| 越级反杀 | Underdog Victory | 差距 → 策略 → 逆转 |
-| 打脸权威 | Authority Challenge | 权威 → 挑战 → 成功 |
-| 反派翻车 | Villain Downfall | 得意 → 反杀 → 落幕 |
-| 甜蜜超预期 | Sweet Surprise | 期待 → 超预期 → 升华 |
-| **迪化误解** | Misunderstanding Elevation | 随意行为 → 配角脑补 → 读者优越感 |
-| **身份掉马** | Identity Reveal | 伪装 → 揭露 → 周围震惊 |
-
-### 钩子五大类型 (v5.3)
-
-| 类型 | 驱动力 | 示例 |
-|------|--------|------|
-| 危机钩 | 危险逼近,读者担心 | "门外传来脚步声..." |
-| 悬念钩 | 信息缺口,读者好奇 | "他看到信上的名字,脸色骤变" |
-| 情绪钩 | 强情绪触发 | 愤怒/心疼/心动 |
-| 选择钩 | 两难抉择 | "救师父还是救爱人?" |
-| 渴望钩 | 好事将至,读者期待 | "明天就是突破的日子" |
-
-### 微兑现七大类型 (v5.3)
-
-| 类型 | 说明 |
+| 版本 | 说明 |
 |------|------|
-| 信息兑现 | 揭示新信息/线索/真相 |
-| 关系兑现 | 关系推进/确认/变化 |
-| 能力兑现 | 能力提升/新技能展示 |
-| 资源兑现 | 获得物品/资源/财富 |
-| 认可兑现 | 获得认可/面子/地位 |
-| 情绪兑现 | 情绪释放/共鸣 |
-| 线索兑现 | 伏笔回收/推进 |
-
-### 爽点密度基准
-
-- **逐章优先**:有 cool-point 或同等兑现(允许过渡章低密度)
-- **每5章**:≥ 1 combo cool-point (2种以上模式叠加)
-- **每10章**:≥ 1 milestone victory (改变主角地位的阶段性胜利)
-
----
-
-## RAG 检索系统
-
-混合检索系统,支持语义搜索历史场景与关系证据召回。
+| **v5.4.4 (当前)** | 引入官方 Plugin Marketplace 安装机制;统一修复 Skills/Agents/References 的 CLI 调用(`CLAUDE_PLUGIN_ROOT` 单路径,透传命令统一 `--`) |
+| **v5.4.3** | 增强智能 RAG 上下文辅助(`auto/graph_hybrid` 回退 BM25) |
+| **v5.3** | 引入追读力系统(Hook / Cool-point / 微兑现 / 债务追踪) |
 
-### 架构
+## 开源协议
 
-```
-查询 → QueryRouter(auto) → vector / bm25 / hybrid / graph_hybrid
-                         └→ RRF 融合 + Rerank → Top-K 结果
-```
-
-### 配置
-
-| 组件 | 默认提供商 | 默认模型 |
-|-----|----------|---------|
-| Embedding | ModelScope (魔搭) | Qwen/Qwen3-Embedding-8B |
-| Reranker | Jina AI | jina-reranker-v3 |
+本项目使用 `GPL v3` 协议,详见 `LICENSE`。
 
-### 环境变量
-
-```bash
-# .env 文件
-
-# Embedding 配置 (默认使用魔搭)
-EMBED_API_TYPE=openai          # openai 兼容接口
-EMBED_BASE_URL=https://api-inference.modelscope.cn/v1
-EMBED_MODEL=Qwen/Qwen3-Embedding-8B
-EMBED_API_KEY=your-modelscope-token
-
-# Reranker 配置
-RERANK_API_TYPE=openai         # openai (兼容 Jina/Cohere)
-RERANK_BASE_URL=https://api.jina.ai/v1
-RERANK_MODEL=jina-reranker-v3
-RERANK_API_KEY=jina_xxx
-```
-
-### 使用方式
-
-- **Context Agent** 在 Step 0.5 通过 `webnovel.py extract-context` 读取 `rag_assist`
-  - 仅当大纲命中关系/伏笔/地点等触发词时才检索(避免无效召回)
-  - 优先 `auto` 策略(可走 `graph_hybrid`),失败或无 Embedding Key 时自动回退 BM25
-- **Data Agent** 自动将章节场景向量化存入数据库
-- 支持失败重试(指数退避,最多3次)
-
----
-
-## 题材模板
-
-系统内置 **37+** 种热门网文题材模板,支持复合题材组合:
-
-### 玄幻修仙类
-| 题材 | 说明 |
-|------|------|
-| 修仙 | 境界体系、宗门体系、秘境夺宝 |
-| 系统流 | 面板设计、任务系统、奖励机制 |
-| 高武 | 武道境界、战斗设计、世家冲突 |
-| 西幻 | 种族体系、魔法等级、神明信仰 |
-| 无限流 | 副本设计、队友配置、能力体系 |
-| 末世 | 资源法则、异能体系、基地建设 |
-| 科幻 | 科技树、飞船/机甲分类、外星文明 |
-
-### 都市现代类
-| 题材 | 说明 |
-|------|------|
-| 都市异能 | 隐藏实力、家族势力、权贵互动 |
-| 都市日常 | 职场体系、晋升路径、生活流 |
-| 都市脑洞 | 规则入侵、异象探索、系统降临 |
-| 现实题材 | 社会问题、人物成长、现实主义 |
-| 电竞 | 联赛升级、战术博弈、赛场逆袭 |
-| 直播文 | 平台流量、舆论反转、商业变现 |
-
-### 言情类
-| 题材 | 说明 |
-|------|------|
-| 古言 | 宫廷/江湖、身份反转、虐恋情深 |
-| 宫斗宅斗 | 后宫等级、斗争手段、规则禁忌 |
-| 青春甜宠 | 甜度节奏、互动类型、冲突设计 |
-| 豪门总裁 | 豪门等级、契约设计、身份反转 |
-| 职场婚恋 | 职场博弈、晋升逆袭、行业精英 |
-| 民国言情 | 豪门恩怨、乱世佳人、谍影情深 |
-| 幻想言情 | 仙侠言情、种族禁恋、宿命反转 |
-| 现言脑洞 | 规则恋爱、契约情缘、重生复仇 |
-| 女频悬疑 | 情感悬疑、家庭谜案、关系反转 |
-| 种田 | 势力经营/家长里短、内政建设 |
-| 年代 | 六七十/八九十年代、时代元素 |
-
-### 特殊题材
-| 题材 | 说明 |
-|------|------|
-| 规则怪谈 | 规则推理、恐怖氛围、反杀怪谈 |
-| 悬疑脑洞 | 规则推理、密室逃脱、信息博弈 |
-| 悬疑灵异 | 灵异探险、都市传说、驱魔除灵 |
-| 历史古代 | 争霸权谋、仕途升迁、科技种田 |
-| 历史脑洞 | 历史规则化、穿越改命、因果博弈 |
-| 游戏体育 | 电竞竞技、传统体育、棋牌竞技 |
-| 抗战谍战 | 地下潜伏、情报战、特工行动 |
-| 克苏鲁 | 不可名状、理智代价、规则污染 |
-
-### 复合题材支持 (v5.4.2)
-
-支持"题材A+题材B"组合(最多2个),例如:
-- `都市脑洞+规则怪谈`
-- `修仙+系统流`
-
-**复合规则**:1主1辅(约7:3),主线保持主题材逻辑,副题材只提供规则/钩子/爽点。
-
----
-
-## 配置说明
-
-### 环境变量加载顺序(重要)
-
-RAG 相关环境变量(`EMBED_*` / `RERANK_*`)按以下顺序加载:
-
-1. 进程已设置的环境变量(最高优先级)
-2. 书项目根目录下的 `.env`
-3. 用户级全局:`~/.claude/webnovel-writer/.env`
-
-建议优先把项目专属配置写在 `${PROJECT_ROOT}/.env`,避免多项目串台。
-
-### 核心配置 (`config.py`)
-
-```python
-# API 设置
-embed_concurrency = 64          # 嵌入并发数
-cold_start_timeout = 300        # 冷启动超时(秒)
-normal_timeout = 180            # 正常超时(秒)
-api_max_retries = 3             # 最大重试次数
-api_retry_delay = 1.0           # 重试延迟(秒)
-
-# 节奏红线
-strand_quest_max_consecutive = 5   # Quest 最大连续章数
-strand_fire_max_gap = 10           # Fire 最大断档章数
-
-# 爽点密度
-pacing_words_per_point_excellent = 1000  # 优秀阈值
-pacing_words_per_point_good = 1500       # 良好阈值
-pacing_words_per_point_acceptable = 2000 # 及格阈值
-
-# 实体置信度
-extraction_confidence_high = 0.8   # 高置信度阈值(自动采用)
-extraction_confidence_medium = 0.5 # 中置信度阈值(待确认)
-
-# 上下文窗口
-context_recent_summaries_window = 3   # 最近摘要数量
-context_max_appearing_characters = 10 # 最大出场角色数
-context_max_urgent_foreshadowing = 5  # 最大紧急伏笔数
-
-# 智能 RAG 辅助(Step 0.5)
-context_rag_assist_enabled = True          # 是否启用按需检索
-context_rag_assist_top_k = 4               # 召回条数
-context_rag_assist_min_outline_chars = 40  # 大纲最小触发长度
-context_rag_assist_max_query_chars = 120   # 查询截断长度
-```
-
----
-
-## 文档归类
-
-- 当前基线文档:`README.md`、`CLAUDE.md`、`webnovel-writer/references/*.md`、`webnovel-writer/references/shared/*.md`
-- 历史归档文档:`docs/archive/reports/`
-- 文档状态规则:`docs/doc-lifecycle.md`
-- 本地未跟踪归类:`docs/untracked-classification.md`
-
----
-
-## 项目结构
-
-> Marketplace 安装模式下,插件文件位于 Claude 插件缓存目录(不在项目内)。
-> 下方目录树展示的是“本地拷贝 `webnovel-writer` 到项目内”的形态,便于理解完整结构。
-
-```
-your-novel-project/
-├── webnovel-writer/            # 插件目录
-│   ├── agents/                 # 8 个专职 Agent
-│   │   ├── context-agent.md    # 创作任务书工程师
-│   │   ├── data-agent.md       # 数据链工程师
-│   │   ├── high-point-checker.md
-│   │   ├── consistency-checker.md
-│   │   ├── pacing-checker.md
-│   │   ├── ooc-checker.md
-│   │   ├── continuity-checker.md
-│   │   └── reader-pull-checker.md  # 追读力检查(v5.2新增)
-│   ├── skills/                 # 7 个核心 Skill
-│   │   ├── webnovel-init/
-│   │   ├── webnovel-plan/
-│   │   ├── webnovel-write/
-│   │   ├── webnovel-review/
-│   │   ├── webnovel-query/
-│   │   ├── webnovel-resume/
-│   │   └── webnovel-learn/     # 模式学习(v5.4新增)
-│   ├── scripts/                # Python 脚本
-│   │   ├── data_modules/
-│   │   │   ├── index_manager.py    # SQLite 索引管理 (v5.3)
-│   │   │   ├── rag_adapter.py      # RAG 检索层(v5.4父子索引)
-│   │   │   ├── context_manager.py  # Token预算管理(v5.4新增)
-│   │   │   ├── api_client.py       # API 客户端
-│   │   │   └── config.py           # 配置管理
-│   │   ├── ...
-│   │   └── 注:旧的 context_pack_builder.py 已废弃,统一使用 context_manager.py
-│   ├── templates/              # 题材模板
-│   │   └── genres/
-│   │       ├── 修仙.md
-│   │       ├── 系统流.md
-│   │       ├── 替身文.md
-│   │       ├── 多子多福.md
-│   │       ├── 黑暗题材.md
-│   │       └── ...
-│   └── references/             # 写作指南
-│       ├── shared/             # 单一事实源(共享参考)
-│       │   ├── core-constraints.md
-│       │   ├── strand-weave-pattern.md
-│       │   └── cool-points-guide.md
-│       ├── reading-power-taxonomy.md  # 追读力分类标准
-│       ├── genre-profiles.md          # 题材配置档案
-│       └── ...
-├── .webnovel/                  # 运行时数据
-│   ├── state.json              # 权威状态 (含 chapter_meta)
-│   ├── index.db                # SQLite 索引
-│   ├── vectors.db              # RAG 向量库
-│   └── summaries/              # 章节摘要(v5.2新增)
-│       ├── ch0001.md
-│       └── ...
-├── 正文/                       # 章节文件
-│   ├── 第1章-标题.md
-│   └── ...
-├── 大纲/                       # 卷纲/章纲
-│   ├── 总纲.md
-│   ├── 第1卷-节拍表.md
-│   ├── 第1卷-详细大纲.md
-│   └── ...
-└── 设定集/                     # 世界观/角色/力量体系
-    ├── 世界观.md
-    ├── 力量体系.md
-    └── 角色/
-        └── ...
-```
-
----
-
-## 故障恢复
-
-### 索引重建
-
-当 `index.db` 损坏或与实际数据不一致时:
-
-建议先统一设置(后续命令复用):
-
-```bash
-export WORKSPACE_ROOT="${CLAUDE_PROJECT_DIR:-$PWD}"
-if [ -z "${CLAUDE_PLUGIN_ROOT}" ] || [ ! -d "${CLAUDE_PLUGIN_ROOT}/scripts" ]; then
-  echo "ERROR: 未设置 CLAUDE_PLUGIN_ROOT 或缺少目录: ${CLAUDE_PLUGIN_ROOT}/scripts" >&2
-  exit 1
-fi
-export SCRIPTS_DIR="${CLAUDE_PLUGIN_ROOT}/scripts"
-export PROJECT_ROOT="$(python "${SCRIPTS_DIR}/webnovel.py" --project-root "${WORKSPACE_ROOT}" where)"
-```
-
-```bash
-# 重新处理单章
-python "${SCRIPTS_DIR}/webnovel.py" --project-root "${PROJECT_ROOT}" index process-chapter --chapter 1
-
-# 批量重新处理
-for i in $(seq 1 50); do
-  python "${SCRIPTS_DIR}/webnovel.py" --project-root "${PROJECT_ROOT}" index process-chapter --chapter $i
-done
-
-# 查看索引统计
-python "${SCRIPTS_DIR}/webnovel.py" --project-root "${PROJECT_ROOT}" index stats
-```
-
-### 追读力数据查询 (v5.3 引入)
-
-```bash
-# 查看债务汇总
-python "${SCRIPTS_DIR}/webnovel.py" --project-root "${PROJECT_ROOT}" index get-debt-summary
-
-# 查看最近章节追读力元数据
-python "${SCRIPTS_DIR}/webnovel.py" --project-root "${PROJECT_ROOT}" index get-recent-reading-power --limit 10
-
-# 查看爽点模式使用统计
-python "${SCRIPTS_DIR}/webnovel.py" --project-root "${PROJECT_ROOT}" index get-pattern-usage-stats --last-n 20
-
-# 查看钩子类型使用统计
-python "${SCRIPTS_DIR}/webnovel.py" --project-root "${PROJECT_ROOT}" index get-hook-type-stats --last-n 20
-
-# 查看待偿还Override
-python "${SCRIPTS_DIR}/webnovel.py" --project-root "${PROJECT_ROOT}" index get-pending-overrides
-
-# 计算利息(开启追踪或需要时调用)
-python "${SCRIPTS_DIR}/webnovel.py" --project-root "${PROJECT_ROOT}" index accrue-interest --current-chapter 100
-```
-
-### 审查趋势查询 (v5.4 引入)
-
-```bash
-# 查看最近审查记录
-python "${SCRIPTS_DIR}/webnovel.py" --project-root "${PROJECT_ROOT}" index get-recent-review-metrics --limit 5
-
-# 查看审查趋势统计(均值/短板分析)
-python "${SCRIPTS_DIR}/webnovel.py" --project-root "${PROJECT_ROOT}" index get-review-trend-stats --last-n 5
-```
-
-### 质量趋势看板(离线报告)
-
-```bash
-# 生成最近20条记录的质量趋势报告
-python "${SCRIPTS_DIR}/quality_trend_report.py" --project-root "${PROJECT_ROOT}" --limit 20
-```
-
-说明:`quality_trend_report.py` 支持直接传入真实书项目根并写入 `.webnovel/`。
-
-### 测试入口脚本
-
-```bash
-# 快速回归(推荐)
-pwsh webnovel-writer/scripts/run_tests.ps1 -Mode smoke
-
-# 全量 data_modules 测试
-pwsh webnovel-writer/scripts/run_tests.ps1 -Mode full
-```
-
-### 健康报告(status_reporter)
-
-```bash
-# 全量健康报告
-python "${SCRIPTS_DIR}/webnovel.py" --project-root "${PROJECT_ROOT}" status -- --focus all
-
-# 仅看伏笔紧急度
-python "${SCRIPTS_DIR}/webnovel.py" --project-root "${PROJECT_ROOT}" status -- --focus urgency
-
-# 仅看爽点节奏
-python "${SCRIPTS_DIR}/webnovel.py" --project-root "${PROJECT_ROOT}" status -- --focus pacing
-```
-
-说明:
-- 伏笔分析优先使用 `plot_threads.foreshadowing` 的真实章节字段(如 `planted_chapter` / `target_chapter`)。
-- 爽点节奏优先使用 `chapter_reading_power.coolpoint_patterns`,其次回退 `chapter_meta`。
-- 若章节数据缺失,报告会标记“数据不足”,不会再用固定假设值估算。
-
-### Claude Code 调用责任(重要)
-
-- 本项目脚本默认由 Claude Code 的 Skill/Agent 在流程节点自动触发,不以人工手动调用为主。
-- 详细“谁调用、何时调用、调用什么”见:`webnovel-writer/references/claude-code-call-matrix.md`。
-
-### 向量重建
-
-当 `vectors.db` 损坏或嵌入模型更换时:
-
-```bash
-# 重新索引单章
-python "${SCRIPTS_DIR}/webnovel.py" --project-root "${PROJECT_ROOT}" rag index-chapter --chapter 1
-
-# 查看向量统计
-python "${SCRIPTS_DIR}/webnovel.py" --project-root "${PROJECT_ROOT}" rag stats
-```
-
-### Git 回滚
-
-每章自动创建 Git 标签,支持按章回滚:
-
-```bash
-# 查看章节标签
-git tag --list "ch*"
-
-# 回滚到第45章
-git checkout ch0045
-```
-
----
-
-## 版本历史(精简)
-
-| 版本 | 里程碑 |
-|------|--------|
-| **v5.4.4 (当前)** | 引入官方 Claude Code Plugin Marketplace 安装机制(仓库可直接安装);统一修复 Skills/Agents/References 的 CLI 调用(`CLAUDE_PLUGIN_ROOT` 单路径,`status/context/update-state/migrate` 透传统一使用 `--` 分隔) |
-| **v5.4.3** | 智能 RAG 辅助上下文(按需触发 `auto/graph_hybrid`,失败回退 BM25);关系事件图谱与 Graph-RAG 链路完善 |
-| **v5.4.x** | Context Contract v2 完成(reader_signal / genre_profile / writing_guidance / checklist_score / 动态预算);审查趋势与调用可观测性 |
-| **v5.3** | 追读力系统落地(Hook/Cool-point/微兑现分类、Hard/Soft 约束、Override Contract、债务追踪) |
-| **v5.2** | 写作流程升级(Step 1.5 章节设计、reader-pull-checker、摘要分离到 `.webnovel/summaries/`) |
-| **v5.1-v5.0** | 双 Agent 基础架构 + SQLite 索引化(state 精简、实体/别名/状态变化入库) |
-
-详细阶段性变更请参考提交历史与 `webnovel-writer/references/` 下对应规范文档。
-
----
-
-## Star 趋势
+## Star 历史
 
 [![Star History Chart](https://api.star-history.com/svg?repos=lingfengQAQ/webnovel-writer&type=Date)](https://star-history.com/#lingfengQAQ/webnovel-writer&Date)
 
----
-
-## License
-
-GPL v3 - 详见 [LICENSE](LICENSE)
-
----
-
 ## 致谢
 
-本项目使用 **Claude Code + Gemini CLI + Codex** 配合 Vibe Coding 方式开发。
-
+本项目使用 **Claude Code + Gemini CLI + Codex** 配合 Vibe Coding 方式开发。  
 灵感来源:[Linux.do 帖子](https://linux.do/t/topic/1397944/49)
 
----
-
 ## 贡献
 
-欢迎提交 Issue 和 PR
+欢迎提交 Issue 和 PR:
 
 ```bash
-# Fork 项目后
 git checkout -b feature/your-feature
 git commit -m "feat: add your feature"
 git push origin feature/your-feature

+ 15 - 0
docs/README.md

@@ -0,0 +1,15 @@
+# 文档中心
+
+本目录承载 `README.md` 之外的详细说明,按模块拆分:
+
+- `architecture.md`:系统架构、核心理念、双 Agent、六维审查
+- `commands.md`:`/webnovel-*` 命令详细说明
+- `rag-and-config.md`:RAG 检索与环境配置
+- `genres.md`:题材模板与复合题材规则
+- `operations.md`:项目结构与故障恢复/运维手册
+
+建议阅读顺序:
+
+1. 先看 `../README.md`(安装与上手)
+2. 再看 `architecture.md`(理解系统设计)
+3. 最后按需查阅命令和运维文档

+ 60 - 0
docs/architecture.md

@@ -0,0 +1,60 @@
+# 系统架构与模块设计
+
+## 核心理念
+
+### 防幻觉三定律
+
+| 定律 | 说明 | 执行方式 |
+|------|------|---------|
+| **大纲即法律** | 遵循大纲,不擅自发挥 | Context Agent 强制加载章节大纲 |
+| **设定即物理** | 遵守设定,不自相矛盾 | Consistency Checker 实时校验 |
+| **发明需识别** | 新实体必须入库管理 | Data Agent 自动提取并消歧 |
+
+### Strand Weave 节奏系统
+
+| Strand | 含义 | 理想占比 | 说明 |
+|--------|------|---------|------|
+| **Quest** | 主线剧情 | 60% | 推动核心冲突 |
+| **Fire** | 感情线 | 20% | 人物关系发展 |
+| **Constellation** | 世界观扩展 | 20% | 背景/势力/设定 |
+
+节奏红线:
+
+- Quest 连续不超过 5 章
+- Fire 断档不超过 10 章
+- Constellation 断档不超过 15 章
+
+## 总体架构图
+
+```text
+┌─────────────────────────────────────────────────────────────┐
+│                      Claude Code                           │
+├─────────────────────────────────────────────────────────────┤
+│  Skills (7个): init / plan / write / review / query / ... │
+├─────────────────────────────────────────────────────────────┤
+│  Agents (8个): Context / Data / 多维 Checker               │
+├─────────────────────────────────────────────────────────────┤
+│  Data Layer: state.json / index.db / vectors.db            │
+└─────────────────────────────────────────────────────────────┘
+```
+
+## 双 Agent 架构
+
+### Context Agent(读)
+
+职责:在写作前构建“创作任务书”,提供本章上下文、约束和追读力策略。
+
+### Data Agent(写)
+
+职责:从正文提取实体与状态变化,更新 `state.json`、`index.db`、`vectors.db`,保证数据链闭环。
+
+## 六维并行审查
+
+| Checker | 检查重点 |
+|---------|---------|
+| High-point Checker | 爽点密度与质量 |
+| Consistency Checker | 设定一致性(战力/地点/时间线) |
+| Pacing Checker | Strand 比例与断档 |
+| OOC Checker | 人物行为是否偏离人设 |
+| Continuity Checker | 场景与叙事连贯性 |
+| Reader-pull Checker | 钩子强度、期待管理、追读力 |

+ 72 - 0
docs/commands.md

@@ -0,0 +1,72 @@
+# 命令详解
+
+## `/webnovel-init`
+
+用途:初始化小说项目(目录、设定模板、状态文件)。
+
+产出:
+
+- `.webnovel/state.json`
+- `设定集/`
+- `大纲/总纲.md`
+
+## `/webnovel-plan [卷号]`
+
+用途:生成卷级规划与节拍。
+
+示例:
+
+```bash
+/webnovel-plan 1
+/webnovel-plan 2-3
+```
+
+## `/webnovel-write [章号]`
+
+用途:执行完整章节创作流水线(上下文 → 草稿 → 审查 → 数据落盘)。
+
+示例:
+
+```bash
+/webnovel-write 1
+/webnovel-write 45
+```
+
+常见模式:
+
+- 标准模式:全流程
+- 快速模式:`--fast`
+- 极简模式:`--minimal`
+
+## `/webnovel-review [范围]`
+
+用途:对历史章节做多维质量审查。
+
+示例:
+
+```bash
+/webnovel-review 1-5
+/webnovel-review 45
+```
+
+## `/webnovel-query [关键词]`
+
+用途:查询角色、伏笔、节奏、状态等运行时信息。
+
+示例:
+
+```bash
+/webnovel-query 萧炎
+/webnovel-query 伏笔
+/webnovel-query 紧急
+```
+
+## `/webnovel-resume`
+
+用途:任务中断后自动识别断点并恢复。
+
+示例:
+
+```bash
+/webnovel-resume
+```

+ 47 - 0
docs/genres.md

@@ -0,0 +1,47 @@
+# 题材模板说明
+
+系统内置 37+ 网文题材模板,支持单题材与复合题材。
+
+## 玄幻修仙类(示例)
+
+- 修仙
+- 系统流
+- 高武
+- 西幻
+- 无限流
+- 末世
+- 科幻
+
+## 都市现代类(示例)
+
+- 都市异能
+- 都市日常
+- 都市脑洞
+- 现实题材
+- 电竞
+- 直播文
+
+## 言情类(示例)
+
+- 古言
+- 宫斗宅斗
+- 青春甜宠
+- 豪门总裁
+- 职场婚恋
+- 民国言情
+- 幻想言情
+- 现言脑洞
+- 女频悬疑
+- 种田
+- 年代
+
+## 复合题材规则
+
+- 支持 `题材A+题材B`(最多 2 个)
+- 建议主辅比例 7:3
+- 主线遵循主题材逻辑,副题材提供钩子/规则/爽点
+
+示例:
+
+- `都市脑洞+规则怪谈`
+- `修仙+系统流`

+ 99 - 0
docs/operations.md

@@ -0,0 +1,99 @@
+# 项目结构与运维
+
+## 目录层级(真实运行)
+
+在 Claude Code + Marketplace 安装下,至少有 4 层概念:
+
+1. `WORKSPACE_ROOT`(Claude 工作区根,通常是 `${CLAUDE_PROJECT_DIR}`)
+2. `WORKSPACE_ROOT/.claude/`(工作区级指针与配置)
+3. `PROJECT_ROOT`(真实小说项目根,`/webnovel-init` 按书名创建)
+4. `CLAUDE_PLUGIN_ROOT`(插件缓存目录,不在项目内)
+
+### A) Workspace 目录(含 `.claude`)
+
+```text
+workspace-root/
+├── .claude/
+│   ├── .webnovel-current-project   # 指向当前小说项目根
+│   └── settings.json
+├── 小说A/
+├── 小说B/
+└── ...
+```
+
+### B) 小说项目目录(`PROJECT_ROOT`)
+
+```text
+project-root/
+├── .webnovel/            # 运行时数据(state/index/vectors/summaries)
+├── 正文/                  # 正文章节
+├── 大纲/                  # 总纲与卷纲
+└── 设定集/                # 世界观、角色、力量体系
+```
+
+## 插件目录(Marketplace 安装)
+
+插件不在小说项目目录内,而在 Claude 插件缓存目录。运行时统一用 `CLAUDE_PLUGIN_ROOT` 引用:
+
+```text
+${CLAUDE_PLUGIN_ROOT}/
+├── skills/
+├── agents/
+├── scripts/
+└── references/
+```
+
+### C) 用户级全局映射(兜底)
+
+当工作区没有可用指针时,会使用用户级 registry 做 `workspace -> current_project_root` 映射:
+
+```text
+${CLAUDE_HOME:-~/.claude}/webnovel-writer/workspaces.json
+```
+
+## 模拟目录实测(2026-03-03)
+
+基于 `D:\wk\novel skill\plugin-sim-20260303-012048` 的实际结果:
+
+- `WORKSPACE_ROOT`:`D:\wk\novel skill\plugin-sim-20260303-012048`
+- 指针文件:`D:\wk\novel skill\plugin-sim-20260303-012048\.claude\.webnovel-current-project`
+- 指针内容:`D:\wk\novel skill\plugin-sim-20260303-012048\凡人资本论-二测`
+- 已创建项目示例:`凡人资本论/`、`凡人资本论-二测/`
+
+## 常用运维命令
+
+统一前置(手动 CLI 场景):
+
+```bash
+export WORKSPACE_ROOT="${CLAUDE_PROJECT_DIR:-$PWD}"
+export SCRIPTS_DIR="${CLAUDE_PLUGIN_ROOT}/scripts"
+export PROJECT_ROOT="$(python "${SCRIPTS_DIR}/webnovel.py" --project-root "${WORKSPACE_ROOT}" where)"
+```
+
+### 索引重建
+
+```bash
+python "${SCRIPTS_DIR}/webnovel.py" --project-root "${PROJECT_ROOT}" index process-chapter --chapter 1
+python "${SCRIPTS_DIR}/webnovel.py" --project-root "${PROJECT_ROOT}" index stats
+```
+
+### 健康报告
+
+```bash
+python "${SCRIPTS_DIR}/webnovel.py" --project-root "${PROJECT_ROOT}" status -- --focus all
+python "${SCRIPTS_DIR}/webnovel.py" --project-root "${PROJECT_ROOT}" status -- --focus urgency
+```
+
+### 向量重建
+
+```bash
+python "${SCRIPTS_DIR}/webnovel.py" --project-root "${PROJECT_ROOT}" rag index-chapter --chapter 1
+python "${SCRIPTS_DIR}/webnovel.py" --project-root "${PROJECT_ROOT}" rag stats
+```
+
+### 测试入口
+
+```bash
+pwsh "${CLAUDE_PLUGIN_ROOT}/scripts/run_tests.ps1" -Mode smoke
+pwsh "${CLAUDE_PLUGIN_ROOT}/scripts/run_tests.ps1" -Mode full
+```

+ 36 - 0
docs/rag-and-config.md

@@ -0,0 +1,36 @@
+# RAG 与配置说明
+
+## RAG 检索架构
+
+```text
+查询 → QueryRouter(auto) → vector / bm25 / hybrid / graph_hybrid
+                     └→ RRF 融合 + Rerank → Top-K
+```
+
+默认模型:
+
+- Embedding:`Qwen/Qwen3-Embedding-8B`
+- Reranker:`jina-reranker-v3`
+
+## 环境变量加载顺序
+
+1. 进程环境变量(最高优先级)
+2. 书项目根目录下的 `.env`
+3. 用户级全局:`~/.claude/webnovel-writer/.env`
+
+## `.env` 最小配置
+
+```bash
+EMBED_BASE_URL=https://api-inference.modelscope.cn/v1
+EMBED_MODEL=Qwen/Qwen3-Embedding-8B
+EMBED_API_KEY=your_embed_api_key
+
+RERANK_BASE_URL=https://api.jina.ai/v1
+RERANK_MODEL=jina-reranker-v3
+RERANK_API_KEY=your_rerank_api_key
+```
+
+说明:
+
+- 未配置 Embedding Key 时,语义检索会回退到 BM25。
+- 推荐每本书单独配置 `${PROJECT_ROOT}/.env`,避免多项目串配置。