# 文档管理自动化工具使用说明

**项目：** 《杀了婆婆的我却无人追责？》
**创建时间：** 2026-03-26
**目的：** 通过自动化工具确保文档管理工作流程被执行

---

## 🚀 自动化工具说明

### 1. backup-doc.sh - 文档归档脚本

**位置：** `/root/.openclaw/workspace/novel-tracker/scripts/backup-doc.sh`

**使用方法：**
```bash
# 归档大纲
./scripts/backup-doc.sh outline

# 归档章节
./scripts/backup-doc.sh chapter chapter-05

# 归档多个章节
./scripts/backup-doc.sh chapter chapter-01
./scripts/backup-doc.sh chapter chapter-02
./scripts/backup-doc.sh chapter chapter-03
./scripts/backup-doc.sh chapter chapter-04
./scripts/backup-doc.sh chapter chapter-05
```

**功能：**
- ✅ 自动识别当前版本号（从标题读取）
- ✅ 创建归档目录（如不存在）
- ✅ 归档文件到 `archive/xxx-history/` 目录
- ✅ 文件名包含版本号和日期（如：outline-v10.1.1-20260326.md）
- ✅ 更新章节的 CHANGELOG.md（章节归档专用）
- ✅ 彩色输出，易于识别

**优势：**
- 🚀 一键归档，避免手动错误
- 🚀 自动生成规范化的文件名
- 🚀 防止忘记归档

---

### 2. check-duplicates.sh - 检查重复文档脚本

**位置：** `/root/.openclaw/workspace/novel-tracker/scripts/check-duplicates.sh`

**使用方法：**
```bash
# 检查本地重复文档
./scripts/check-duplicates.sh
```

**功能：**
- ✅ 检查 `current/` 目录下的重复文档
- ✅ 检查 `archive/` 目录下的历史版本
- ✅ 统计每个章节的历史版本数
- ✅ 颜色输出，易于识别重复

**优势：**
- 🚀 快速发现重复文档
- 🚀 避免手动查找的疏漏
- 🚅 视觉清晰，易于理解

---

## 📋 实施建议

### 短期（立即执行）

#### 第1步：运行检查脚本
```bash
# 检查当前是否有重复文档
cd /root/.openclaw/workspace/novel-tracker
./scripts/check-duplicates.sh
```

**预期结果：**
- 如果有重复文档，会显示警告
- 如果没有重复文档，会显示"检查完成！"

#### 第2步：清理重复文档
- 根据检查脚本的输出
- 删除或归档重复的文档
- 确保每个文档类型只有一个最新版本

#### 第3步：熟悉工作流程
- 阅读 `DOC_MANAGEMENT_WORKFLOW.md`
- 阅读 `CHECKLIST.md`（执行清单）
- 理解5种文档类型的工作流程

---

### 中期（1-2周内）

#### 第1步：首次修改时使用脚本
**修改大纲时：**
```bash
# 先归档旧大纲
./scripts/backup-doc.sh outline

# 再修改 current/outline.md
# 修改完成后，记得更新 CHANGELOG.md
```

**修改章节时：**
```bash
# 先归档旧章节
./scripts/backup-doc.sh chapter chapter-05

# 再修改 current/chapter-05.md
# 修改完成后，记得更新 CHANGELOG.md
```

#### 第2步：每周运行检查脚本
```bash
# 每周一早上运行一次
cd /root/.openclaw/workspace/novel-tracker
./scripts/check-duplicates.sh
```

**目的：**
- 防止重复文档积累
- 及时发现不规范操作

---

### 长期（1个月后）

#### 第1步：养成使用脚本的习惯
- 每次修改前都运行备份脚本
- 每周都运行检查脚本
- 将脚本作为工作流程的一部分

#### 第2步：优化工作流程
- 根据实际使用情况，调整 `DOC_MANAGEMENT_WORKFLOW.md`
- 根据实际需要，添加新的自动化工具
- 记录遇到的问题和解决方案到 `records/ISSUE_LOG.md`

#### 第3步：定期复盘
- 每月检查一次工作流程是否符合实际需要
- 每月检查一次自动化工具是否需要优化
- 记录优化建议到 `records/DECISION_LOG.md`

---

## 🎯 执行策略

### 策略1：强制执行（推荐）
**要求：** 每次修改文档前必须先运行备份脚本

**优点：**
- ✅ 100% 避免忘记归档
- ✅ 确保每次都有备份
- ✅ 培养良好习惯

**执行方式：**
1. 修改文档前，在终端运行 `./scripts/backup-doc.sh`
2. 等待脚本执行完成
3. 确认归档成功后，再开始修改

---

### 策略2：提醒执行
**要求：** 每次修改文档前，提醒自己先备份

**优点：**
- ✅ 灵活性高，可以跳过（不推荐）
- ✅ 逐渐培养习惯

**执行方式：**
1. 在终端设置一个别名：
```bash
# 在 ~/.bashrc 中添加
alias backup-outline="cd /root/.openclaw/workspace/novel-tracker && ./scripts/backup-doc.sh outline"
alias backup-chapter="cd /root/.openclaw/workspace/novel-tracker && ./scripts/backup-doc.sh chapter"
```

2. 重新加载配置：
```bash
source ~/.bashrc
```

3. 使用时简单输入：
```bash
# 归档大纲
backup-outline

# 归档第5章
backup-chapter chapter-05
```

---

### 策略3：定时检查
**要求：** 每周定时运行检查脚本

**优点：**
- ✅ 自动化检查，不依赖人工
- ✅ 防止重复文档积累

**执行方式：**
1. 设置定时任务（每周一早上9点）：
```bash
# 编辑 crontab
crontab -e

# 添加定时任务
0 9 * * 1 cd /root/.openclaw/workspace/novel-tracker && ./scripts/check-duplicates.sh >> /tmp/check-duplicates.log 2>&1
```

2. 查看定时任务：
```bash
crontab -l
```

3. 查看检查日志：
```bash
cat /tmp/check-duplicates.log
```

---

## 📈 监控指标

### 指标1：文档数量稳定性
- **目标：** 核心文档数量保持在 8-10 个
- **监控方式：** 定期运行 `find . -name "*.md" | wc -l`
- **异常处理：** 如果数量超过 15 个，运行 `check-duplicates.sh` 检查

### 指标2：归档完整性
- **目标：** 所有旧版本都已归档
- **监控方式：** 每周检查 `archive/` 目录
- **异常处理：** 如果 `current/` 下有未归档的旧版本，立即归档

### 指标3：版本号规范性
- **目标：** 所有文档都有规范的版本号
- **监控方式：** 检查文档标题中的版本号格式
- **异常处理：** 如果格式不规范，立即修正

---

## 🎮 成功标准

### 短期成功标准（1-2周）
- ✅ 每次修改前都使用 `backup-doc.sh`
- ✅ 每周都运行一次 `check-duplicates.sh`
- ✅ 没有出现重复文档
- ✅ 旧版本都已归档到 `archive/` 目录

### 中期成功标准（1个月）
- ✅ 所有文档都有规范的版本号
- ✅ 所有重要信息都已同步到飞书
- ✅ 工作流程已成为习惯，不需要刻意提醒
- ✅ 没有出现文档管理问题

### 长期成功标准（持续）
- ✅ 文档数量稳定在 8-10 个核心文档
- ✅ 所有历史版本都可追溯
- ✅ 信息完整性100%保证
- ✅ 工作流程持续优化，效率提升

---

## 💡 常见问题

### Q1：忘记运行备份脚本就修改了文档怎么办？
**A：** 立即运行 `backup-doc.sh`，即使已经修改也可以归档。脚本会自动识别版本号并归档。

### Q2：重复文档很多，不知道哪个是最新版？
**A：** 运行 `check-duplicates.sh`，它会列出所有历史版本。最新的版本通常版本号最大、日期最新。

### Q3：如何在飞书上标记旧文档？
**A：** 在飞书文档标题前加 `[旧]` 标记。例如：`[旧] 第5章：被当做疯子（v1.3）`

### Q4：如何确保每次修改都记得使用脚本？
**A：** 设置别名（如策略2所述），或使用定时任务提醒（如策略3所述）。

### Q5：脚本没有执行权限怎么办？
**A：** 运行以下命令添加执行权限：
```bash
chmod +x /root/.openclaw/workspace/novel-tracker/scripts/backup-doc.sh
chmod +x /root/.openclaw/workspace/novel-tracker/scripts/check-duplicates.sh
```

---

## 📞 获取帮助

如果遇到问题：
1. 查看 `DOC_MANAGEMENT_WORKFLOW.md` 工作流程指南
2. 查看 `CHECKLIST.md` 执行清单
3. 查看 `records/ISSUE_LOG.md` 问题修复日志（类似问题）
4. 查看 `records/DECISION_LOG.md` 决策记录（类似问题）

---

**自动化工具使用说明** v1.0
**创建时间：** 2026-03-26 19:25
**创建人：** 番茄小说创作助手
