更新知識庫流程¶

摘要¶

本頁提供更新 AI知識庫的完整流程，從收集資料到部署後確認。

適用情境¶

新增一篇文章。
整理既有筆記。
補充分類頁內容。
更新網站導覽。

操作步驟¶

1. 收集新資料¶

先確認資料來源與用途。若資料來自私人筆記、課程內部資料、研究資料或投稿內容，應先判斷是否可公開。

2. 判斷是否可公開¶

依照內容分級與發布規則分類。只有 Public / 可公開內容可放入 docs/。

3. 選擇分類¶

選擇最接近的資料夾，例如：

docs/prompt-engineering/
docs/workflows/
docs/research-writing/
docs/teaching/
docs/reference/

4. 使用文章模板¶

以 docs/TEMPLATE.md 作為文章結構。每篇文章至少應包含摘要、適用情境、核心內容、操作步驟、注意事項、相關頁面與更新紀錄。

5. 撰寫或整理內容¶

使用繁體中文。避免空泛佔位。若資訊未確認，標示「待確認」。

6. 更新 `mkdocs.yml` nav¶

新增頁面後，必須確認該頁能從導覽進入。不要把 private/、drafts/ 或 credentials 加入 nav。

7. 本機預覽¶

mkdocs serve

在本機檢查標題、導覽、連結與搜尋是否合理。

8. 執行 build¶

mkdocs build --strict

若 build 失敗，優先修正 build，再新增其他功能。

9. Commit 前檢查¶

是否含有 secrets？
是否含有個人資料或未公開資料？
mkdocs.yml nav 是否正確？
文章格式是否符合 docs/STYLE_GUIDE.md？

10. Push 或部署後確認¶

若使用 Cloudflare Pages：

wrangler pages deploy site --project-name ai-knowledge-base

部署後打開正式網址確認頁面可讀。若未來改用 GitHub Pages，push 後應確認 GitHub Actions 是否成功。

注意事項¶

不要直接公開 PDF 全文或未授權資料。
AI 產生內容需人工確認。
發現疑似敏感內容時，停止發布流程。

更新紀錄¶

2026-07-02：建立完整初始版。