323 lines
7.7 KiB
Markdown
323 lines
7.7 KiB
Markdown
|
# 如何确保文档管理工作流程被践行
|
|||
|
|
|
|||
|
|
**项目：** 《杀了婆婆的我却无人追责？》
|
|||
|
|
**创建时间：** 2026-03-26
|
|||
|
|
**目的：** 确保文档管理工作流程在实际工作中被践行
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 🎯 核心策略
|
|||
|
|
|
|||
|
|
### 策略1：强制执行（推荐）⭐
|
|||
|
|
**原则：** 每次修改文档前必须先运行备份脚本
|
|||
|
|
|
|||
|
|
**实施方法：**
|
|||
|
|
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. 强制规则：
|
|||
|
|
- ❌ 修改文档前不运行 `backup-doc.sh` 的操作禁止执行
|
|||
|
|
- ❌ 修改完成后不更新 `CHANGELOG.md` 的操作禁止执行
|
|||
|
|
|
|||
|
|
**优势：**
|
|||
|
|
- ✅ 100% 避免忘记归档
|
|||
|
|
- ✅ 确保每次都有备份
|
|||
|
|
- ✅ 培养良好习惯
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
### 策略2：检查清单驱动
|
|||
|
|
**原则：** 每次操作前对照检查清单
|
|||
|
|
|
|||
|
|
**实施方法：**
|
|||
|
|
1. 将 `CHECKLIST.md` 打印出来或放在终端侧边
|
|||
|
|
2. 每次操作前，快速扫描相关检查项
|
|||
|
|
3. 完成所有必选项后再开始操作
|
|||
|
|
|
|||
|
|
**优势：**
|
|||
|
|
- ✅ 操作前检查，减少错误
|
|||
|
|
- ✅ 逐项确认，避免遗漏
|
|||
|
|
- ✅ 可以培养习惯，逐渐内化
|
|||
|
|
|
|||
|
|
**劣势：**
|
|||
|
|
- ⚠️ 可能会增加操作时间（初期）
|
|||
|
|
- ⚠️ 需要一定的自律性
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
### 策略3：定时检查+自动提醒
|
|||
|
|
**原则：** 定期检查，自动发现异常
|
|||
|
|
|
|||
|
|
**实施方法：**
|
|||
|
|
1. 设置定时任务（每周一早上9点）：
|
|||
|
|
```bash
|
|||
|
|
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
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**优势：**
|
|||
|
|
- ✅ 自动化检查，不依赖人工
|
|||
|
|
- ✅ 防止重复文档积累
|
|||
|
|
- ✅ 及时发现问题
|
|||
|
|
|
|||
|
|
**劣势：**
|
|||
|
|
- ⚠️ 需要一定的技术基础（crontab）
|
|||
|
|
- ⚠️ 只能发现已有问题，不能预防
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 🚀 执行步骤
|
|||
|
|
|
|||
|
|
### 第1步：学习阶段（1-2周）
|
|||
|
|
|
|||
|
|
#### 目标
|
|||
|
|
- 理解文档管理工作流程
|
|||
|
|
- 熟悉自动化工具
|
|||
|
|
- 培养使用检查清单的习惯
|
|||
|
|
|
|||
|
|
#### 任务
|
|||
|
|
1. 阅读 `DOC_MANAGEMENT_WORKFLOW.md`
|
|||
|
|
2. 阅读 `CHECKLIST.md`
|
|||
|
|
3. 阅读 `AUTOMATION_TOOLS_GUIDE.md`
|
|||
|
|
4. 运行一次 `check-duplicates.sh` 检查当前状态
|
|||
|
|
5. 修改一次大纲，练习使用 `backup-doc.sh`
|
|||
|
|
|
|||
|
|
#### 验收标准
|
|||
|
|
- ✅ 能独立操作 3 种文档类型（大纲/章节/其他）
|
|||
|
|
- ✅ 能独立操作 5 个工作流程
|
|||
|
|
- ✅ 能使用 2 个自动化工具
|
|||
|
|
- ✅ 能对照检查清单完成操作
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
### 第2步：养成习惯阶段（2-4周）
|
|||
|
|
|
|||
|
|
#### 目标
|
|||
|
|
- 将工作流程内化为习惯
|
|||
|
|
- 将自动化工具融入日常工作流
|
|||
|
|
- 减少对检查清单的依赖
|
|||
|
|
|
|||
|
|
#### 任务
|
|||
|
|
1. 使用别名 `backup-outline` 和 `backup-chapter`
|
|||
|
|
2. 每周运行 `check-duplicates.sh`
|
|||
|
|
3. 修改文档时使用检查清单
|
|||
|
|
4. 每周复盘工作流程执行情况
|
|||
|
|
|
|||
|
|
#### 验收标准
|
|||
|
|
- ✅ 100% 的修改操作都先备份
|
|||
|
|
- ✅ 每周都运行一次检查脚本
|
|||
|
|
- ✅ 检查清单的完成率 > 80%
|
|||
|
|
- ✅ 没有出现重复文档
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
### 第3步：内化阶段（1个月后）
|
|||
|
|
|
|||
|
|
#### 目标
|
|||
|
|
- 工作流程成为潜意识习惯
|
|||
|
|
- 自动化工具成为自然操作
|
|||
|
|
- 不需要检查清单也能正确操作
|
|||
|
|
|
|||
|
|
#### 任务
|
|||
|
|
1. 继续使用别名和定时任务
|
|||
|
|
2. 每月检查一次工作流程
|
|||
|
|
3. 根据实际情况优化工作流程
|
|||
|
|
4. 记录优化建议到 `records/DECISION_LOG.md`
|
|||
|
|
|
|||
|
|
#### 验收标准
|
|||
|
|
- ✅ 修改文档前自动运行备份（不需要提醒）
|
|||
|
|
- ✅ 不需要对照清单也能正确操作
|
|||
|
|
- ✅ 工作流程持续优化，效率提升
|
|||
|
|
- ✅ 文档管理问题为 0
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 📋 每次操作的快速流程
|
|||
|
|
|
|||
|
|
### 快速流程1：修改大纲
|
|||
|
|
```bash
|
|||
|
|
# 1. 归档旧大纲
|
|||
|
|
backup-outline
|
|||
|
|
|
|||
|
|
# 2. 修改 current/outline.md
|
|||
|
|
vim current/outline.md
|
|||
|
|
|
|||
|
|
# 3. 更新 CHANGELOG.md
|
|||
|
|
vim CHANGELOG.md
|
|||
|
|
|
|||
|
|
# 4. （如果需要）更新 ISSUE_LOG.md 或 DECISION_LOG.md
|
|||
|
|
|
|||
|
|
# 5. 同步到飞书
|
|||
|
|
# 手动操作：标记旧大纲，创建新大纲，更新导航文档
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 快速流程2：修改章节
|
|||
|
|
```bash
|
|||
|
|
# 1. 归档旧章节
|
|||
|
|
backup-chapter chapter-XX
|
|||
|
|
|
|||
|
|
# 2. 修改 current/chapter-XX.md
|
|||
|
|
vim current/chapter-XX.md
|
|||
|
|
|
|||
|
|
# 3. 更新 archive/chapter-history/chapter-XX/CHANGELOG.md
|
|||
|
|
vim archive/chapter-history/chapter-XX/CHANGELOG.md
|
|||
|
|
|
|||
|
|
# 4. 更新 CHANGELOG.md
|
|||
|
|
vim CHANGELOG.md
|
|||
|
|
|
|||
|
|
# 5. 同步到飞书
|
|||
|
|
# 手动操作：标记旧章节，创建新章节，更新导航文档
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 快速流程3：创建新章节
|
|||
|
|
```bash
|
|||
|
|
# 1. 创建新章节
|
|||
|
|
vim current/chapter-XX.md
|
|||
|
|
|
|||
|
|
# 2. 更新 INDEX.md
|
|||
|
|
vim INDEX.md
|
|||
|
|
|
|||
|
|
# 3. 更新 CHANGELOG.md
|
|||
|
|
vim CHANGELOG.md
|
|||
|
|
|
|||
|
|
# 4. 同步到飞书
|
|||
|
|
# 手动操作：创建新章节，更新导航文档
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 🎯 成功衡量标准
|
|||
|
|
|
|||
|
|
### 短期成功（1-2周）
|
|||
|
|
- [ ] 100% 的修改操作都先备份
|
|||
|
|
- [ ] 每周都运行一次检查脚本
|
|||
|
|
- [ ] 检查清单的完成率 > 80%
|
|||
|
|
- [ ] 没有出现重复文档
|
|||
|
|
- [ ] 旧版本都已归档
|
|||
|
|
|
|||
|
|
### 中期成功（1个月）
|
|||
|
|
- [ ] 修改文档前自动运行备份（不需要提醒）
|
|||
|
|
- [ ] 不需要对照清单也能正确操作
|
|||
|
|
- [ ] 工作流程持续优化，效率提升
|
|||
|
|
- [ ] 文档管理问题为 0
|
|||
|
|
|
|||
|
|
### 长期成功（持续）
|
|||
|
|
- [ ] 文档数量稳定在 8-10 个核心文档
|
|||
|
|
- [ ] 所有历史版本都可追溯
|
|||
|
|
- [ ] 信息完整性 100% 保证
|
|||
|
|
- [ ] 工作流程持续优化，效率提升 50%+
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 💡 常见问题和解决方案
|
|||
|
|
|
|||
|
|
### 问题1：忘记使用备份脚本
|
|||
|
|
**解决方案：**
|
|||
|
|
- 设置别名（如策略1所述）
|
|||
|
|
- 在 `current/` 目录下创建 `README.md`，提醒先备份
|
|||
|
|
- 在终端设置提示符，显示"先备份！"
|
|||
|
|
|
|||
|
|
### 问题2：创建了很多临时文档
|
|||
|
|
**解决方案：**
|
|||
|
|
- 定期运行 `check-duplicates.sh`
|
|||
|
|
- 每周清理一次临时文档
|
|||
|
|
- 重要信息立即迁移到正式文档
|
|||
|
|
|
|||
|
|
### 问题3：飞书和本地不同步
|
|||
|
|
**解决方案：**
|
|||
|
|
- 每次本地修改后，立即同步到飞书
|
|||
|
|
- 每周检查一次飞书和本地的一致性
|
|||
|
|
- 重要信息双重备份
|
|||
|
|
|
|||
|
|
### 问题4：工作流程太复杂
|
|||
|
|
**解决方案：**
|
|||
|
|
- 只关注核心流程（归档→修改→更新日志→同步）
|
|||
|
|
- 使用别名和脚本简化操作
|
|||
|
|
- 逐步内化，减少检查清单依赖
|
|||
|
|
|
|||
|
|
### 问题5：团队成员协作时的冲突
|
|||
|
|
**解决方案：**
|
|||
|
|
- 建立统一的文档管理规范
|
|||
|
|
- 使用版本号避免冲突
|
|||
|
|
- 定期同步工作流程指南
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 🎮 实践建议
|
|||
|
|
|
|||
|
|
### 建议1：从简单开始
|
|||
|
|
- 先从一种文档类型开始练习（如章节）
|
|||
|
|
- 熟悉后再扩展到其他类型
|
|||
|
|
- 逐步增加复杂度
|
|||
|
|
|
|||
|
|
### 建议2：建立提醒机制
|
|||
|
|
- 在终端设置提示符
|
|||
|
|
- 设置定时任务
|
|||
|
|
- 每周检查一次
|
|||
|
|
|
|||
|
|
### 建议3：记录问题
|
|||
|
|
- 遇到问题记录到 `records/ISSUE_LOG.md`
|
|||
|
|
- 记录解决方案到 `records/DECISION_LOG.md`
|
|||
|
|
- 定期复盘，优化工作流程
|
|||
|
|
|
|||
|
|
### 建议4：定期复盘
|
|||
|
|
- 每周检查一次工作流程执行情况
|
|||
|
|
- 每月检查一次工作流程效果
|
|||
|
|
- 根据实际情况调整工作流程
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 🚀 立即行动
|
|||
|
|
|
|||
|
|
### 今天就可以开始
|
|||
|
|
1. **运行检查脚本：**
|
|||
|
|
```bash
|
|||
|
|
cd /root/.openclaw/workspace/novel-tracker
|
|||
|
|
./scripts/check-duplicates.sh
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
2. **设置别名：**
|
|||
|
|
```bash
|
|||
|
|
# 编辑 ~/.bashrc
|
|||
|
|
echo 'alias backup-outline="cd /<2F><>t/.openclaw/workspace/novel-tracker && ./scripts/backup-doc.sh outline"' >> ~/.bashrc
|
|||
|
|
echo 'alias backup-chapter="cd /root/.openclaw/workspace/novel-tracker && ./scripts/backup-doc.sh chapter"' >> ~/.bashrc
|
|||
|
|
|
|||
|
|
# 重新加载配置
|
|||
|
|
source ~/.bashrc
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
3. **阅读工作流程：**
|
|||
|
|
- 阅读 `DOC_MANAGEMENT_WORKFLOW.md`
|
|||
|
|
- 阅读 `CHECKLIST.md`
|
|||
|
|
- 阅读 `AUTOMATION_TOOLS_GUIDE.md`
|
|||
|
|
|
|||
|
|
4. **练习一次：**
|
|||
|
|
- 修改一次大纲（任意内容）
|
|||
|
|
- 使用 `backup-outline` 归档
|
|||
|
|
- 更新 `CHANGELOG.md`
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
**文档管理工作流程践行指南** v1.0
|
|||
|
|
**创建时间：** 2026-03-26 19:30
|
|||
|
|
**创建人：** 番茄小说创作助手
|