270 lines
8.1 KiB
Markdown
270 lines
8.1 KiB
Markdown
|
# 文档管理执行清单
|
|||
|
|
|
|||
|
|
**项目：** 《杀了婆婆的我却无人追责？》
|
|||
|
|
**创建时间：** 2026-03-26
|
|||
|
|
**目的：** 每次操作时快速检查，确保符合文档管理工作流程
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## ✅ 每次操作前的准备
|
|||
|
|
|
|||
|
|
### 通用准备（所有操作）
|
|||
|
|
- [ ] 已阅读相关工作流程（DOC_MANAGEMENT_WORKFLOW.md）
|
|||
|
|
- [ ] 已检查要修改的文档类型（大纲/章节/其他）
|
|||
|
|
- [ ] 已确认最新版本号（查看标题或INDEX.md）
|
|||
|
|
|
|||
|
|
### 大纲修改前
|
|||
|
|
- [ ] 已查看 `current/outline.md` 的当前版本号
|
|||
|
|
- [ ] 已确认修改类型（重大更新/重要修改/小修正）
|
|||
|
|
- [ ] 已规划新的版本号（vX.Y.Z规则）
|
|||
|
|
|
|||
|
|
### 章节修改前
|
|||
|
|
- [ ] 已查看 `current/chapter-XX.md` 的当前版本号
|
|||
|
|
- [ ] 已确认修改类型（重大更新/重要修改/小修正）
|
|||
|
|
- [ ] 已规划新的版本号（vX.Y规则）
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## ✅ 修改大纲时检查清单
|
|||
|
|
|
|||
|
|
### 第1步：归档旧版本
|
|||
|
|
- [ ] 已创建归档目录：`mkdir -p archive/outline-history/`
|
|||
|
|
- [ ] 已归档旧版本：`cp current/outline.md archive/outline-history/vX.Y.Z-YYYYMMDD.md`
|
|||
|
|
- [ ] 已确认归档成功：`ls archive/outline-history/`
|
|||
|
|
|
|||
|
|
### 第2步：修改新版本
|
|||
|
|
- [ ] 已更新 `current/outline.md` 的标题版本号
|
|||
|
|
- [ ] 已修改大纲内容
|
|||
|
|
- [ ] 已保存修改：`:w` 或 `Ctrl+S`
|
|||
|
|
|
|||
|
|
### 第3步：更新变更日志
|
|||
|
|
- [ ] 已更新 `CHANGELOG.md`，记录变更内容
|
|||
|
|
- [ ] 已包含版本号、时间、修改内容
|
|||
|
|
|
|||
|
|
### 第4步：记录问题修复（如适用）
|
|||
|
|
- [ ] 如果是问题修复，已更新 `records/ISSUE_LOG.md`
|
|||
|
|
- [ ] 已包含问题描述、讨论过程、修正方案
|
|||
|
|
|
|||
|
|
### 第5步：记录决策（如适用）
|
|||
|
|
- [ ] 如果是重要决策，已更新 `records/DECISION_LOG.md`
|
|||
|
|
- [ ] 已包含决策原因、影响范围
|
|||
|
|
|
|||
|
|
### 第6步：同步到飞书
|
|||
|
|
- [ ] 已在飞书标记旧大纲：标题前加 `[旧]`
|
|||
|
|
- [ ] 已创建新大纲文档：`《XXX》32章完整大纲（vX.Y.Z）`
|
|||
|
|
- [ ] 已更新项目导航文档（INDEX.md）
|
|||
|
|
- [ ] 已确认新文档链接正确
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## ✅ 修改章节时检查清单
|
|||
|
|
|
|||
|
|
### 第1步：归档旧版本
|
|||
|
|
- [ ] 已创建归档目录：`mkdir -p archive/chapter-history/chapter-XX/`
|
|||
|
|
- [ ] 已归档旧版本：`cp current/chapter-XX.md archive/chapter-history/chapter-XX/vX.Y-YYYYMMDD.md`
|
|||
|
|
- [ ] 已更新 `archive/chapter-history/chapter-XX/CHANGELOG.md`
|
|||
|
|
- [ ] 已确认归档成功
|
|||
|
|
|
|||
|
|
### 第2步：修改新版本
|
|||
|
|
- [ ] 已更新 `current/chapter-XX.md` 的标题版本号
|
|||
|
|
- [ ] 已修改章节内容
|
|||
|
|
- [ ] 已保存修改：`:w` 或 `Ctrl+S`
|
|||
|
|
|
|||
|
|
### 第3步：更新变更日志
|
|||
|
|
- [ ] 已更新 `CHANGELOG.md`，记录章节变更
|
|||
|
|
- [ ] 已包含版本号、时间、修改内容
|
|||
|
|
|
|||
|
|
### 第4步：同步到飞书
|
|||
|
|
- [ ] 已在飞书标记旧章节：标题前加 `[旧]`
|
|||
|
|
- [ ] 已创建新章节文档：`第X章：章节名（vX.Y）`
|
|||
|
|
- [ ] 已更新项目导航文档（INDEX.md）
|
|||
|
|
- [ ] 已更新项目导航中的表格（字数、QC评分、版本）
|
|||
|
|
- [ ] 已确认新文档链接正确
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## ✅ 创建新章节时检查清单
|
|||
|
|
|
|||
|
|
### 第1步：创建本地文件
|
|||
|
|
- [ ] 已在 `current/` 目录创建：`chapter-XX.md`
|
|||
|
|
- [ ] 已设置正确的章节标题
|
|||
|
|
- [ ] 已设置版本号为 v1.0
|
|||
|
|
- [ ] 已按照大纲创作内容
|
|||
|
|
|
|||
|
|
### 第2步：更新INDEX.md
|
|||
|
|
- [ ] 已在"已完成章节"表格中添加新章节
|
|||
|
|
- [ ] 已填写章节名、字数、QC评分、版本号、状态
|
|||
|
|
- [ ] 已更新"完成度"和"总字数"
|
|||
|
|
- [ ] 已更新"章节规划"部分
|
|||
|
|
|
|||
|
|
### 第3步：更新CHANGELOG.md
|
|||
|
|
- [ ] 已在 CHANGELOG.md 记录新章节创建
|
|||
|
|
- [ ] 已包含章节名、时间、字数、状态
|
|||
|
|
|
|||
|
|
### 第4步：同步到飞书
|
|||
|
|
- [ ] 已创建新章节文档：`第X章：章节名（v1.0）`
|
|||
|
|
- [ ] 已更新项目导航文档（INDEX.md）
|
|||
|
|
- [ ] 已添加新章节链接到"已完成章节"部分
|
|||
|
|
- [ ] 已更新项目导航中的表格
|
|||
|
|
- [ ] 已确认新文档链接正确
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## ✅ 发现问题时检查清单
|
|||
|
|
|
|||
|
|
### 第1步：记录问题
|
|||
|
|
- [ ] 已在 `records/ISSUE_LOG.md` 记录问题
|
|||
|
|
- [ ] 已包含问题描述、发现时间、问题影响
|
|||
|
|
|
|||
|
|
### 第2步：讨论解决方案
|
|||
|
|
- [ ] 已讨论可能的解决方案
|
|||
|
|
- [ ] 已确定最终解决方案
|
|||
|
|
- [ ] 已记录解决方案到 `records/ISSUE_LOG.md`
|
|||
|
|
|
|||
|
|
### 第3步：执行修正
|
|||
|
|
- [ ] 已修改 `current/outline.md` 或 `current/chapter-XX.md`
|
|||
|
|
- [ ] 已确认修正正确
|
|||
|
|
|
|||
|
|
### 第4步：更新相关文档
|
|||
|
|
- [ ] 已更新 `CHANGELOG.md`
|
|||
|
|
- [ ] （可选）已更新飞书相关文档
|
|||
|
|
- [ ] 已确认所有相关文档都已更新
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## ✅ 每周检查清单
|
|||
|
|
|
|||
|
|
### 每周一检查
|
|||
|
|
- [ ] 检查 `current/` 目录，确认所有文档都是最新版本
|
|||
|
|
- [ ] 检查飞书核心文档，确认没有重复文档
|
|||
|
|
- [ ] 检查是否有未归档的旧版本
|
|||
|
|
|
|||
|
|
### 每周二检查
|
|||
|
|
- [ ] 检查 `CHANGELOG.md`，确认最近更新都已记录
|
|||
|
|
- [ ] 检查 `records/ISSUE_LOG.md`，确认所有问题都有跟进
|
|||
|
|
- [ ] 检查 `records/DECISION_LOG.md`，确认所有决策都有记录
|
|||
|
|
|
|||
|
|
### 每周三检查
|
|||
|
|
- [ ] 检查飞书归档文档，确认标记为 [旧] 的文档是否可以删除
|
|||
|
|
- [ ] 检查本地 `archive/` 目录，确认归档文件命名规范
|
|||
|
|
|
|||
|
|
### 每周五检查
|
|||
|
|
- [ ] 汇总本周变更，检查是否都符合工作流程
|
|||
|
|
- [ ] 检查下周工作计划，确认是否需要调整流程
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## ✅ 每月检查清单
|
|||
|
|
|
|||
|
|
### 每月第1周
|
|||
|
|
- [ ] 全面检查所有文档版本号
|
|||
|
|
- [ ] 检查飞书和本地文档是否同步
|
|||
|
|
- [ ] 清理可以删除的旧文档
|
|||
|
|
|
|||
|
|
### 每月最后一周
|
|||
|
|
- [ ] 备份所有核心文档到网盘
|
|||
|
|
- [ ] 导出飞书文档备份
|
|||
|
|
- [ ] 检查并优化工作流程
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 🎯 实用技巧
|
|||
|
|
|
|||
|
|
### 技巧1：快速版本号规则记忆
|
|||
|
|
```
|
|||
|
|
大纲：v10.1.2（主10.次版.第1次修订.第2次修正）
|
|||
|
|
章节：v2.0（主2版.无修订）
|
|||
|
|
章节：v2.1（主2版.第1次修订）
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 技巧2：快速归档命令
|
|||
|
|
```bash
|
|||
|
|
# 归档大纲
|
|||
|
|
cp current/outline.md archive/outline-history/v10.1.2-$(date +%Y%m%d).md
|
|||
|
|
|
|||
|
|
# 归档章节
|
|||
|
|
cp current/chapter-05.md archive/chapter-history/chapter-05/v1.0-$(date +%Y%m%d).md
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 技巧3：快速检查重复文档
|
|||
|
|
```bash
|
|||
|
|
# 检查飞书重复文档（手动操作）
|
|||
|
|
- 搜索标题包含"大纲"的文档
|
|||
|
|
- 检查标题中是否没有 [旧] 标记
|
|||
|
|
- 如果多个文档没有 [旧] 标记，说明有重复
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 技巧4：版本号命名提醒
|
|||
|
|
- 每次修改前，先在标题查看当前版本号
|
|||
|
|
- 重大修改：主版本+1（v10 → v11）
|
|||
|
|
- 重要修改：次版本+1（v10.1 → v10.2）
|
|||
|
|
- 小修正：修订版+1（v10.1.1 → v10.1.2）
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 🚨 常见错误和预防
|
|||
|
|
|
|||
|
|
### 错误1：忘记归档旧版本
|
|||
|
|
**预防：**
|
|||
|
|
- 设置一个检查点：每次打开 `current/` 目录下的文档，先检查是否已归档
|
|||
|
|
- 在文档顶部添加"修改前必须归档"的提醒
|
|||
|
|
|
|||
|
|
### 错误2：忘记更新CHANGELOG.md
|
|||
|
|
**预防：**
|
|||
|
|
- 每次修改完成后，立即检查 CHANGELOG.md
|
|||
|
|
- 在 CHANGELOG.md 顶部添加"上次更新：XXXX-XX-XX"的提醒
|
|||
|
|
|
|||
|
|
### 错误3：飞书和本地不同步
|
|||
|
|
**预防：**
|
|||
|
|
- 每次本地修改后，立即同步到飞书
|
|||
|
|
- 在工作流程中添加"同步到飞书"作为必做步骤
|
|||
|
|
|
|||
|
|
### 错误4：创建重复文档
|
|||
|
|
**预防：**
|
|||
|
|
- 创建前先搜索飞书，确认没有重复
|
|||
|
|
- 使用统一的命名规范
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 🎮 实践建议
|
|||
|
|
|
|||
|
|
### 建议1：培养习惯
|
|||
|
|
1. **首次操作时：** 仔细阅读工作流程指南
|
|||
|
|
2. **前3次操作：** 每次操作都对照检查清单
|
|||
|
|
3. **第4次操作后：** 逐渐形成习惯，简化检查
|
|||
|
|
|
|||
|
|
### 建议2：创建快捷命令
|
|||
|
|
1. 创建归档快捷脚本（backup.sh）
|
|||
|
|
2. 创建版本号更新快捷命令（version.sh）
|
|||
|
|
3. 创建同步飞书快捷命令（sync-feishu.sh）
|
|||
|
|
|
|||
|
|
### 建议3：设置提醒
|
|||
|
|
1. 每周一提醒：检查文档结构
|
|||
|
|
2. 每月1日提醒：备份文档
|
|||
|
|
3. 每次完成重要修改后：检查同步
|
|||
|
|
|
|||
|
|
### 建议4：定期复盘
|
|||
|
|
1. 每月检查：工作流程是否需要调整
|
|||
|
|
2. 每次遇到问题：记录到 ISSUE_LOG.md
|
|||
|
|
3. 每次优化：更新工作流程指南
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 📋 使用说明
|
|||
|
|
|
|||
|
|
### 使用方法
|
|||
|
|
1. 每次操作前，打印或查看对应的检查清单
|
|||
|
|
2. 逐项检查，完成一项打一个勾
|
|||
|
|
3. 确保所有检查项都完成后再继续
|
|||
|
|
|
|||
|
|
### 完成标准
|
|||
|
|
- 所有必选项都已打勾
|
|||
|
|
- 所有可选项根据实际情况决定
|
|||
|
|
- 如果有未完成的检查项，不继续操作
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
**执行清单 v1.0**
|
|||
|
|
**创建时间：** 2026-03-26 19:20
|
|||
|
|
**创建人：** 番茄小说创作助手
|