Pdf Inspector教學手冊

pdf-inspector 教學手冊 pdf-inspector —— Firecrawl 開源 PDF 分類與擷取引擎:企業 AI Agent 文件理解基礎架構完整實戰指南 適用對象:資深 Software Architect、SA、Backend/Frontend Engineer、AI Agent 平台團隊、DevSecOps、Tech Lead、QA、企業導入負責人 文件性質:企業內部「PDF 前處理 + AI Agent 開發 / Legacy Reverse Engineering / Framework Upgrade / RAG」導入與維運培訓教材 版本基準:firecrawl/pdf-inspector(MIT License),研究基準為官方 GitHub main 分支與 Cargo.toml,目前版本 v1.14.2(PyPI 最後發布 2026-08-13) 查證日期:2026-08-16 技術堆疊:Rust(核心,edition 2021)、Python >=3.8(PyPI pdf-inspector)、Node.js/Bun(npm @firecrawl/pdf-inspector)、Browser WebAssembly(npm @firecrawl/pdf-inspector-wasm)、CLI(pdf2md / detect-pdf)、MIT License ⚠️ 重要聲明(請務必先讀) pdf-inspector 是一個版本快速迭代的年輕開源專案。 本手冊查證當下版本為 1.14.2,但官方 docs/benchmarking.md 中引用的最近一次公開 Benchmark(2026-07-31)測試的是 pdf-inspector 0.2.6——這代表短短兩週內版本號已從 0.2.x 跳到 1.14.x,變動速度非常快。任何指令、函式簽名、Benchmark 數字、目錄結構,在正式導入前務必以你實際安裝版本的官方 README.md、各語言 binding 文件與 Release/Changelog 為準,不要假設本手冊記載的數字在你閱讀時仍然成立。 版本跳躍原因(Source-confirmed,2026-08-16 補充查證 GitHub Releases 頁面):這不是「兩週內發布了上千次迭代」,而是版本號機制本身發生了變更。查證到的 packages-2026-08-10 彙總發布中,四種 binding 當時仍各自使用獨立版本號:Rust crate 0.1.8、Python 0.2.7、Node.js 1.13.0、WASM 0.1.4——彼此不同步。到了 v1.14.2(2026-08-13),所有 binding 已統一為同一個版本號。這與姊妹專案 anydoc 官方 Changelog 中「Bump pdf-inspector from 0.1.8 to 1.14.2」的記載互相印證(見〔anydoc 教學手冊〕第 35.3 節)。推測(Hypothesis):官方很可能是把既有版本號最高的 Node binding(1.13.x)訂為統一基準,讓四個 binding 從此以同一版本號同步發布(見第 38.1 節「單一版本號同步」發布機制);但官方一手資料並未發布逐字說明此次版本號統一的決策公告,此為合理推論而非官方逐字確認,仍建議正式導入前自行查核。 ...

August 16, 2026 · 60 min · 12737 words · Eric Cheng

Anydoc教學手冊

anydoc 教學手冊 anydoc —— Firecrawl 開源文件轉 Markdown 引擎:企業 AI Agent 導入完整實戰指南 適用對象:資深 Software Architect、SA、Backend/Frontend Engineer、AI Agent 平台團隊、DevSecOps、Tech Lead、企業導入負責人 文件性質:企業內部「文件轉換 + AI Agent 開發 / Legacy Reverse Engineering / Framework Upgrade / RAG」導入與維運培訓教材 版本基準:firecrawl/anydoc(MIT License),研究基準為官方 GitHub main 分支,最新 release v0.1.9(2026-08-13) 查證日期:2026-08-16 技術堆疊:Rust(核心)、Node.js >=20(@firecrawl/anydoc)、Python(firecrawl-anydoc)、WebAssembly(@firecrawl/anydoc-wasm)、CLI(anydoc)、MIT License ⚠️ 重要聲明(請務必先讀) anydoc 是一個非常年輕、正在快速迭代的專案。 依官方 GitHub Releases 頁面查證,v0.1.1 至 v0.1.9 這 9 個版本在 2026-08-04 至 2026-08-13 短短 10 天內陸續發布,平均每 1–2 天就有一次釋出。這代表 CLI 參數、函式簽名、目錄結構、Benchmark 數字都可能在你閱讀本手冊後不久就出現異動。任何指令、程式碼、版本號在正式導入前,務必以官方最新 README.md、各語言 binding 的 README.md、CHANGELOG/Releases 頁面與你實際安裝的版本為準。 ...

August 16, 2026 · 73 min · 15391 words · Eric Cheng

Github Copilot生態圈教學手冊

Github Copilot生態圈教學手冊 版本:7.0 最後更新:2026 年 9 月 25 日 適用對象:資深工程師 / Tech Lead / Architect / Copilot 平台管理者 適用於:GitHub Copilot (Free / Student / Pro / Pro+ / Max / Business / Enterprise) VS Code 版本:1.139+(2026/09/23 穩定版) 重大異動:2026/06/01 起全面採 AI Credits 用量計費;VS Code 改為 Agent Harness/Agent Host 架構;新增 GitHub Copilot App、Automations、Agentic Workflows、Plugins 與 Enterprise Managed Settings;2026/09/28 起 Code Review 預設深度改為 Balanced、2026/10/22 起未設定的新功能政策預設開放(詳見 1.8) Created by:Eric Cheng 目錄 第一章 GitHub Copilot 生態圈全貌總覽 ...

August 13, 2026 · 82 min · 17377 words · Eric Cheng

Herdr教學手冊

Herdr 教學手冊 Herdr —— 企業級 AI Coding Agent Runtime / Multi-Agent Workspace 完整導入指南 適用對象:資深 Software Architect、SA、Backend/Frontend Engineer、AI Agent 平台團隊、DevSecOps、Tech Lead、PM/PG/QA、企業導入負責人 文件性質:企業內部「Herdr + AI Coding Agent(Claude Code/GitHub Copilot CLI/Codex)」導入、開發與維運培訓教材 版本基準:herdrdev/herdr(Apache License 2.0,於 v0.8.0/2026-08-03 relicense 自 AGPL-3.0-or-later),最新 Stable Release v0.8.2(2026-08-19) 官方文件基準:herdr.dev/docs/* 全部 20 個頁面(Install、Quick Start、Concepts、Agents、Integrations、Agent Automation、Agent Skill、Session State、Persistence & Remote、How to Work、Configuration、Config Reference、Keyboard、CLI Reference、Socket API、Plugins、Marketplace、Troubleshooting、Windows、Compare) 查證日期:2026-09-06(初版 2026-08-12,本次為 v0.8.2 版本複查;異動對照見 Appendix G) 技術堆疊:Rust 單一執行檔(Server + Client)、TOML 設定檔、本機 Socket API(Unix Domain Socket/Windows Named Pipe) ...

August 12, 2026 · 73 min · 15404 words · Eric Cheng

TencentDB Agent Memory 教學手冊

TencentDB-Agent-Memory 教學手冊 TencentDB-Agent-Memory —— 企業級 AI Agent Team Memory Hub 完整導入指南 適用對象:資深 Software Architect、SA、Backend/Frontend Engineer、AI Agent 平台團隊、DevSecOps、Tech Lead、企業導入負責人 文件性質:企業內部 AI Agent Memory 基礎設施導入、開發與維運培訓教材 版本基準:TencentCloud/TencentDB-Agent-Memory(MIT License),研究基準為官方 GitHub feat/server_team 分支 (注意:此 repo 的 default branch 不是 main,而是 feat/server_team;main 只保留舊版 0.x 程式碼) commit fe3230f176f1bf5832fee79d12494bbc2d19a8a(2026-08-06,程式碼與逐行引用之研究基準),最新 release v2.0.0(2026-08-03) (後續追蹤:commit 0a568c328ea1aae3f22ed3656e7900da7ea565c1〔2026-08-10〕僅新增 ROADMAP.md/ROADMAP_CN.md 文件、無程式碼變更,本手冊已據此更新第2.3、21.5節與 Appendix A/E/F,其餘章節之原始碼行號引用仍以 fe3230f 為準) 查證日期:2026-08-10 技術堆疊:TypeScript、Node.js >=22.16.0、SQLite + sqlite-vec(預設)/可選 Tencent Cloud VectorDB、MIT License ⚠️ 重要聲明(請務必先讀) TencentDB-Agent-Memory 仍在快速迭代中。 這是一個 2026-04 才建立、目前累積約 19.3k GitHub star 的年輕開源專案,v2.0.0(2026-08-03)是首次把四個 Memory Asset 全部開源的完整版本。CLI 指令、設定鍵、API 路由、目錄結構都可能隨版本演進調整。任何指令、設定、路徑在正式導入前,務必以官方最新 README.md/README_CN.md/INSTALL.md/CHANGELOG.md 與你實際安裝的版本為準。 ...

August 10, 2026 · 89 min · 18939 words · Eric Cheng

OfficeCLI 教學手冊

OfficeCLI 教學手冊 OfficeCLI — 為 AI Agent 而生的 Office 自動化命令列工具:以確定性的路徑定址(path addressing)與固定 JSON schema,讓 LLM 直接讀寫 Word/Excel/PowerPoint,免安裝 Office、免自行解析 OOXML 適用對象:資深後端/全端工程師、AI Agent 架構師、MCP 整合工程師、Document Engineering/Reverse Engineering 團隊、企業 IT 治理與導入負責人 文件性質:企業內部「AI Office Automation Platform」建置與維運教材+開發規範參考+大型軟體開發流程應用指南 版本基準:OfficeCLI(iOfficeAI/OfficeCLI,2026-03-15 建立、Apache License 2.0、單一 .NET 執行檔/C# 撰寫;最新版本 v1.0.143,發布於 2026-07-28);本次撰寫查證時間點 2026-08-05 ⚠️ 重要聲明(請務必先讀) OfficeCLI 仍在高速迭代中。 專案於 2026-03-15 建立,不到五個月內成長迅速。截至本次撰寫(2026-08-05,直接呼叫 api.github.com/repos/iOfficeAI/OfficeCLI 查證,非憑記憶)已有 25,503 Stars、1,714 Forks、73 Subscribers、44 個開放 Issue,自 2026-06-21 起多次登上 GitHub Trending 第一名。其 CLI 參數、JSON schema、Wiki 頁面結構在版本之間可能持續變動,任何指令與旗標在正式導入前,務必以最新官方 Repository/內建 officecli help 為準;本手冊所列數字與行為僅為查證當下快照。 本手冊的定位是「理解、彙整、分析、重組、補充最佳實務」,而非官方文件翻譯。 不直接翻譯 README、不大量抄錄原文,而是以企業教育訓練教材角度重新組織、加入架構圖、比較表、最佳實務與導入建議。 內容分兩類: 官方已確認事實:內文一律使用 repo 內實際指令/路徑/旗標名稱,不使用意譯替代。本次核校已透過 GitHub API 直接讀取 repo metadata、README.md/README_zh.md、SKILL.md、GitHub Wiki(Home/command-reference/command-view 等頁面)逐一比對,非僅憑記憶或二手轉述。 作者補充:凡屬作者依企業(含金融業、保險業、政府機關)導入 AI Agent Office Automation 之實務經驗所補充或推論之處,會標註 (作者建議) 或 (作者推論)。這些是最佳實務參考,非官方保證。 特別澄清(避免讀者對專案與架構產生誤解): 命名衝突警告:GitHub 上另有一個完全不同、不相關的專案同樣以「OfficeCLI」自稱(officecli/officecli,主打「AI document generation CLI」、npm 安裝+託管試用),與本手冊主題 iOfficeAI/OfficeCLI(25k+ Stars、Apache 2.0、單一二進位執行檔)並非同一專案。自行搜尋資料時請務必核對組織帳號 iOfficeAI,避免誤植指令或誤信功能。 OfficeCLI 本質上是一支 CLI/DOM 編輯器,MCP 只是它眾多整合介面之一(另有 Python SDK officecli-sdk、Node.js SDK @officecli/sdk、SKILL.md/load_skill 技能系統)。執行 officecli mcp <host> 才會啟動/設定 MCP Server,並非常駐預設行為。 PNG 輸出不是獨立的「渲染層」,而是 view screenshot 這個輸出模式,底層與 view html(HTML 預覽)共用同一套渲染引擎;且 view html 與 view svg 目前僅支援 PowerPoint(.pptx),並非任意格式皆可轉 HTML/SVG(查證自 Wiki command-view 頁面)。 PDF 匯出與 forms(互動表單欄位列舉)屬於「外掛相依」(plugin-dependent)功能,非核心二進位內建;官方文件明確寫著「Export the document to PDF via an installed exporter plugin」。 未見官方對舊版二進位格式(.doc/.xls/.ppt)或 CSV 作為第一類讀寫格式的原生支援證據;CSV 目前僅以 add --type csv 形式匯入 Excel,並非通用匯出格式。原始需求若涉及這些項目,本手冊會在對應章節明確標註「⚠️ 目前版本不支援,可透過 YYY 替代」,不會虛構不存在的指令。 未見官方 Docker Hub / GHCR 上架的正式容器映像;iOfficeAI 組織下的姊妹專案(AionUi)雖有內含 OfficeCLI 呼叫的 Dockerfile 範例,但那是應用層 Dockerfile,不等於 OfficeCLI 官方提供的映像。第三章的容器化安裝內容標註為**(作者建議)**的自建 Dockerfile 作法。 授權條款請留意「範圍界線」:OfficeCLI 本身(程式碼)採 Apache License 2.0,可自由商用、修改、內部散布。但這不代表經過 OfficeCLI 處理的文件內容本身著作權隨之開放——那是你自己或客戶的文件。金融業、保險業、政府機關導入前,仍應將「OfficeCLI 本機執行 vs. 透過 MCP 交給雲端 LLM 讀取內容」兩種情境的資料外洩風險分開評估(作者建議,詳見第十八章)。 官方權威來源與本次查證所用 URL/時間戳,請見〈附錄 A・參考資料〉。 目錄(Table of Contents) 符號約定 版本與相容性速查表 第一章 OfficeCLI 介紹 1.1 一句話定義 1.2 誕生背景與發展脈絡 1.3 解決哪些 AI Agent 痛點 1.4 設計理念與設計哲學 1.5 適用情境 1.6 不適用情境/限制 1.7 與傳統 Office Automation 的差異 1.8 核心特色 1.9 優勢 1.10 限制 1.11 未來發展方向與 Roadmap 1.12 AI Prompt 範例 1.13 本章 Checklist 與小結 第二章 OfficeCLI 系統架構 2.1 架構總覽 2.2 三層架構詳解(L1 → L2 → L3) 2.3 Resident Mode 常駐架構 2.4 CLI Layer 與指令分派 2.5 JSON Extractor/DOM 抽象層 2.6 與 OpenXML 的關係 2.7 Rendering Engine 概覽 2.8 MCP Server 架構 2.9 Watch Mode/Preview Server 架構 2.10 端到端資料流 2.11 AI Agent/LLM 整合點總覽 2.12 AI Prompt 範例 2.13 本章 Checklist 與小結 第三章 安裝 3.1 安裝路徑總覽 3.2 Windows 安裝 3.3 Linux 安裝 3.4 macOS 安裝 3.5 WSL 安裝 3.6 npm 安裝(跨平台) 3.7 Docker/Container 安裝 🧩(作者建議) 3.8 企業環境安裝:Air-gap/Offline Installation(作者建議) 3.9 企業代理(Proxy)設定(作者建議) 3.10 版本管理與更新 3.11 PATH 與環境變數 3.12 安裝驗證 Checklist 3.13 常見安裝錯誤 3.14 AI Prompt 範例 3.15 本章 Checklist 與小結 第四章 CLI 使用教學 4.1 指令總覽表 4.2 全域旗標與慣例 4.3 路徑定址語法 4.4 單位與數值慣例 4.5 create:建立空白文件 4.6 view:語意化讀取 4.7 get / query:查詢元素 4.8 set / add / remove / move / swap 4.9 raw / raw-set:L3 保底手段 4.10 validate 4.11 batch:原子化多指令執行 4.12 dump / merge 4.13 open / close:常駐模式操作 4.14 mcp:MCP Server 設定 4.15 install / plugins / skills / load_skill 4.16 help:內建三層說明系統 4.17 JSON 輸出格式與錯誤處理 4.18 錯誤案例與除錯 4.19 最佳實務 4.20 常見錯誤與 Anti-Pattern 4.21 AI Prompt 範例 4.22 本章 Checklist 與小結 第五章 支援格式 5.1 格式總覽表 5.2 DOCX(Word) 5.3 XLSX(Excel) 5.4 PPTX(PowerPoint) 5.5 Legacy 二進位格式(.doc/.xls/.ppt) 5.6 PDF 🧩 5.7 HTML/SVG(⚠️ 僅 PowerPoint) 5.8 JSON 5.9 PNG 5.10 Markdown(⚠️ 不支援原生輸出) 5.11 CSV(僅匯入 Excel) 5.12 格式選擇決策樹 5.13 最佳實務 5.14 常見錯誤 5.15 AI Prompt 範例 5.16 本章 Checklist 與小結 第六章 Rendering Engine 6.1 渲染引擎總覽 6.2 HTML Render 6.3 Image Render/PNG 6.4 Preview(watch 即時預覽) 6.5 Diff/增量更新機制 6.6 Page Layout 6.7 字型 6.8 圖片渲染 6.9 Table 渲染 6.10 Chart 渲染 6.11 SmartArt 渲染 6.12 最佳實務 6.13 常見錯誤與 Anti-Pattern 6.14 AI Prompt 範例 6.15 本章 Checklist 與小結 第七章 JSON Extraction 7.1 為什麼 JSON 是 OfficeCLI 與 LLM 之間的共同語言 7.2 JSON Envelope Schema 總覽(複習+深化) 7.3 Document Structure(outline) 7.4 Table/Cell 7.5 Paragraph/Run 7.6 Image 7.7 Header/Footer 7.8 Style 7.9 Metadata(stats/issues) 7.10 dump:完整可重播 JSON 7.11 --output-schema-crc:Schema 版本指紋 7.12 JSON 在 AI Workflow 中的角色 7.13 最佳實務 7.14 常見錯誤 7.15 AI Prompt 範例 7.16 本章 Checklist 與小結 第八章 Office Editing 8.1 建立文件 8.2 Word 編輯 8.3 Excel 編輯 8.4 PowerPoint 編輯 8.5 圖片插入與格式設定(跨格式共通模式) 8.6 圖表建立速查表 8.7 樣式與格式化最佳實務 8.8 批次編輯 Workflow 8.9 最佳實務 8.10 常見錯誤與 Anti-Pattern 8.11 AI Prompt 範例 8.12 本章 Checklist 與小結 第九章 MCP Server 9.1 MCP 協定簡介 9.2 OfficeCLI 的 MCP 實作架構 9.3 officecli mcp 指令完整參考 9.4 Claude Code 設定 9.5 Claude Desktop 設定(⚠️ 作者補充,非官方一鍵指令) 9.6 Cursor 設定 9.7 VS Code/GitHub Copilot 設定 9.8 LM Studio 設定 9.9 Gemini CLI 設定(⚠️ 作者補充,非官方一鍵指令) 9.10 OpenAI Codex CLI 設定(⚠️ 作者補充,非官方一鍵指令) 9.11 MCP Tool 呼叫範例集 9.12 load_skill:動態技能載入 9.13 MCP Security 概覽 9.14 最佳實務 9.15 常見錯誤 9.16 AI Prompt 範例 9.17 本章 Checklist 與小結 第十章 Watch Mode 10.1 定位:watch 與其他預覽方式的差異 10.2 啟動與基本用法 10.3 HTTP Server 細節 10.4 Live Reload/Auto Reload 機制 10.5 API 端點 10.6 互動選取與 Marks 審閱工作流程 10.7 Browser 自動開啟與 Auto-Scroll 10.8 Hot Reload 情境示範 10.9 Debug 除錯技巧 10.10 最佳實務 10.11 常見錯誤與 Anti-Pattern 10.12 AI Prompt 範例 10.13 本章 Checklist 與小結 第十一章 AI Agent 整合 11.1 整合模式分類 11.2 Claude Code(官方支援) 11.3 Cursor(官方支援) 11.4 GitHub Copilot/VS Code(官方支援) 11.5 OpenAI Codex CLI(MCP 標準,需手動設定) 11.6 Gemini CLI(MCP 標準,需手動設定) 11.7 Windsurf(官方支援・Skill 檔自動偵測) 11.8 Shell-Exec 類 Agent 整合總表 11.9 選型建議 11.10 最佳實務 11.11 常見錯誤 11.12 AI Prompt 範例 11.13 本章 Checklist 與小結 第十二章 AI Workflow 12.1 端到端流程總覽 12.2 各階段詳解 12.3 範例 Walkthrough:月報自動化 12.4 範例 Walkthrough:合約套版審閱 12.5 人工確認關卡設計 12.6 失敗重試與回滾策略 12.7 最佳實務 12.8 常見錯誤 12.9 AI Prompt 範例 12.10 本章 Checklist 與小結 第十三章 Reverse Engineering 13.1 為什麼 Office 文件是 Legacy System 的隱藏規格書 13.2 Word 規格書 → 功能分析 13.3 Excel 試算表 → Database Schema 推導 13.4 PowerPoint 簡報 → 需求分析 13.5 從文件擷取 API/介面定義 13.6 產出正式規格書 13.7 與 Migration/Framework Upgrade 的銜接 13.8 案例 Walkthrough:舊保單管理系統文件化 13.9 最佳實務 13.10 常見錯誤 13.11 AI Prompt 範例 13.12 本章 Checklist 與小結 第十四章 Web Application 開發 14.1 OfficeCLI 在企業級 Web Application 開發流程中的定位 14.2 需求分析 14.3 Use Case 文件自動產出 14.4 ERD:從 Excel 欄位表到關聯圖 14.5 API/Swagger/OpenAPI 14.6 SDD/Spec 文件 14.7 Architecture/Sequence/Class/Component/Deployment Diagram 14.8 與 Spec Repository 的銜接 14.9 完整 Walkthrough:從 PRD 到 API 規格書 14.10 最佳實務 14.11 常見錯誤 14.12 AI Prompt 範例 14.13 本章 Checklist 與小結 第十五章 Framework Upgrade 15.1 為什麼升版評估需要文件工程 15.2 Spring Boot/Spring Framework 15.3 Jakarta EE/Java 15.4 Vue/Angular/React 15.5 .NET/Node.js 15.6 Maven/Gradle 15.7 通用 Upgrade Checklist 產生流程 15.8 Migration Plan 文件產出 15.9 案例 Walkthrough 15.10 最佳實務 15.11 常見錯誤 15.12 AI Prompt 範例 15.13 本章 Checklist 與小結 第十六章 AI 文件工程 16.1 從「AI 輔助」到「AI 原生」的典範轉移 16.2 Document Engineering(文件工程) 16.3 Prompt Engineering(文件情境) 16.4 Context Engineering(上下文工程) 16.5 Knowledge Engineering(知識工程):RAG 與知識圖譜 16.6 Spec Engineering(規格工程) 16.7 五大工程領域的協作關係 16.8 最佳實務 16.9 常見錯誤 16.10 AI Prompt 範例 16.11 本章 Checklist 與小結 第十七章 系統維運 17.1 維運總覽 17.2 Monitoring 17.3 Logging 17.4 Troubleshooting 17.5 Performance ⚡ 17.6 Memory 17.7 Rendering 效能 17.8 Cache 17.9 CI/CD 整合範例 17.10 Kubernetes 部署範例(作者建議,批次渲染 Job) 17.11 最佳實務 17.12 常見錯誤 17.13 AI Prompt 範例 17.14 本章 Checklist 與小結 第十八章 安全性 18.1 威脅模型總覽 18.2 Office Macro/惡意文件 18.3 權限 18.4 Sandbox 18.5 MCP Security 18.6 JSON/指令注入 18.7 Prompt Injection(文件內藏惡意指令) 18.8 Secrets 18.9 最佳實務 18.10 常見錯誤 18.11 AI Prompt 範例 18.12 本章 Checklist 與小結 第十九章 最佳實務 19.1 大型企業導入原則總覽 19.2 銀行最佳架構 19.3 政府機關最佳架構 19.4 最佳流程 19.5 最佳 Prompt 原則 19.6 最佳資料夾結構(作者建議) 19.7 最佳 Git 規範 19.8 最佳 CI/CD 19.9 綜合案例 19.10 常見錯誤與 Anti-Pattern 19.11 AI Prompt 範例 19.12 本章 Checklist 與小結 第二十章 常見問題 FAQ 20.1 基礎與定位(Q1–Q10) 20.2 安裝與環境(Q11–Q20) 20.3 CLI 與路徑定址(Q21–Q32) 20.4 格式支援(Q33–Q42) 20.5 JSON 與資料擷取(Q43–Q50) 20.6 Rendering/Watch(Q51–Q60) 20.7 MCP 與 AI Agent 整合(Q61–Q70) 20.8 效能與維運(Q71–Q80) 20.9 安全性(Q81–Q92) 20.10 企業導入與治理(Q93–Q108) 20.11 本章 Checklist 與小結 第二十一章 Case Study 21.1 銀行|放款契約自動套版審閱 21.2 銀行|舊核心系統規格書逆向工程 21.3 保險|理賠報告自動產出 21.4 保險|舊保單管理系統文件化 21.5 政府機關|Air-gap 環境公文範本自動化 21.6 政府機關|招標規格書比對稽核 21.7 製造業|品保報告自動彙整 21.8 製造業|舊 ERP 欄位對照表現代化 21.9 AI 文件分析|大量合約條款風險掃描 21.10 AI 文件分析|財報簡報自動生成 21.11 Framework Upgrade|Spring Boot 3 → 4 升版盤點 21.12 Framework Upgrade|前端 Vue 2 → Vue 3 遷移文件化 21.13 跨國企業|多語系月報自動化 21.14 新創 SaaS|MCP 驅動的客製化提案簡報產生器 21.15 教育機構|學習歷程報告批次產出 21.16 集團內部|企業知識庫 RAG 建置 21.17 最佳實務(跨案例共通觀察) 21.18 常見錯誤 21.19 AI Prompt 範例 21.20 本章 Checklist 與小結 第二十二章 與其它工具比較 22.1 第一個關鍵區分:讀取/解析 vs. 讀寫/編輯 22.2 讀寫/編輯類比較 22.3 唯讀解析/擷取類比較(RAG/LLM 前處理導向) 22.4 綜合評分表(依五個面向,5 分制,作者依本章比較資料之主觀評分) 22.5 定位象限圖 22.6 選型決策樹 22.7 最佳實務 22.8 常見錯誤 22.9 AI Prompt 範例 22.10 本章 Checklist 與小結 第二十三章 OfficeCLI + AI Agent 最佳架構 23.1 完整企業架構圖 23.2 各層職責說明 23.3 GitHub/GitLab 雙軌並存的實務考量 23.4 RAG/向量資料庫/知識圖譜的資料流 23.5 Reverse Engineering/Framework Upgrade 在架構中的位置 23.6 分階段導入建議 23.7 最佳實務 23.8 常見錯誤 23.9 AI Prompt 範例 23.10 本章 Checklist 與小結 第二十四章 Prompt Library 24.1 文件分析類(General Document Analysis) 24.2 Excel 分析類 24.3 PPT 分析類 24.4 Word 修改類 24.5 Migration 類 24.6 Architecture 類 24.7 Requirement 類 24.8 Spec 類 24.9 Testing 類 24.10 Review 類 24.11 十大類別總覽 24.12 最佳實務 24.13 常見錯誤 24.14 AI Prompt 範例(如何擴充本 Library) 24.15 本章 Checklist 與小結 第二十五章 完整企業導入指南 25.1 導入流程總覽 25.2 教育訓練 25.3 治理框架 25.4 版本管理 25.5 AI Agent 治理 25.6 MCP 治理 25.7 文件治理 25.8 ROI 衡量 25.9 成熟度模型 25.10 KPI 範例 25.11 最佳實務 25.12 常見錯誤 25.13 AI Prompt 範例 25.14 本章 Checklist 與小結 附錄 附錄 A・參考資料 附錄 B・全書 Checklist 總表 附錄 B.1・情境式 Checklist(跨章節整合) 附錄 C・FAQ 索引 附錄 D・版本歷程(本手冊) 結語 目錄將於全書完稿後以 python tools/markdown/generate_toc.py 重新產生並校正,撰寫期間之標題編號以此為準。 ...

August 5, 2026 · 78 min · 16505 words · Eric Cheng

Book to Skill 教學手冊

book-to-skill 教學手冊 book-to-skill — 把一本書、一份文件、甚至一整個 docs/ 資料夾,轉成 AI Agent 可隨查隨用的 「Skill」:Claude Code、GitHub Copilot CLI、Amp 三大 host 共用的知識轉換引擎 適用對象:資深工程師、AI Engineer、知識工程/RAG 團隊、Tech Lead、架構師、企業導入人員、PM 文件性質:企業內部「Knowledge-as-Skill」知識庫導入、開發與維運培訓教材 版本基準:book-to-skill(virgiliojr94/book-to-skill,2026 年 5 月 1 日建立、核心 MIT License、 v1.3.0 正式版於 2026-07-30 發布;本次改版核校時間點 2026-08-04) ⚠️ 重要聲明(請務必先讀) book-to-skill 仍在高速迭代中。 本專案於 2026-05-01 建立,短短三個月內成長迅速,已登上 GitHub Trendshift 趨勢榜(編號 #27038)。截至本次改版核校(2026-08-04,直接呼叫 api.github.com/repos/virgiliojr94/book-to-skill 查證,非憑記憶)已有 16,048 Stars、 1,714 Forks、81 Subscribers、18 個開放 Issue,版本從 v1.0.0(2026-06-08)快速推進到 v1.3.0(2026-07-30,pyproject.toml 版本號同步為 1.3.0,最後一次 push 為 2026-07-31)。 其 CLI 參數、SKILL.md 內部步驟、目錄結構在版本之間可能持續變動,任何指令與檔名在正式導入前, 務必以最新官方 Repository 為準;本手冊所列數字僅為核校當下快照。 本手冊的定位是「理解、彙整、分析、重組、補充最佳實務」,而非官方文件翻譯。 依撰寫要求,本書 不直接翻譯 README、不大量抄錄原文,而是以企業教育訓練教材的角度重新組織、加入架構圖、比較表、 最佳實務與導入建議。 內容分兩類: 官方已確認事實(例如 book_to_skill/ pip 套件結構、scripts/extract.py 薄殼層、 SKILL.md 規格文件本身驅動 Step 0–10 的生成流程、tools/discovery_tax.py/ tools/validate_skill.py/tools/scan_generated_skill.py 三支輔助工具、sanitize.py 的 隱藏字元清洗機制等)作為骨幹,內文一律使用 repo 內實際檔名/路徑/指令,不使用意譯替代。 本次核校已透過 GitHub API 直接讀取 repo 檔案樹、README.md、SKILL.md、 docs/ARCHITECTURE.md、pyproject.toml、book_to_skill/config.py 等原始檔案逐一比對, 非僅憑記憶或二手轉述。 作者補充:凡屬作者依企業(含金融業、保險業)導入 AI Agent 知識工程之實務經驗所補充或推論 之處,會標註 (作者建議) 或 (作者推論)。這些是最佳實務參考,非官方保證。 特別澄清(避免讀者對架構產生誤解): book-to-skill 不是一個獨立呼叫 Anthropic/OpenAI API 的雲端服務,它本身沒有也不需要 設定任何 LLM API Key——真正執行「閱讀全文、萃取框架、寫出 SKILL.md」這些生成工作的模型, 是使用者當下所在的 host agent(Claude Code、GitHub Copilot CLI、或 Amp)本身。book-to-skill 提供的是一份規格文件(SKILL.md)加一組確定性的文字擷取程式(book_to_skill/ 套件),並不是 另一個會發送 API 請求的後端服務。 book-to-skill 不是 MCP(Model Context Protocol)Server,repo 中沒有 MCP 相關程式碼。它遵循 的是另一個開放標準——Agent Skills 標準(agentskills/agentskills),與 MCP 是兩種不同的 擴充機制,兩者可以並存但不是同一件事。第13章會詳細釐清這個常見誤解。 這兩點都與坊間許多「AI 開發工具教學範本」預設的雲端服務/MCP 整合章節不同,本手冊會在對應章節 明確標註「此工具不適用」而非硬套範本。 授權條款請留意「範圍界線」: book-to-skill 轉換器本身(程式碼 + SKILL.md 規格)採 MIT License,可自由商用、修改、內部散布。但這不代表經過 book-to-skill 處理過的書籍/文件內容 本身的著作權也隨之開放——官方 README 明確指出:book-to-skill 不隨附任何書籍內容、不上傳使用者的 檔案,產生的 Skill 是「你自己的讀書筆記」性質的衍生摘要,不可對外散布第三方受著作權保護書籍所 產生的 Skill;公司內部文件、自有著作、開放授權素材則可依其授權範圍分享。金融業、保險業等受 監理產業,導入前應將此授權界線一併提交法務/智財單位確認(作者建議)。 官方權威來源請見〈附錄 A・References〉。 目錄(Table of Contents) 圖例與符號說明 本手冊閱讀路徑 第1章 book-to-skill 是什麼 1.1 一句話定義 1.2 發展背景與誕生脈絡 1.3 設計理念 1.4 解決哪些問題:Discovery Loop Tax(核心賣點) 1.5 適用情境 1.6 限制 1.7 特色 1.8 優點 1.9 缺點 1.10 與傳統 RAG 的差異 1.11 與向量資料庫的差異 1.12 與 MCP 的差異 1.13 與「Claude Skills」的關係 1.14 本章 Checklist 與小結 第2章 系統架構 2.1 架構總覽:兩個半部 2.2 資料流(Data Flow) 2.3 Knowledge Flow(知識萃取的分層邏輯) 2.4 Skill Generation Pipeline(SKILL.md 驅動的 Step 0–10) 2.5 Document Processing 決策樹 2.6 Prompt Pipeline:四種操作模式 2.7 端到端資料流總結圖 2.8 本章 Checklist 與小結 第3章 book-to-skill 核心架構詳解 3.1 Parser(解析器) 3.2 Layout Detection(章節/目錄偵測) 3.3 Knowledge Extraction(知識萃取,Agent 側) 3.4 Skill Generator 3.5 Metadata 3.6 Output(輸出結構) 3.7 CLI 3.8 Config 3.9 Cache(誠實說明:沒有持久化快取) 3.10 Log(誠實說明:沒有結構化 Logging 框架) 3.11 Error Handling 3.12 Plugin/Extension(誠實說明:沒有執行期 Plugin 機制,但有明確的擴充路徑) 3.13 本章 Checklist 與小結 第4章 安裝 4.1 兩種安裝路徑,先分清楚再動手 4.2 Windows 安裝 4.3 Linux 安裝 4.4 macOS 安裝 4.5 WSL 安裝 4.6 各 Host 安裝指令對照 4.7 pip 安裝(獨立 CLI) 4.8 uv 安裝(作者建議) 4.9 Node/Git 等前置需求 4.10 企業安裝:Offline 安裝(作者建議) 4.11 Proxy/Firewall 注意事項(作者建議) 4.12 本章 Checklist 與小結 第5章 設定 5.1 設定機制總覽(誠實澄清:沒有 YAML/JSON 設定檔) 5.2 CLI 參數 5.3 環境變數 5.4 API Key:明確澄清「不需要設定」 5.5 各 Host 的模型從何而來 5.6 mkdocs.yml:官方文件站設定(非使用者需設定項) 5.7 最佳設定建議(作者建議) 5.8 本章 Checklist 與小結 第6章 文件格式支援 6.1 支援格式總表 6.2 PDF:技術書 vs. 文字書的取捨 6.3 EPUB 6.4 DOCX(Office 格式) 6.5 純文字系列(TXT/Markdown/RST/AsciiDoc) 6.6 RTF 6.7 MOBI/AZW/AZW3 6.8 不同企業文件類型的實務對應(作者建議) 6.9 本章 Checklist 與小結 第7章 Document Parsing 與 Layout Analysis 深入 7.1 Layout Analysis 總覽 7.2 章節辨識(Heading Detection) 7.3 Table/Code Block 擷取 7.4 Image/Caption/Footnote/Reference/Citation 的處理限制(誠實說明) 7.5 安全防護:文件→Context 供應鏈的三道防線 7.6 最佳實務 7.7 本章 Checklist 與小結 第8章 Knowledge Extraction(知識萃取) 8.1 Step 3:分析書籍結構(回顧與展開) 8.2 Step 4:詢問用途,推導 DEPTH 8.3 Quality Rules:八條品質準則(重新詮釋) 8.4 六種知識形態與模板欄位對照 8.5 案例:如果把經典架構書丟進 book-to-skill 8.6 本章 Checklist 與小結 第9章 Skill Generation(Skill 產出規格) 9.1 SKILL.md 主檔模板結構 9.2 Cross-agent 相容性設計(agent-neutral 寫法) 9.3 chapters/ch<NN>-<slug>.md 模板逐節說明 9.4 支援檔案:glossary/patterns/cheatsheet 9.5 Update/Fold-in Workflow(Mode 4)深入 9.6 本章 Checklist 與小結 第10章 Claude Code 如何使用 10.1 安裝與基本使用回顧 10.2 與 Claude Skills 機制的關係 10.3 與 CLAUDE.md/Memory 體系整合(作者建議) 10.4 Context 載入行為 10.5 與 Subagent/Agent 架構搭配 10.6 與既有 Workflow/Slash Command 整合 10.7 最佳實務 10.8 本章 Checklist 與小結 第11章 GitHub Copilot CLI 如何使用 11.1 安裝與 Reload 11.2 與 Custom Instructions(copilot-instructions.md)的分工 11.3 Prompt Files 對照(作者建議延伸) 11.4 Project-local 安裝與 Workspace 共用 11.5 Agent Mode 下的行為 11.6 MCP 澄清(延續 1.12 節) 11.7 分享已生成的 Skill 11.8 本章 Checklist 與小結 第12章 其他 Agent CLI 整合(Amp/Codex CLI/Gemini CLI/Cursor/Windsurf/Cline 等) 12.1 官方明確支援:Amp 12.2 Agent Skills 開放標準的官方採用者名單(2026-08-04 查證,非作者推論) 12.3 Agent Skills 標準的正式規格:SKILL.md frontmatter 欄位 12.4 為什麼相容性仍需自行驗證:機制本質差異(已窄化為工具實作細節層級) 12.5 手動整合模式(作者建議,適用 Windsurf/Cline 等尚未支援 Agent Skills 標準的工具) 12.6 AGENTS.md 慣例與 Agent Skills 標準的分工(作者建議) 12.7 本章 Checklist 與小結 第13章 MCP 整合的正確理解 13.1 再次明確澄清 13.2 為什麼這個誤解特別容易發生 13.3 與常見 MCP Server 的分工建議(作者建議) 13.4 本章 Checklist 與小結 第14章 Reverse Engineering 場景應用(作者延伸) 14.1 為什麼逆向工程需要「知識可查詢化」 14.2 適用範圍:官方語言/框架手冊,而非原始碼本身 14.3 與 reverse-skill 的分工建議(作者建議) 14.4 案例走查:PowerBuilder 老系統維運知識庫 14.5 最佳實務 14.6 本章 Checklist 與小結 第15章 Framework Upgrade 場景應用(作者延伸) 15.1 為什麼框架升級特別適合這個模式 15.2 各框架 Migration Guide 轉 Skill 對照 15.3 案例:Spring Boot Migration Guide → Skill → 升級專案查詢 15.4 最佳實務 15.5 本章 Checklist 與小結 第16章 大型 Web Application 知識庫應用 16.1 官方立場回顧:「Beyond Books」 16.2 把整個 docs/ 資料夾轉成 Skill 16.3 DDD/Microservices/Clean Architecture/Hexagonal 場景應用(作者延伸) 16.4 Review/Testing/Refactoring 場景應用(作者延伸) 16.5 最佳實務 16.6 本章 Checklist 與小結 第17章 AI Agent Workflow/方法論整合(作者延伸) 17.1 book-to-skill 在 AI Agent Workflow 中的定位 17.2 與 Spec Driven Development 系列方法論整合(作者建議) 17.3 與 Multi-Agent/Council 類方法論整合(作者建議) 17.4 最佳實務 17.5 本章 Checklist 與小結 第18章 企業導入治理(Governance) 18.1 Governance 總覽 18.2 版本管理(Version) 18.3 Knowledge Base/Repository 存放策略 18.4 Review:validate_skill.py 深度用法 18.5 Security:scan_generated_skill.py 的治理角色 18.6 Compliance(合規) 18.7 Audit(稽核軌跡,作者建議) 18.8 RBAC(誠實說明:無內建機制,需依賴底層存取控制) 18.9 本章 Checklist 與小結 第19章 CI/CD 整合 19.1 book-to-skill 自身的 CI(真實依據) 19.2 企業 CI 中的品質閘門(作者建議) 19.3 GitHub Actions 完整範例 19.4 GitLab CI 範例 19.5 Azure DevOps 範例 19.6 Jenkins 範例 19.7 「自動建立 Skills」的實際可行邊界(誠實說明) 19.8 版本管理/測試/發佈 19.9 本章 Checklist 與小結 第20章 Maintenance(維運) 20.1 Update/Fold-in 維運週期 20.2 book-to-skill 本身的升級 20.3 Backup(備份) 20.4 Migration(搬遷) 20.5 Troubleshooting 20.6 Monitoring/Logging(延續 3.10 節的補強建議) 20.7 Performance/Optimization 20.8 本章 Checklist 與小結 第21章 企業最佳實務(Best Practice) 21.1 大型企業如何使用 book-to-skill:總覽 21.2 知識治理 21.3 文件管理 21.4 版本管理(治理原則,工具操作見19.8節) 21.5 多人協作 21.6 Skill Review(類似 Code Review 的審查流程) 21.7 Quality Gate 21.8 AI Governance 21.9 避免「知識墳場」 21.10 本章 Checklist 與小結 第22章 與其他工具比較 22.1 比較維度說明 22.2 vs. NotebookLM 22.3 vs. 傳統 RAG(展開 1.10 節) 22.4 vs. MCP Memory 類伺服器 22.5 vs. Context7 22.6 vs. Cognee 22.7 vs. codebase-memory-mcp 22.8 vs. OpenMemory(⚠️ 作者依公開資訊之一般性描述,非逐一查證版本細節) 22.9 vs. Knowledge Graph(通用類) 22.10 綜合比較表 22.11 關鍵洞察:book-to-skill 的差異化定位 22.12 本章 Checklist 與小結 第23章 完整案例(作者原創案例走查) 23.1 案例一:保險業 Spring Boot 3→4 升級知識庫建置 23.1.1 背景與任務發起 23.1.2 轉換與查詢過程 23.1.3 效益與知識沉澱 23.2 案例二:製造業 Legacy Java 系統現代化前的知識庫盤點 23.2.1 背景與任務發起 23.2.2 轉換與查詢過程 23.2.3 新人 Onboarding 對照 23.2.4 知識沉澱範本(團隊內部記錄格式示意) 23.3 案例三:新創公司 Vue3 前端設計系統知識庫 23.3.1 背景與任務發起 23.3.2 轉換與查詢過程 23.3.3 效益 23.4 案例四:SI 顧問團隊為客戶 PowerBuilder 老系統做知識移轉 23.4.1 背景與任務發起 23.4.2 轉換與查詢過程 23.4.3 交接效益 23.5 四案例綜合對照 23.6 本章 Checklist 與小結 第24章 完整 CLI 指令大全 24.1 三層 CLI 入口總覽 24.2 pip 獨立 CLI:book-to-skill 24.3 scripts/extract.py(Agent Skill 內部薄殼層) 24.4 tools/discovery_tax.py:Token 成本量測工具 24.5 tools/validate_skill.py:格式合規驗證 24.6 tools/scan_generated_skill.py:安全掃描 24.7 Agent Skill 斜線指令:/book-to-skill(各 Host 內使用) 24.8 CLI Cheat Sheet 總表 24.9 本章 Checklist 與小結 第25章 FAQ 25.1 基礎概念(Q1–Q15) 25.2 安裝與環境(Q16–Q30) 25.3 使用與操作(Q31–Q48) 25.4 格式與解析(Q49–Q60) 25.5 安全與合規(Q61–Q72) 25.6 企業導入與治理(Q73–Q88) 25.7 與其他工具比較(Q89–Q98) 25.8 疑難排解(Q99–Q112) 25.9 本章 Checklist 第26章 常見錯誤(55個) 26.1 安裝與環境類(錯誤 1–8) 26.2 轉換與生成類(錯誤 9–18) 26.3 格式與解析類(錯誤 19–26) 26.4 Skill 品質與內容類(錯誤 27–36) 26.5 安全與合規類(錯誤 37–44) 26.6 企業導入與治理類(錯誤 45–55) 26.7 本章 Checklist 第27章 Prompt Engineering:如何寫出高品質 Skill 27.1 如何對 book-to-skill 下指令 27.2 如何建立高品質 Skill:把 Quality Rules 變成團隊寫作規範 27.3 如何建立大型 Knowledge:分主題整併策略 27.4 如何避免 Hallucination(幻覺) 27.5 本章 Checklist 與小結 第28章 企業導入建議(依產業) 28.1 銀行業 28.2 保險業 28.3 政府部門 28.4 醫療產業 28.5 製造業 28.6 大型系統整合商(SI) 28.7 SaaS 公司 28.8 新創公司(Startup) 28.9 各產業導入要點對照表 28.10 本章 Checklist 與小結 第29章 完整實戰:從一本 PDF 到團隊日常開發流程 29.1 完整流程總覽 29.2 Step 1:取得 PDF 並判斷內容類型 29.3 Step 2:執行轉換 29.4 Step 3:驗證與人工抽查 29.5 Step 4:納入版控與 CI Gate 29.6 Step 5:登記進團隊 CLAUDE.md 29.7 Step 6:Coding 階段查詢輔助設計決策 29.8 Step 7:Code Review 引用 Skill 作為審查依據 29.9 Step 8:Testing 階段依 Anti-patterns 設計測試案例 29.10 Step 9:Deploy 後持續 Fold-in 29.11 本章 Checklist 與小結 第30章 總結與未來發展 30.1 全書核心觀點回顧 30.2 版本演進脈絡與展望 30.3 AI Agent 趨勢與 Skill 生態系 30.4 Knowledge Engineering 的未來 30.5 最佳建議 30.6 學習路線圖 30.7 本章 Checklist 與小結 附錄 A.1 全書核心原則速查 A.2 名詞對照表 A.3 References(參考資料) A.4 新進成員快速上手 Checklist 結語 圖例與符號說明 本手冊沿用企業教材慣例,以下符號在全書中意義固定: ...

August 4, 2026 · 56 min · 11825 words · Eric Cheng

Reverse Skill 教學手冊

reverse-skill 教學手冊 reverse-skill — AI Coding Agent 的「Skill Router」:逆向工程/合法授權滲透測試/資安研究技能路由套件 適用對象:資深工程師、資安研究人員、DevSecOps 負責人、AI Agent 平台團隊、架構師、Tech Lead、企業導入人員、PM 文件性質:企業內部 AI Agent 安全技能路由平台導入、開發與維運培訓教材 版本基準:reverse-skill(zhaoxuya520/reverse-skill,2026 年 5 月 13 日建立、核心 MIT License、 v1.0.0 正式版於 2026-07-18 發布、持續高頻更新;本次改版核校時間點 2026-08-04) ⚠️ 重要聲明(請務必先讀) reverse-skill 仍在高速迭代中。 本專案於 2026-05-13 建立,成長速度極快,於 2026-07-31 登上 GitHub Trending/Trendshift 全站排行前列,截至本次核校(2026-08-04,透過 GitHub API 直接查證)已有 約 16,200 Stars、2,275 Forks、67 Subscribers、13 個開放 Issue,並維持每日甚至單日多次 commit 的節奏。其資料夾結構、路由規則、Skill 清單、MCP 介面在版本之間可能持續變動。任何指令、 檔名與設定在正式導入前,務必以最新官方 Repository 為準;本手冊所列數字僅為核校當下快照。 本手冊的定位是「理解、彙整、分析、重組、補充最佳實務」,而非官方文件翻譯。 依撰寫要求,本書 不直接翻譯 README、不大量抄錄原文,而是以企業教育訓練教材的角度重新組織、加入架構圖、比較表、 最佳實務與導入建議。 內容分兩類: 官方已確認事實(例如 RULES.md/MASTER-ROUTING.md 兩層路由、skills/ 下 40 餘個技能 子目錄、skills/ops/scope-contract.md 授權契約、skills/field-journal/ 知識日誌、 burp-mcp-full/ Burp Suite 擴充套件與 mcp-bridge.js、docs/ARCHITECTURE.md、 README_AI.md 等)作為骨幹,內文一律使用 repo 內實際檔名/資料夾名稱,不使用意譯替代。 本次核校已透過 GitHub API 直接讀取 repo 檔案樹、README.md、RULES.md、 skills/MASTER-ROUTING.md、CHANGELOG.md 等原始檔案逐一比對,非僅憑記憶或二手轉述。 作者補充:凡屬作者依企業(含金融業、保險業)導入 AI Agent 安全治理之實務經驗所補充或推論 之處,會標註 (作者建議) 或 (作者推論)。這些是最佳實務參考,非官方保證。 本手冊聚焦「防禦、合法授權研究、安全審查、教育訓練與報告產出」。 凡涉及滲透測試、逆向工程、 Burp MCP 章節,一律以「取得書面授權後的合法測試」「防禦分析」「相容性研究」為前提,不提供、 不示範任何未授權攻擊操作、惡意程式撰寫、繞過偵測或供實際入侵使用的步驟。若你的用途無法滿足 合法授權前提,請勿依本手冊內容操作對應工具。 ...

August 4, 2026 · 54 min · 11363 words · Eric Cheng

Open Code Review 教學手冊

Open Code Review 教學手冊 副標題:AI 原生軟體開發平台的自動化 Code Review 引擎 —— 從安裝、設定、LLM 串接、 AI Agent 整合,到 Legacy Reverse Engineering、Framework Upgrade 與銀行級企業導入實戰 適用對象:資深後端/全端工程師、DevSecOps 工程師、AI Agent 平台團隊、 Tech Lead/架構師、企業導入評估的技術主管 文件性質:本手冊為作者依據官方原始碼與文件重新整理、統整、擴充後的教學/實戰教材, 非官方文件的翻譯或逐字引用。文中明確區分「官方已確認事實」與「作者補充/企業實務建議/ 推論」,請務必先閱讀下方「重要聲明」章節。 版本基準: 專案:alibaba/open-code-review(Go 語言,Apache-2.0 授權,建立於 2026-05-18) npm 套件:@alibaba-group/open-code-review CLI 指令:ocr 查證基準日:2026-08-03,直接查證 GitHub API metadata、官方 README.md/ ROADMAP.md/pages/src/content/docs/en/*.md 文件頁與部分 internal// cmd/opencodereview/ 原始碼(★ 18,203 顆星、1,225 forks、76 open issues、 最新版本 v1.8.6,發布於 2026-08-03) 官方網站/文件站:https://open-codereview.ai、https://open-codereview.ai/docs 重要聲明(請務必先讀) 本手冊撰寫時,作者以官方 README、ROADMAP.md、pages/src/content/docs/en/*.md 文件頁面與 internal/ 原始碼目錄逐一查證,而非僅憑第二手摘要或行銷文案。以下區分兩種 內容: 🟢 官方已確認事實:可在官方 repo(原始碼、文件頁、ROADMAP.md、GitHub API metadata) 中直接查證的內容。 🟡 作者補充/企業實務建議/推論:官方文件未明確涵蓋,由作者依業界慣例、企業導入 經驗、或架構原理合理推論、延伸建議的內容。所有這類內容都會在該段落明確標示 「(企業建議)」「(作者推論)」「(原則上可行,非官方紀錄)」等字樣。 請特別留意以下幾項容易望文生義、與坊間常見說法有落差的訂正: ...

August 3, 2026 · 67 min · 14110 words · Eric Cheng

Code Review Graph 教學手冊

Code-Review-Graph 教學手冊 Code-Review-Graph — 本地優先(Local-first)程式碼知識圖譜與 AI Code Review 加速引擎企業級完整指南 適用對象:資深工程師、AI Agent 平台團隊、架構師、Tech Lead、DevSecOps 負責人、企業導入人員、PM 文件性質:企業內部 AI Agent 開發流程標準導入、開發與維運培訓教材 版本基準:Code-Review-Graph(tirth8205/code-review-graph,MIT License,PyPI 套件 code-review-graph,參考版本 v2.3.6+) ⚠️ 重要聲明(請務必先讀) Code-Review-Graph 仍在持續迭代中。 本專案為開源專案(MIT License,GitHub 星數 28.1k+、Fork 2.6k+,主分支 900+ commits),其 CLI 指令、MCP 工具清單、環境變數與設定檔格式可能隨版本演進而調整。任何指令與設定在正式導入前,務必以官方最新文件(docs/USAGE.md、docs/COMMANDS.md、docs/FAQ.md、docs/TROUBLESHOOTING.md、docs/GITHUB_ACTION.md、docs/ROADMAP.md)與您實際安裝版本為準。 本手冊定位是「理解、彙整、分析、重組、補充企業導入最佳實務」,而非官方 README 或文件的翻譯。 本書不直接翻譯、不直接抄錄原文,而是重新以繁體中文彙整、重組、延伸為企業教材,並大量補充實戰案例、企業導入策略與 AI Agent 協作方法論。 內容分兩類: 官方已確認事實(例如 Tree-sitter 多語言解析、SQLite 圖譜儲存、30 個 MCP 工具、build/update/serve 等 CLI 指令、GitHub Action 用法、環境變數清單、基準測試數據等)作為骨幹,均已對照官方 README 及文件重新查證。 作者補充:凡屬作者依大型企業(含金融業)導入 AI Agent 程式碼審查之實務經驗所補充、推論或延伸之處,會標註 (企業實務建議) 或 (作者推論)。這些是最佳實務參考,非官方保證,導入前請自行驗證於您的環境。 本手冊中所有「企業案例」(第 16 章、第 23 章)皆為教學示範用途之虛構情境,用於示範 Code-Review-Graph 與既有技術堆疊(Spring Boot 4.x、Vue3、Java25 等)的整合模式,非真實客戶專案。涉及既有框架的深入機制,請參閱本 Repository 既有手冊: Spring boot 4.x 教學手冊 Maven 4.x 教學手冊 Vue3 前端framework教學 PrimeVue使用教學 Java25升版教學 官方權威來源請見 第 24 章 附錄 → 24.7 官方文件索引。 目錄 第一章 專案背景與痛點分析 1.1 原理 1.1.1 專案背景與誕生脈絡 1.1.2 設計理念:Local-first 與 Graph-based Context 1.1.3 要解決的核心問題 1.1.4 AI Code Review 的痛點:Token 浪費 1.1.5 Context Window 與 Architecture Blind Spot 1.1.6 Global Context 與 Local-first 的權衡 1.1.7 核心概念:Knowledge Graph、Impact Radius、Architecture Awareness 1.1.8 與傳統 RAG 的差異 1.1.9 與 Vector Database 的差異 1.1.10 與純 AST 工具的差異 1.1.11 與其他 MCP Tool 的差異 1.1.12 與 GraphRAG 的差異 1.2 架構圖(Mermaid) 1.3 流程圖(Mermaid) 1.4 Sequence Diagram 1.5 實作 1.6 範例 1.7 最佳實務 1.8 常見錯誤 1.9 效能建議 1.10 AI Agent 如何使用 1.11 Enterprise 建議 第二章 整體系統架構 2.1 原理 2.1.1 分層架構總覽 2.1.2 資料來源層:Git Repository 2.1.3 解析層:Tree-sitter 與 AST 抽取 2.1.4 圖譜層:Graph Builder 與 SQLite 2.1.5 服務層:Review Engine、Impact Analyzer、MCP Server 2.1.6 整合層:AI Agent 與 CI/CD 2.1.7 Data Flow 總覽 2.2 架構圖(Mermaid) 2.3 流程圖(Mermaid) 2.4 Sequence Diagram 2.5 實作 2.6 範例 2.7 最佳實務 2.8 常見錯誤 2.9 效能建議 2.10 AI Agent 如何使用 2.11 Enterprise 建議 第三章 Tree-sitter 與 AST 解析 3.1 原理 3.1.1 Tree-sitter 是什麼 3.1.2 AST 節點型別與四大分類 3.1.3 支援語言清單 3.1.4 增量解析機制(Incremental Parsing) 3.1.5 自訂語言支援:languages.toml 3.1.6 從 AST 到 Graph:Node 的定義 3.1.7 從 AST 到 Graph:Edge 與四種關係圖 3.1.8 Reference Graph 與信賴度分級 3.2 架構圖(Mermaid) 3.3 流程圖(Mermaid) 3.4 Sequence Diagram 3.5 實作 3.6 範例 3.7 最佳實務 3.8 常見錯誤 3.9 效能建議 3.10 AI Agent 如何使用 3.11 Enterprise 建議 第四章 Knowledge Graph 邏輯模型 4.1 原理 4.1.1 Knowledge Graph 在 Code-Review-Graph 中的定位 4.1.2 Node 的完整屬性模型 4.1.3 Edge 的完整屬性模型 4.1.4 Relationship 型別總表 4.1.5 Graph Schema(邏輯層級) 4.1.6 Graph Query 與 Traversal 策略 4.1.7 Impact Analysis 的圖論基礎 4.1.8 Community Detection:Leiden 演算法 4.1.9 Architecture Discovery:從社群到架構總覽 4.2 架構圖(Mermaid) 4.3 流程圖(Mermaid) 4.4 Sequence Diagram 4.5 實作 4.6 範例 4.7 最佳實務 4.8 常見錯誤 4.9 效能建議 4.10 AI Agent 如何使用 4.11 Enterprise 建議 第五章 SQLite 儲存層 5.1 原理 5.1.1 為何選擇 SQLite 而非專用圖資料庫 5.1.2 資料庫檔案位置 5.1.3 實際 Schema 設計(依官方 docs/schema.md 核對) 5.1.4 索引策略 5.1.5 WAL 模式與並行存取 5.1.6 Migration 策略 5.1.7 Backup 與 Restore 5.1.8 Maintenance:定期維護 5.2 架構圖(Mermaid) 5.3 流程圖(Mermaid) 5.4 Sequence Diagram 5.5 實作 5.6 範例 5.7 最佳實務 5.8 常見錯誤 5.9 效能建議 5.10 AI Agent 如何使用 5.11 Enterprise 建議 第六章 安裝 6.1 原理 6.1.1 安裝方式總覽 6.1.2 系統需求 6.1.3 選配依賴總表 6.1.4 Windows 安裝要點 6.1.5 Linux 安裝要點 6.1.6 macOS 安裝要點 6.1.7 WSL 安裝要點(企業實務建議) 6.1.8 Docker/Podman 容器化部署(企業實務建議) 6.1.9 驗證安裝 6.2 架構圖(Mermaid) 6.3 流程圖(Mermaid) 6.4 Sequence Diagram 6.5 實作 6.6 範例 6.7 最佳實務 6.8 常見錯誤 6.9 效能建議 6.10 AI Agent 如何使用 6.11 Enterprise 建議 第七章 設定與初始化 7.1 原理 7.1.1 初始化流程 7.1.2 .code-review-graphignore 語法與規則 7.1.3 與 .gitignore 的關係 7.1.4 大型 Repository 考量 7.1.5 Incremental Build:update、watch 與平台原生 Hook 7.1.6 Configuration 總覽 7.2 架構圖(Mermaid) 7.3 流程圖(Mermaid) 7.4 Sequence Diagram 7.5 實作 7.6 範例 7.7 最佳實務 7.8 常見錯誤 7.9 效能建議 7.10 AI Agent 如何使用 7.11 Enterprise 建議 第八章 MCP Server 詳解 8.1 原理 8.1.1 MCP 是什麼、為何是關鍵拼圖 8.1.2 啟動 MCP Server 8.1.3 自動化設定:code-review-graph install 8.1.4 MCP 設定檔格式 8.1.5 MCP 工具全覽(30 個工具,8 大分類) 8.1.6 MCP Prompts:5 個工作流樣板 8.1.7 Tool Calling 與 Context Injection 的運作模式 8.2 架構圖(Mermaid) 8.3 流程圖(Mermaid) 8.4 Sequence Diagram 8.5 實作 8.6 範例 8.7 最佳實務 8.8 常見錯誤 8.9 效能建議 8.10 AI Agent 如何使用 8.11 Enterprise 建議 第九章 如何協助 AI Agent:九大場景 9.1 原理 9.1.1 Architecture Discovery(架構探索) 9.1.2 Context Retrieval(上下文檢索) 9.1.3 Impact Radius(影響範圍分析) 9.1.4 Function Analysis(函式分析) 9.1.5 Class Analysis(類別分析) 9.1.6 Dependency Analysis(依賴分析) 9.1.7 PR Review(Pull Request 審查) 9.1.8 Root Cause Analysis(根因分析) 9.1.9 Refactoring(重構) 9.2 架構圖(Mermaid) 9.3 流程圖(Mermaid) 9.4 Sequence Diagram 9.5 實作 9.6 範例 9.7 最佳實務 9.8 常見錯誤 9.9 效能建議 9.10 AI Agent 如何使用 9.11 Enterprise 建議 第十章 逆向工程與大型系統分析 10.1 原理 10.1.1 逆向工程為何是 Code-Review-Graph 的殺手級場景 10.1.2 Legacy Java/Spring 系統的逆向工程模式 10.1.3 跨語言逆向工程:.NET、Node.js、Python 10.1.4 前端框架逆向工程:Vue、Angular、React 10.1.5 大型系統分析的漏斗式方法論 10.1.6 Architecture Recovery 與 Dependency Discovery 10.2 架構圖(Mermaid) 10.3 流程圖(Mermaid) 10.4 Sequence Diagram 10.5 實作 10.6 範例 10.7 最佳實務 10.8 常見錯誤 10.9 效能建議 10.10 AI Agent 如何使用 10.11 Enterprise 建議 第十一章 Framework Upgrade 影響分析 11.1 原理 11.1.1 為何 Framework Upgrade 是 Impact Analysis 的天然應用場景 11.1.2 框架升級的通用四步驟方法論 11.1.3 Java/Jakarta EE 升級案例:javax.* → jakarta.* 命名空間遷移 11.1.4 Spring Boot 升級案例:組態屬性與 Bean 定義變更 11.1.5 MyBatis/Hibernate ORM 遷移案例 11.1.6 前端框架升級案例:Vue 2 → Vue 3、AngularJS → Angular 11.1.7 API Migration:內部 API 版本演進 11.2 架構圖(Mermaid) 11.3 流程圖(Mermaid) 11.4 Sequence Diagram 11.5 實作 11.6 範例 11.7 最佳實務 11.8 常見錯誤 11.9 效能建議 11.10 AI Agent 如何使用 11.11 Enterprise 建議 第十二章 架構感知的 Code Review 12.1 原理 12.1.1 什麼是「架構感知」的 Code Review 12.1.2 Security(安全性)視角 12.1.3 Performance(效能)視角 12.1.4 Maintainability 與 Readability 視角 12.1.5 Dependency Risk 與 Circular Dependency(循環依賴) 12.1.6 Dead Code(死碼)偵測 12.1.7 整合為 Code Review Checklist 12.2 架構圖(Mermaid) 12.3 流程圖(Mermaid) 12.4 Sequence Diagram 12.5 實作 12.6 範例 12.7 最佳實務 12.8 常見錯誤 12.9 效能建議 12.10 AI Agent 如何使用 12.11 Enterprise 建議 第十三章 GitHub Action 與 CI/CD 整合 13.1 原理 13.1.1 為何 CI/CD 整合是企業導入的關鍵里程碑 13.1.2 官方 Composite Action 用法 13.1.3 執行行為:本地優先、Sticky Comment 13.1.4 Risk Score 與 Merge Gate 13.1.5 PR 評論內容:Architecture Summary 13.1.6 與既有 CI/CD 生態的搭配 13.1.7 Fork PR 的安全限制與雙工作流程設計(企業實務建議) 13.2 架構圖(Mermaid) 13.3 流程圖(Mermaid) 13.4 Sequence Diagram 13.5 實作 13.6 範例 13.7 最佳實務 13.8 常見錯誤 13.9 效能建議 13.10 AI Agent 如何使用 13.11 Enterprise 建議 第十四章 AI Coding Workflow 全流程 14.1 原理 14.1.1 從單點工具到端到端工作流 14.1.2 完整流程十一步 14.1.3 流程中的兩個關鍵回饋迴圈 14.1.4 流程失敗模式與斷點偵測 14.2 架構圖(Mermaid) 14.3 流程圖(Mermaid) 14.4 Sequence Diagram 14.5 實作 14.6 範例 14.7 最佳實務 14.8 常見錯誤 14.9 效能建議 14.10 AI Agent 如何使用 14.11 Enterprise 建議 第十五章 大型企業架構風格最佳實務 15.1 原理 15.1.1 圖譜分析與架構風格的交會點 15.1.2 Monorepo 場景 15.1.3 Microservice 場景 15.1.4 DDD(領域驅動設計)場景 15.1.5 Clean/Hexagonal/Onion Architecture 場景 15.1.6 Event-Driven Architecture 場景 15.1.7 大型 Repository 的通用治理原則 15.2 架構圖(Mermaid) 15.3 流程圖(Mermaid) 15.4 Sequence Diagram 15.5 實作 15.6 範例 15.7 最佳實務 15.8 常見錯誤 15.9 效能建議 15.10 AI Agent 如何使用 15.11 Enterprise 建議 第十六章 Web Application 完整案例 16.1 原理 16.1.1 技術棧總覽與既有教材對照 16.1.2 專案結構與初始化 16.1.3 後端圖譜建置要點(Java 25 / Spring Boot 4 / Maven 4) 16.1.4 前端圖譜建置要點(Vue3 / TypeScript / PrimeVue) 16.1.5 PostgreSQL、Redis、Kafka 的圖譜可見度 16.1.6 OpenAPI 契約與跨前後端 Impact Analysis 16.1.7 Docker、Kubernetes 與 CI 整合位置 16.1.8 端到端情境:新增「訂單退貨」功能 16.2 架構圖(Mermaid) 16.3 流程圖(Mermaid) 16.4 Sequence Diagram 16.5 實作 16.6 範例 16.7 最佳實務 16.8 常見錯誤 16.9 效能建議 16.10 AI Agent 如何使用 16.11 Enterprise 建議 第十七章 與 AI 工具整合 17.1 原理 17.1.1 整合的共同基礎:MCP 協定 17.1.2 Claude Code 17.1.3 Cursor 17.1.4 GitHub Copilot(含 Copilot CLI) 17.1.5 OpenAI Codex CLI 17.1.6 Gemini CLI 17.1.7 Continue.dev、Cline、Roo Code 17.1.8 多平台並存的企業考量 17.1.9 其他官方自動偵測平台:Windsurf、Zed、OpenCode、Antigravity、CodeBuddy Code、Qwen、Qoder、Kiro 17.1.10 VS Code Extension:獨立於 MCP 協定之外的原生整合方案 17.2 架構圖(Mermaid) 17.3 流程圖(Mermaid) 17.4 Sequence Diagram 17.5 實作 17.6 範例 17.7 最佳實務 17.8 常見錯誤 17.9 效能建議 17.10 AI Agent 如何使用 17.11 Enterprise 建議 第十八章 企業導入指南 18.1 原理 18.1.1 導入流程:四階段路線圖 18.1.2 團隊規範:從「工具」到「規範」 18.1.3 Repository 規範 18.1.4 Branch Strategy 與 Graph 的關係 18.1.5 Code Review Policy 整合 18.1.6 Graph 更新策略的治理選擇 18.1.7 CI/CD 的組織級規劃 18.2 架構圖(Mermaid) 18.3 流程圖(Mermaid) 18.4 Sequence Diagram 18.5 實作 18.6 範例 18.7 最佳實務 18.8 常見錯誤 18.9 效能建議 18.10 AI Agent 如何使用 18.11 Enterprise 建議 第十九章 維護 19.1 原理 19.1.1 維護的三個層次 19.1.2 Graph Rebuild:何時需要完整重建 19.1.3 Daemon:多倉庫常駐監看 19.1.4 Parser/Language 更新 19.1.5 Migration 與 Upgrade 策略 19.1.6 卸載與清理 19.2 架構圖(Mermaid) 19.3 流程圖(Mermaid) 19.4 Sequence Diagram 19.5 實作 19.6 範例 19.7 最佳實務 19.8 常見錯誤 19.9 效能建議 19.10 AI Agent 如何使用 19.11 Enterprise 建議 第二十章 疑難排解(100+ FAQ) 20.1 原理 20.2 架構圖(Mermaid) 20.3 流程圖(Mermaid) 20.4 Sequence Diagram 20.5 實作 20.6 常見問題總表(100+ FAQ) 20.6.1 安裝與環境(Q1–Q14) 20.6.2 建圖與解析(Q15–Q28) 20.6.3 MCP 與 Agent 整合(Q29–Q42) 20.6.4 圖查詢與結果解讀(Q43–Q56) 20.6.5 GitHub Action/CI(Q57–Q68) 20.6.6 效能與規模(Q69–Q80) 20.6.7 多倉庫與 Daemon(Q81–Q90) 20.6.8 安全與合規(Q91–Q104) 20.7 最佳實務 20.8 常見錯誤 20.9 效能建議 20.10 AI Agent 如何使用 20.11 Enterprise 建議 第二十一章 最佳實務總表(100+ 條) 21.1 原理 21.2 架構圖(Mermaid) 21.3 流程圖(Mermaid) 21.4 Sequence Diagram 21.5 實作 21.6 範例 21.7 最佳實務總表(100+ 條) 21.7.1 導入與治理(BP1–BP15) 21.7.2 圖譜維運(BP16–BP30) 21.7.3 Agent 協作(BP31–BP50) 21.7.4 Code Review 整合(BP51–BP65) 21.7.5 CI/CD(BP66–BP75) 21.7.6 安全與合規(BP76–BP88) 21.7.7 跨團隊協作(BP89–BP96) 21.7.8 效能(BP97–BP105) 21.8 常見錯誤 21.9 效能建議 21.10 AI Agent 如何使用 21.11 Enterprise 建議 第二十二章 AI Prompt Library(150+ 提示詞) 22.1 原理 22.2 架構圖(Mermaid) 22.3 流程圖(Mermaid) 22.4 Sequence Diagram 22.5 實作 22.6 提示詞總表(150+ 則) 22.6.1 Architecture 分析(P1–P13) 22.6.2 Dependency 分析(P14–P26) 22.6.3 API 分析(P27–P38) 22.6.4 Service 分析(P39–P50) 22.6.5 Impact 分析(P51–P63) 22.6.6 Risk 分析(P64–P75) 22.6.7 PR 分析(P76–P88) 22.6.8 Bug 分析(P89–P100) 22.6.9 Refactoring 分析(P101–P113) 22.6.10 Performance 分析(P114–P125) 22.6.11 Security 分析(P126–P138) 22.6.12 Test Coverage 分析(P139–P152) 22.7 最佳實務 22.8 常見錯誤 22.9 效能建議 22.10 AI Agent 如何使用 22.11 Enterprise 建議 第二十三章 完整企業案例:銀行大型系統 23.1 原理 23.1.1 專案背景 23.1.2 需求階段:架構盡職調查 23.1.3 設計階段:現代化改造範圍界定 23.1.4 Coding 階段:AI 協作開發 23.1.5 Review 階段:架構感知審查 + 人工複核雙重把關 23.1.6 Testing 階段:以 Impact Radius 驅動測試優先序 23.1.7 Deployment 階段:Kubernetes 部署與 CI 品質關卡 23.1.8 Maintenance 階段:常態化架構治理 23.2 架構圖(Mermaid) 23.3 流程圖(Mermaid) 23.4 Sequence Diagram 23.5 實作 23.6 範例 23.7 最佳實務 23.8 常見錯誤 23.9 效能建議 23.10 AI Agent 如何使用 23.11 Enterprise 建議 第二十四章 附錄:指令速查表 24.1 CLI Cheat Sheet 24.2 MCP 工具 Cheat Sheet 24.3 Tree-sitter/語言支援 Cheat Sheet 24.4 SQLite Cheat Sheet 24.5 環境變數 Cheat Sheet 24.6 Mermaid Cheat Sheet(本手冊使用慣例) 24.7 官方文件索引 24.8 GitHub Action Cheat Sheet 附錄 企業導入總檢查清單 A.1 安裝與環境檢查清單 A.2 設定與初始化檢查清單 A.3 MCP 與 Agent 整合檢查清單 A.4 Code Review 與 CI/CD 檢查清單 A.5 安全與合規檢查清單 A.6 維護與治理檢查清單 A.7 團隊賦能檢查清單 第一章 專案背景與痛點分析 1.1 原理 1.1.1 專案背景與誕生脈絡 Code-Review-Graph 誕生於一個非常具體的觀察:AI Coding Agent(Claude Code、Cursor、GitHub Copilot Agent Mode 等)在協助工程師進行 Code Review 或修改程式碼時,最大的成本不是「推理」,而是「找答案前的閱讀」。一個 Agent 要理解「這個函式改了會影響誰」,往往得先用 grep、Read 把半個 Repository 掃過一遍——不是因為它笨,而是因為它手上沒有一張「地圖」。 ...

August 3, 2026 · 72 min · 15305 words · Eric Cheng