liyuchen/novel-doomsday-resurgence
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
5dc8c00de0
novel-doomsday-resurgence/novel-tracker/DOC_MANAGEMENT_WORKFLOW.md
唐天洛 bc9188b0fd feat(git-workflow): 添加 Git 工作流和脚本 
包含：
- GIT_WORKFLOW.md - 详细的 Git 工作流规范
- scripts/git-setup.sh - Git 工作区初始化脚本
- scripts/git-daily.sh - 日常 Git 管理脚本
- scripts/git-novel-workflow.sh - 小说专用 Git 工作流
- 更新 .gitignore 排除子仓库的 .git 目录
- 添加 novel-tracker/ 目录
- 添加 projects/ 目录（排除子仓库 .git）
- 添加 tomato-novel/ 目录
2026-03-30 15:50:36 +08:00

9.4 KiB
Raw Blame History

文档管理工作流程指南

项目： 《杀了婆婆的我却无人追责？》 更新时间： 2026-03-26 目的： 确保所有文档合理归档，避免产生重复文档

🎯 核心原则

1. 唯一最新原则

  • 每个文档类型只保留一个最新版本
  • 最新版本在 current/ 目录（本地）或飞书核心文档
  • 旧版本归档到 archive/ 目录（本地）或标记为 [旧]（飞书）

2. 先备份后修改

  • 每次修改 current/ 下的文档前，先归档旧版本
  • 归档格式：archive/xxx-history/文件名-vX.X-YYYYMMDD.md
  • 飞书操作：创建新版本时，保留旧版本文档，在标题加 [旧]

3. 集中记录原则

  • 问题修复：记录在 records/ISSUE_LOG.md（本地）或问题修复记录（飞书）
  • 决策记录：记录在 records/DECISION_LOG.md（本地）或决策记录（飞书）
  • 变更日志：记录在 CHANGELOG.md（本地或飞书）

📋 文档类型和工作流程

类型1：大纲修改

本地操作流程：

  1. 归档旧版本：cp current/outline.md archive/outline-history/v10.1.2-20260326.md
  2. 修改 current/outline.md
  3. 更新 CHANGELOG.md
  4. 同步到飞书（创建新大纲文档）

飞书操作流程：

  1. 标记旧大纲文档：在标题前加 [旧]
  2. 创建新大纲文档：《杀了婆婆的我却无人追责？》32章完整大纲（v10.1.2）
  3. 更新项目导航文档：更新大纲链接
  4. 更新变更记录：添加新版本说明

类型2：章节修改

本地操作流程：

  1. 归档旧版本：cp current/chapter-05.md archive/chapter-history/chapter-05/v1.0.md
  2. 修改 current/chapter-05.md
  3. 更新 archive/chapter-history/chapter-05/CHANGELOG.md
  4. 更新 CHANGELOG.md
  5. 同步到飞书（创建新章节文档）

飞书操作流程：

  1. 标记旧章节文档：在标题前加 [旧]
  2. 创建新章节文档：第X章：章节名（vX.X）
  3. 更新项目导航文档：更新章节链接
  4. 更新变更记录：添加新版本说明

类型3：章节创建

本地操作流程：

  1. 直接在 current/ 目录创建：current/chapter-06.md
  2. 更新 INDEX.md：添加新章节到"章节进度"
  3. 更新 CHANGELOG.md
  4. 同步到飞书（创建新章节文档）

飞书操作流程：

  1. 创建新章节文档：第X章：章节名（v1.0）
  2. 更新项目导航文档：添加新章节链接
  3. 更新变更记录：添加新章节说明

类型4：问题修复

本地操作流程：

  1. 更新 records/ISSUE_LOG.md：添加问题修复记录
  2. 如果需要，修改 current/outline.md 或 current/chapter-XX.md
  3. 更新 CHANGELOG.md
  4. （可选）同步到飞书：更新问题修复说明文档

飞书操作流程：

  1. 更新问题修复说明文档：⚠️ 问题修复记录
  2. 如果需要，修改相关文档
  3. 更新项目导航文档：更新版本号
  4. 更新变更记录

类型5：决策记录

本地操作流程：

  1. 更新 records/DECISION_LOG.md：添加决策记录
  2. 如果需要，修改 current/outline.md
  3. 更新 CHANGELOG.md
  4. （可选）同步到飞书：更新决策记录文档

飞书操作流程：

  1. 更新决策记录文档：💡 决策记录
  2. 如果需要，修改相关文档
  3. 更新项目导航文档
  4. 更新变更记录

📁 目录结构规范

本地目录结构

novel-tracker/
├── current/                    # 【最新有效内容】
│   ├── outline.md             # 唯一最新大纲
│   ├── chapter-01.md          # 第1章最新版
│   ├── chapter-02.md          # 第2章最新版
│   └── ...
├── archive/                    # 【历史归档】
│   ├── outline-history/        # 大纲历史版本
│   │   ├── v9.0-20260322.md
│   │   ├── v10.0-20260325.md
│   │   └── v10.1.1-20260326.md
│   ├── chapter-history/       # 章节历史版本
│   │   ├── chapter-01/
│   │   │   ├── v1.0.md
│   │   │   ├── v2.0.md
│   │   │   ├── v2.2.md
│   │   │   └── CHANGELOG.md
│   │   └── ...
│   └── ...
├── records/                   # 【问题记录和决策】
│   ├── ISSUE_LOG.md           # 问题修复日志
│   └── DECISION_LOG.md        # 决策记录
├── INDEX.md                   # 项目总览（导航中心）
├── CHANGELOG.md              # 全局变更日志
└── ...

飞书文档结构

  • 核心文档（最新有效）： 8个

    • 项目导航文档
    • 32章完整大纲（最新版）
    • 第1-5章（最新版）
    • 文档整合说明

  • 历史文档（保留）： 1-2个

    • 2026-03-21 消息记录（重要讨论和版本演进）

  • 归档文档（标记）： 13个

    • 标记为 [旧] 的旧版本文档

🔄 常见场景操作流程

场景1：发现新问题需要修复大纲

本地操作：

  1. ✅ 更新 records/ISSUE_LOG.md：记录问题描述
  2. ✅ 归档旧大纲：cp current/outline.md archive/outline-history/vX.X.X-YYYYMMDD.md
  3. ✅ 修改 current/outline.md：修复问题
  4. ✅ 更新 CHANGELOG.md：记录变更
  5. ✅ 同步飞书：创建新大纲文档

飞书操作：

  1. ✅ 标记旧大纲：[旧] 标题
  2. ✅ 创建新大纲：vX.X.X版本
  3. ✅ 更新导航文档
  4. ✅ 更新变更记录

场景2：修改已完成的章节

本地操作：

  1. ✅ 归档旧章节：cp current/chapter-XX.md archive/chapter-history/chapter-XX/vX.X-YYYYMMDD.md
  2. ✅ 修改 current/chapter-XX.md：修改内容
  3. ✅ 更新 archive/chapter-history/chapter-XX/CHANGELOG.md：记录版本历史
  4. ✅ 更新 CHANGELOG.md：记录变更
  5. ✅ 同步飞书：创建新章节文档

飞书操作：

  1. ✅ 标记旧章节：[旧] 标题
  2. ✅ 创建新章节：vX.X版本
  3. ✅ 更新导航文档
  4. ✅ 更新变更记录

场景3：创作新章节

本地操作：

  1. ✅ 直接创建：current/chapter-XX.md
  2. ✅ 更新 INDEX.md：添加新章节
  3. ✅ 更新 CHANGELOG.md：记录新章节
  4. ✅ 同步飞书：创建新章节文档

飞书操作：

  1. ✅ 创建新章节：第X章：章节名（v1.0）
  2. ✅ 更新导航文档
  3. ✅ 更新变更记录

场景4：发现新的创作决策

本地操作：

  1. ✅ 更新 records/DECISION_LOG.md：记录决策
  2. ✅ 如果需要，修改 current/outline.md
  3. ✅ 更新 CHANGELOG.md
  4. ✅ （可选）同步飞书

飞书操作：

  1. ✅ 更新决策记录文档
  2. ✅ 如果需要，修改相关文档
  3. ✅ 更新导航文档
  4. ✅ 更新变更记录

⚠️ 禁止操作

❌ 禁止创建多余文档

  • 不要在飞书上创建重复的大纲文档
  • 不要在飞书上创建重复的章节文档
  • 不要创建不必要的临时文档
  • 不要在多个地方记录同一件事

❌ 禁止修改归档文档

  • 不要修改 archive/ 目录下的历史版本
  • 不要修改标记为 [旧] 的飞书文档
  • 不要修改历史讨论文档（除非有重要补充）

❌ 禁止跳过备份

  • 不要在修改 current/ 下的文档前不先归档旧版本
  • 不要在修改飞书文档前不先标记旧版本

✅ 推荐操作

✅ 每次修改必做

  1. 归档旧版本（本地）或标记旧文档（飞书）
  2. 修改最新版本
  3. 更新变更日志
  4. 更新导航文档

✅ 每次创作必做

  1. 在正确位置创建新文档
  2. 更新导航文档
  3. 更新变更记录

✅ 每次发现问题必做

  1. 记录到问题修复日志
  2. 如果需要，修改相关文档
  3. 更新变更记录

📝 检查清单

修改大纲后

  • 旧版本已归档到 archive/outline-history/
  • current/outline.md 已修改
  • CHANGELOG.md 已更新
  • 飞书旧大纲已标记 [旧]
  • 飞书新大纲已创建
  • 飞书导航文档已更新

修改章节后

  • 旧版本已归档到 archive/chapter-history/chapter-XX/
  • current/chapter-XX.md 已修改
  • archive/chapter-history/chapter-XX/CHANGELOG.md 已更新
  • CHANGELOG.md 已更新
  • 飞书旧章节已标记 [旧]
  • 飞书新章节已创建
  • 飞书导航文档已更新

创建新章节后

  • current/chapter-XX.md 已创建
  • INDEX.md 已更新
  • CHANGELOG.md 已更新
  • 飞书新章节已创建
  • 飞书导航文档已更新

发现问题后

  • records/ISSUE_LOG.md 已更新
  • 相关文档已修改
  • CHANGELOG.md 已更新

🎯 预防措施

1. 定期检查

  • 每周检查一次 current/ 目录
  • 每周检查一次飞书核心文档
  • 每周检查一次是否有多余文档

2. 版本管理

  • 每个文档都有明确的版本号（vX.X.X）
  • 每次修改都更新版本号
  • 旧版本都归档，不删除

3. 备份策略

  • 本地文件定期备份到网盘
  • 飞书文档定期导出备份
  • 重要记录多重备份

🚀 自动化建议（可选）

脚本辅助

可以创建以下脚本辅助管理：

  1. backup-doc.sh - 自动归档文档
  2. update-nav.sh - 自动更新导航文档
  3. check-dupes.sh - 检查重复文档

工具使用

  • 使用版本控制工具（如Git）
  • 使用文档对比工具检查变更
  • 使用自动化脚本减少人工错误

文档管理工作流程指南 v1.0 创建时间： 2026-03-26 创建人： 番茄小说创作助手