Book Pipeline

book-pipeline

從 Obsidian 研究筆記到 KDP 電子書上架的完整製作流程。

一套完全通用的 7 階段 SOP,協助你將分散的研究筆記、概念分析、草稿整合成符合 EPUB 3 規範的電子書,並順利在 Amazon KDP 上架。無論是非虛構分析書、學術普及書、影視文化評論,或任何類型的文字創作,都可以直接套用。


目錄


這個工具能做什麼

book-pipeline 解決「寫完了,但不知道怎麼變成電子書」的問題。

你只需要:

  1. 在 Obsidian 裡寫好研究筆記和章節草稿
  2. 跟著 SOP 操作
  3. 執行一個 Python 腳本

就能得到:

  • 一本通過 epubcheck 驗證的 EPUB 3 電子書
  • 完整的 KDP 上架 metadata(書名、描述、BISAC、關鍵字)
  • 可在 Kindle Previewer 3 預覽的排版效果

適合的書籍類型

  • 非虛構分析書(影視評論、文化研究、社會觀察)
  • 學術普及書(理論入門、主題深度解讀)
  • 散文集、評論集
  • 任何以 Markdown 寫作的文字創作

設計哲學 (Pipeline Philosophy)

本工具的核心邏輯基於以下三個支柱,理解這些思維將幫助你更流暢地使用:

  1. 思維與寫作分離 (Drafting vs. Formatting): 在 Stage 0-1 (Obsidian),你只需專注於論點展開與概念連結,隨意使用 Obsidian 的強大功能。
  2. 概念即節點 (Concept as Node): 不要「一篇文章寫到底」。將核心學術術語或分析對象建立為獨立的 Tags/ 節點,這能確保你的理論框架在整本書中保持一致,且易於維護。
  3. 單向流水線 (One-way Pipeline): Pipeline 的流向是單向的:Obsidian -> Source_Clean -> EPUB。這確保了最終輸出的穩定性。修改內容時,應回到 Source 或 Components 進行,而非修改產出的建置檔。

工作流程總覽

Stage 0  環境安裝與驗證                     ← 觸發:「安裝環境」、「check_env」
               ↓  [INSTALL-WINDOWS.md]
Stage 1  脈絡交接 (00-SESSION-SETUP)       ← 觸發:「脈絡交接」、「恢復進度」
               ↓  [00-SESSION-SETUP]
Stage 2  新書專案初始化 + 草稿方法論         ← 觸發:「新書專案初始化」、「建立新書」
               ↓  [02-DRAFTING]
Stage 3  Obsidian 草稿整合                 ← 觸發:「概念節點」、「建立 Tag」
               ↓  [03-OBSIDIAN-TO-DRAFT]
Stage 4  整合書稿 → Source_Clean_EN.md     ← 觸發:「整合 Obsidian 草稿」
               ↓  [04-SOURCE + 05-EDITORIAL-QA]
Stage 5  格式規範 + 排版 QA                ← 觸發:「書稿 QA」、「linter 掃描」
               ↓  [06-EPUB-BUILD]
Stage 6  EPUB 建置 + epubcheck 驗證 → Output/  ← 觸發:「建置 EPUB」、「build pipeline」
               ↓  [07-PUBLISHING-PREP]
Stage 7  KDP Metadata 準備                 → KDP/   ← 觸發:「先寫出版資訊」、「BISAC」
               ↓  [08-SUBMISSION]
Stage 8  KDP 後台提交 → 上架                  ← 觸發:「KDP 上架」、「提交 KDP」

每個階段有對應的 模組文件modules/)和 操作清單checklists/),可單獨查閱,也可按序執行。

AI 協作註:每個階段的「觸發」標註了可直接對 AI 說出的語句。完整觸發語句可查閱 SKILL.md


方法論:為什麼用 Obsidian 寫書

核心概念:Tag 作為知識圖譜骨幹

一般的寫作工具讓你「一篇文章寫到底」。book-pipeline 的方法不同:

把每個核心概念建成獨立節點(存放在 Tags/),讓章節草稿透過 #TagName 引用這些概念,在 Obsidian Graph View 中自動形成概念知識圖譜

好處:

  • 你能清楚看到「哪個概念在哪幾個章節中出現」
  • 整合草稿時,可以「沿著概念脈絡」組織章節順序
  • 概念定義只需要寫一次,所有引用章節自動連結

草稿的三個層次

Tags/             ← 概念定義層(理論框架)
    ↓ 引用
Components/         ← 章節草稿層(論點展開)
    ↓ 整合
Source_Clean_EN.md  ← 書稿整合層(出版準備)

這個分層讓你在寫作階段保持彈性(隨時加概念、改草稿),在整合階段保持嚴謹(統一格式、確認架構)。

include 欄位:整合的開關

每個草稿筆記的 frontmatter 有一個 include 欄位:

---
book: Your Book Title
chapter: Chapter 1
status: complete
include: yes    # yes / no / maybe
---
  • yes → 整合進 Source_Clean_EN.md
  • no → 僅供研究參考,不進書稿
  • maybe → 待決策

整合階段(Stage 1)只抓 include: yes 的筆記,你不需要手動篩選。


需要安裝的工具

Python 套件(必要)

Windows 用戶(推薦):直接雙擊 0_setup.bat,自動完成安裝。

macOS / Linux 用戶:在終端機執行:

cd path/to/book-pipeline
pip install -r requirements.txt
套件版本用途
ebooklib≥ 0.18EPUB 3 建置與寫入
Markdown≥ 3.4Markdown → HTML 轉換(含表格支援)
Pillow≥ 9.0封面圖片壓縮(自動轉 RGB、縮減至 < 3 MB)
PyYAML≥ 6.0讀取 book.yaml 書籍設定檔

自動化腳本清單(內建於 Tools/)

腳本用途
obsidian_cleaner.py核心清洗:自動清除 Obsidian 語法(Wikilinks, Tags, Callouts)
merge_drafts.py自動合併:掃描 Components/ 並根據 include: yes 合併書稿
verify_source.pyQA 掃描:偵測書稿中的 P1/P2/P3 排版錯誤
kdp_manifest_gen.py上架清單:生成用於 KDP 填寫的 Metadata 彙整檔
build.py流水線控制器:執行封面壓縮、QA 掃描、EPUB 建置、驗證、清單生成

外部工具(必要)

工具版本用途下載
Python≥ 3.8執行所有腳本python.org
Java≥ 11執行 epubcheckEclipse Adoptium
epubcheck5.1.0EPUB 3 合規驗證GitHub Releases
Kindle Previewer 3最新版EPUB 視覺預覽(Windows 優先)Amazon 官網

寫作工具(強烈建議)

工具用途下載
Obsidian草稿管理、Graph View 概念視覺化obsidian.md

Obsidian 免費,無需帳號,資料全部存為本機 Markdown 文件。

工具安裝順序建議

Windows 新手請改看 INSTALL-WINDOWS.md,有逐步說明與常見問題。

一般流程:

  1. 安裝 Python 3.8+(Windows:安裝時勾選「Add Python to PATH」)
  2. 雙擊 0_setup.bat(或執行 pip install -r requirements.txt
  3. 安裝 Java 11+(epubcheck 需要)
  4. 下載 epubcheck 5.1.0,解壓縮至 ~/epubcheck/
  5. 安裝 Kindle Previewer 3(選用)
  6. 安裝 Obsidian(並建立 vault)
  7. 執行 python check_env.py 確認環境就緒

從零開始的完整操作路徑

本節將操作分為三個核心階段:環境準備 (Mindset: Ready)、專案初始化 (Mindset: Setting up)、以及 寫作與建置 (Mindset: Executing)。

Phase A: 環境準備 (One-time Setup)

目標:建立一個可執行 Python、Java 與驗證工具的基礎環境。

Step 1 — 下載 book-pipeline 到 GitHub 下載 zip → 解壓縮到 D:\Projects\book-pipeline\

Step 2 — 安裝 Python 下載 python.org 安裝程式,執行時務必勾選「Add Python to PATH」

Step 3 — 初始化工具集 進入該資料夾,雙擊 0_setup.bat。這會安裝所有必要的 Python 套件。

Step 4 — 驗證工具 (Java + epubcheck)

  1. 安裝 Java (預設安裝即可)。
  2. 下載 epubcheck 並解壓縮。

Step 5 — 終端機確認 執行 python check_env.py

  • 邏輯:此步驟是為了確保後續的建置流程不會因為路徑或環境缺失而中斷。
  • 完成標準:輸出 4/4 必要項目通過

Phase B: 專案啟動 (Per Book)

目標:為每一本新書建立獨立的「沙盒」環境。

Step 6 — 建立專案資料夾 雙擊 1_new_book.bat

  • 邏輯:建立獨立資料夾可避免不同書籍的草稿與設定混淆。

Step 7 — 調整 book.yaml 在書籍資料夾中開啟 book.yaml,填入作者、書名,並指向正確的 epubcheck.jar 路徑。

  • 完成標準book.yaml 已儲存且路徑無誤。

Phase C: 核心循環 (Execution & Build)

目標:將 Obsidian 內的思維火花轉換為標準出版格式。

Step 8 — 草稿寫作 (Obsidian)Components/ 資料夾中進行創作。

  • 思路邏輯:使用 #TagName 連結概念,將 include: yes 用作「進入流水線」的閘門。

Step 9 — 全自動整合指令: 在書籍根目錄執行:

python Tools/merge_drafts.py

這會掃描 Components/ 資料夾 目錄,清除 Obsidian 語法並根據 order 欄位合併章節。

  • 執行結果:自動生成最新的 Source_Clean_EN.md

Step 10 — 一鍵建置 雙擊 2_build.bat

  • 執行流程
    1. 封面壓縮:將原圖調整至符合 KDP 規則。
    2. QA 掃描:執行 verify_source.py (Linter),若有 P1 錯誤則終止。
    3. EPUB 建置:生成最終檔案。
    4. 合規驗證:自動執行 epubcheck。
    5. 清單生成:生成上架專用的 KDP/SUBMISSION_MANIFEST.md
  • 完成標準Output/ 出現 .epub 且顯示 0 errors

📚 准備動手?接著看實戰教學

TUTORIAL.md 以《異類的堡壘》為完整案例,逐步示範上述 Stage 0–7 的所有操作細節。

  • 包含真實腳本執行輸出、安全檢查點、常見錯誤處理
  • 如果你是第一次使用 book-pipeline,建議從這里開始

專案資料夾結構

book-pipeline(本工具)

book-pipeline/
├── modules/               # 各階段操作說明
│   ├── 00-SESSION-SETUP.md    ← Session 設定、脈絡恢復
│   ├── 02-DRAFTING.md         ← 草稿方法論、Tag 節點模板
│   ├── 03-OBSIDIAN-TO-DRAFT.md← Obsidian 草稿整合流程
│   ├── 04-SOURCE-MANAGEMENT.md← 書稿格式規範
│   ├── 05-EDITORIAL-QA.md     ← 排版 QA 框架
│   ├── 06-EPUB-BUILD.md       ← EPUB 建置 SOP
│   ├── 07-PUBLISHING-PREP.md  ← KDP 出版準備
│   └── 08-SUBMISSION.md       ← KDP 後台提交指引
├── checklists/            # 各階段操作清單
│   ├── obsidian-cleanup.md
│   ├── epub-qa.md
│   └── kdp-submission.md
├── templates/             # 可直接複製使用的腳本模板
│   ├── epub_builder.py        ← EPUB 建置主腳本
│   ├── build.py               ← Pipeline 執行腳本
│   ├── watch_epub.py          ← 自動預覽 watcher(Windows)
│   ├── book.yaml              ← 書籍設定檔模板
│   ├── 2_build.bat            ← 雙擊建置 EPUB(複製到書籍根目錄)
│   ├── 3_preview.bat          ← 雙擊啟動自動預覽(複製到書籍根目錄)
│   └── kdp-description.md    ← KDP 書籍描述模板
├── examples/              # 範例參考(完整書籍專案示範)
│   ├── README.md
│   ├── Components/            ← 範例章節草稿(Obsidian 格式)
│   ├── Tags/                ← 範例概念 Tag 節點
│   └── Source_Clean_EN_sample.md ← 整合後書稿範例
├── SKILL.md               # AI Agent 快速索引
├── TUTORIAL.md            # 完整教學(含真實案例)
├── FAQ-KDP.md             # KDP 上架常見問題
└── requirements.txt       # Python 依賴

書籍專案(你建立的)

{YourBook}/
├── Components/            # Obsidian 章節草稿(原始輸入,不修改)
│   ├── BookTitle—0.Front Matter.md
│   ├── BookTitle—1.Chapter One Title.md
│   ├── BookTitle—2.Chapter Two Title.md
│   └── BookTitle—Appendix.Bibliography.md
├── Tags/                # 概念 Tag 節點
│   └── {AnalysisDomain}/
│       ├── ConceptA.md
│       └── ConceptB.md
├── Source_Clean_EN.md     # 整合後書稿(主工作文件)
├── Source_Clean_CN.md     # 繁體中文版(若有)
├── cover.jpg              # 封面原圖(高解析度)
├── book.yaml              # 書籍設定檔(填入書名、作者、路徑等)
├── 2_build.bat            # 雙擊建置 EPUB(Windows)
├── 3_preview.bat          # 雙擊啟動自動預覽(Windows)
├── KDP/
│   └── KDP-description.md # 書籍描述(HTML 格式)
├── Tools/
│   ├── epub_builder.py    # EPUB 建置主腳本
│   ├── build.py           # Pipeline 執行腳本
│   └── watch_epub.py      # 自動預覽 watcher(Windows)
└── Output/
    ├── {Title}_Final.epub
    └── cover_compressed.jpg

各階段說明

Stage 0:草稿方法論(Obsidian)

目標:建立概念 Tag 節點,以 Obsidian 寫作並管理章節草稿。

做什麼

  • Tags/ 為每個核心概念建立獨立 .md 節點(定義、出處、關聯)
  • Components/ 以標準格式寫作章節草稿
  • #TagName 連結概念到草稿,建立知識圖譜
  • 草稿 frontmatter 標注 include: yes/no/maybe

判斷可進下一階段的條件

  • 所有規劃章節的草稿 include: yes 已完成
  • 草稿中的 - [ ] 待辦清單已清空
  • 概念 Tag 節點定義完整

詳細說明:modules/02-DRAFTING.md


Stage 1:Obsidian 草稿整合

目標:將分散的 Components/ 草稿合併為統一書稿 Source_Clean_EN.md

做什麼

  • 盤點 Components/ 並確認章節順序
  • 清除所有 Obsidian 專屬語法:
Obsidian 語法處理方式
Wikilinks ([[概念]])移除括號,保留文字
Hashtags (#TagName)完全刪除
標注 (> [!note])轉換為 > **Note**:
隱藏注解 (%%...%%)完全刪除
高亮 (==文字==)移除標記,保留文字
待辦清單 (- [ ])完全刪除
  • 規範化標題層級(## 章節 / ### 節 / #### 子節)
  • 依確認順序合併所有章節

詳細說明:modules/03-OBSIDIAN-TO-DRAFT.md


Stage 2–3:格式規範 + 排版 QA

Stage 2(04-SOURCE-MANAGEMENT)是「對照清單」,確認格式是否符合規範; Stage 3(05-EDITORIAL-QA)是「掃描工具」,找出並修正六類常見問題。 兩個階段可在同一 session 完成。

目標:確保 Source_Clean_EN.md 格式完全符合 EPUB 轉換需求。

格式規範重點

用途格式
關鍵詞*italic*
重要概念**bold**
書名 / 作品名*italic*
學術引用> blockquote
列表統一用 -

禁止的格式

  • 反引號作文字強調(`key term` → 改用 *key term*
  • 雙重分隔線(------
  • 標題層級跳躍(## 直接到 ####

QA 自動掃描

python Tools/verify_source.py Source_Clean_EN.md
[QA Report] Source_Clean_EN.md
-------------------
[P1] Heading check: ERROR (Jump detected L2 -> L4 at line 145)
[P1] Callout check: ERROR (Unconverted callout at line 210)
[P2] Emphasis check: WARN (Backticks used for emphasis at line 56)
-------------------
Summary: 2 P1, 1 P2, 0 P3

詳細說明:modules/04-SOURCE-MANAGEMENT.md | modules/05-EDITORIAL-QA.md


Stage 4:EPUB 建置

目標:從書稿自動建置 EPUB 3,通過 epubcheck 驗證。

執行建置

Windows 用戶:雙擊書籍根目錄裡的 2_build.bat

macOS / Linux 用戶:在終端機執行:

cd {YourBook}
python Tools/build.py

三個步驟自動完成

[1/5] 封面壓縮    cover.jpg → Output/cover_compressed.jpg(< 3 MB)
[2/5] QA 掃描     偵測 P1 阻斷性錯誤(verify_source.py)
[3/5] EPUB 建置   Source_Clean_EN.md → Output/{Title}_Final.epub
[4/5] epubcheck   EPUB 結構驗證
[5/5] 清單生成    產出 KDP/SUBMISSION_MANIFEST.md

目標結果

Messages: 0 fatals / 0 errors / 0 warnings / 0 infos

常見錯誤速查

錯誤原因解法
表格顯示為純文字extensions=['tables'] 未啟用在 epub_builder.py 加入參數
封面壓縮後 0 bytes封面為 RGBA(Figma 匯出)img.convert("RGB")
章節未出現在目錄標題不符 Chapter \d 格式調整 toc_chapters 過濾條件
UnicodeEncodeErrorWindows Terminal 編碼問題改用 ASCII 符號輸出

自動預覽(Windows)

雙擊書籍根目錄裡的 3_preview.bat,或在終端機執行:

python Tools/watch_epub.py

每 1.5 秒偵測 EPUB 修改,有更新自動重開 Kindle Previewer 3。

詳細說明:modules/06-EPUB-BUILD.md


Stage 5:KDP 出版準備

目標:準備好所有 KDP 上架需要的 metadata。

需要準備的內容

項目說明
書名 / 副標題與封面完全一致
書籍描述HTML 格式,支援 <b>, <i>, <ul>, <li> 等有限標籤
關鍵字7 組短語(非單字),混合精確詞 + 長尾詞
BISAC 分類2 個分類,依受眾策略選擇(曝光 / 學術 / 利基)
封面圖片JPEG,1.6:1 比例,建議 2560 × 1600 px
AI 內容申報3 個 Yes/No 問題
定價$2.99–$9.99 享 70% 版稅率

封面規格

項目規格
尺寸比例1.6:1(高:寬)
建議尺寸2560 × 1600 px
格式JPEG(RGB 色彩模式)
最大原圖大小50 MB(build.py 壓縮至 < 3 MB)

詳細說明:modules/07-PUBLISHING-PREP.md


Stage 6–7:KDP 後台提交

目標:在 KDP 後台完成填寫並送出審核。

提交流程

  1. 登入 kdp.amazon.com
  2. 新增 Kindle eBook → 填入 metadata
  3. 上傳 EPUB 檔(Output/{Title}_Final.epub
  4. 上傳封面(Output/cover_compressed.jpg
  5. 設定定價與地區
  6. 送出審核(通常 24–72 小時審核完成)

詳細說明:modules/08-SUBMISSION.md | FAQ-KDP.md


跨 Session 進度追蹤

一本書通常需要數週甚至數月才能完成。book-pipeline 內建 coding-worklog skill,讓你在每次工作告一段落時,自動生成一份 Obsidian session note,記錄本次進度、待解決問題、與下次要繼續的地方。

為什麼需要這個?

每次重新開啟 AI 對話,前一次的工作脈絡就消失了。coding-worklog 把工作記憶存進 Obsidian,讓 AI 在下次對話中讀取 session note 就能立即恢復上下文。

觸發方式

在工作告一段落時,對 AI 說:

  • 「記錄這次 session」
  • 「建立工作日誌」
  • 「今天的修改先到這裡,幫我記錄一下」

Session Note 記錄的內容

---
date: 2026-03-01
session_type: chapter-writing   # chapter-writing / revision / epub-build / research
stage: Stage 1                  # 目前所在的 pipeline 階段
duration_minutes: 90
chapters_modified:
  - "Chapter 2: The Politics of Belonging"
status: in-progress
next_steps:
  - "補充 Foucault 對照段落"
  - "與 Chapter 1 論點對齊後決定是否獨立成章"
---

Obsidian 插件需求(Session 追蹤用)

插件用途
Dataview跨 session 查詢(如「列出所有未完成的章節」)
Templater自動填入 session note 模板

模板位於:.agent/skills/coding-worklog/vault-templates/

詳細說明:.agent/skills/coding-worklog/README.md


範例參考

examples/ 資料夾提供一個完整的書籍專案範例,包含:

檔案說明
examples/Components/Obsidian 格式的章節草稿(含 frontmatter、wikilinks、tags)
examples/Tags/概念 Tag 節點範例
examples/Source_Clean_EN_sample.md整合後書稿(Obsidian 語法已清除,格式規範化)

透過對比 Components/ 草稿與 Source_Clean_EN_sample.md,可以清楚看到 Stage 1–2 的轉換過程。


平台支援

功能Windows 10/11macOSLinux
EPUB 建置(epub_builder.py)
epubcheck 驗證
封面壓縮(Pillow)
自動預覽 watcher
Kindle Previewer 3

macOS / Linux 使用者:建置和驗證功能完整可用,視覺預覽需改用其他 EPUB 閱讀器(如 Calibre)。


常見問題

Q:我沒有 Obsidian,可以用嗎? 可以。Obsidian 只用於 Stage 0–1 的草稿管理,如果你的草稿已整理好,可以直接從 Stage 2(準備 Source_Clean_EN.md)開始。

Q:epubcheck 顯示 warnings,可以上傳 KDP 嗎? 可以。fatalserrors 必修,warnings 建議修正但不會阻擋上架,infos 可忽略。

Q:我的書是中文,可以用嗎? 可以。設定 BOOK_LANGUAGE = "zh-TW""zh-CN",書稿存為 Source_Clean_CN.md,整套流程相同。

Q:封面可以用 Figma 製作嗎? 可以,但 Figma 匯出的 PNG 通常是 RGBA 格式,build.py 會自動轉換為 RGB。若封面壓縮後為 0 bytes,請確認 epub_builder.py 中有 img.convert("RGB")

Q:需要自己購買 ISBN 嗎? 不需要。KDP 提供免費 ASIN,僅限 Kindle 平台。若計畫在 Apple Books、Kobo 等多平台發行,才需要自購 ISBN。

更多問題請見 FAQ-KDP.md


文件資源資源導覽 (Documentation Resource Guide)

本專案提供全方位的說明文件,建議根據你目前的出版進度查閱對應資源。

1. 入門與核心指南 (Essential Guides)

  • README.md:專案首頁。包含流水線哲學、環境安裝、10 步快速上手路徑。
  • INSTALL-WINDOWS.mdWindows 新手專用。針對無程式背景使用者,提供最詳盡的 Python/Java 環境安裝教學。
  • TUTORIAL.md完整實戰教學。以《異類的堡壘》為案例,演示從草稿到上架的每一步自動化與手動操作細節。
  • SKILL.mdAI Agent 協助索引。定義了 AI 助手在各階段的標準作業程序 (SOP) 與驗收標準。

2. 核心生產模組 (Core Modules 00–06)

這些文件定義了流水線每個階段的心法、邏輯與執行流程

  • 00-SESSION-SETUP脈絡交接。說明如何在不同 Session 間恢復進度,含 Obsidian 日誌模板。
  • 02-DRAFTING草稿寫作。定義如何利用「概念節點」進行非線性寫作,含 Tag 筆記模板。
  • 03-OBSIDIAN-TO-DRAFT書稿整合。說明如何將分散的筆記自動清除格式並合併為 Source_Clean_EN.md
  • 04-SOURCE-MANAGEMENT格式規格。定義符合 EPUB 高穩定度的書稿排版標準(標題、強調、列表、表格)。
  • 05-EDITORIAL-QA編輯品質。提供 P1/P2/P3 級別的排版錯誤修復框架與 Lint 掃描邏輯。
  • 06-EPUB-BUILD建置 SOP。說明如何在 Python 環境中執行一鍵建置、自訂 CSS 以及處理常見錯誤。
  • 07-PUBLISHING-PREP出版準備。涵蓋 BISAC 分類策略、Amazon 關鍵字佈局、HTML 描述撰寫等。
  • 08-SUBMISSION上架提交。KDP 後台填寫的詳細步驟指引,含稅務資訊填寫建議。

3. 操作清單與檢核 (Checklists)

適合執行實務操作時,開在視窗一側逐項打勾:

4. 進階與參考資源 (Advanced & Examples)

  • FAQ-KDP.md:彙整台灣創作者在 Amazon KDP 遇到的稅務、地址與收款常見疑問。
  • examples/:包含一組完整的範案,方便你比對「整合前」草稿與「整合後」書稿的差異。
  • coding-worklog README:說明如何利用 AI 助手記錄跨 Session 的工作日誌。

🔧 Skill 維護:定期稽核文件完整性

隨著書籍增加或文件修改,SKILL.md 列出的資源路徑可能與實際檔案脫節。 建議在以下時機執行 /skill-audit 指令讓 AI 助手自動稽核:

  • 新增或刪除任何 modules/checklists/Tools/ 文件後
  • 修改 SKILL.md 的 Module Index 或 Checklist Index 後
  • 開始新書專案前

使用方式(對 AI 助手說):

/skill-audit

AI 將自動執行兩項檢查:

稽核項目說明
SKILL.md 路徑存在性確認 Module Index 和 Checklist Index 列出的每個路徑對應真實檔案
modules/ 跨連結有效性確認各 Stage 文件中指向 checklists/ 的連結未斷裂

結果以 OK / MISSING / BROKEN 標示,找到問題後會提示修正方向。

工作流程定義:.agent/workflows/skill-audit.md


book-pipeline 是一套開放的 SOP,歡迎根據你的書籍類型與工作習慣調整使用。

Related

How to Install

  1. Download the ZIP or clone the repository
  2. Open the folder as a vault in Obsidian (File → Open Vault)
  3. Obsidian will prompt you to install required plugins

Stats

Stars

6

Forks

0

Last updated 1mo ago

Categories