跳轉到

AI知識庫寫作風格指南

摘要

本指南用於維持「AI知識庫」公開內容的一致性。新增或修改 docs/ 內容前，請同時參考 CONFIDENTIALITY.md 與 docs/policies/content-classification.md。

基本原則

  • 使用繁體中文。
  • 每頁只使用一個 H1。
  • 標題層級從 H1 開始，依序使用 H2、H3。
  • 段落短而清楚。
  • 指令、檔名、路徑使用 inline code，例如 mkdocs.yml。
  • 文件應優先回答「這是什麼」「何時使用」「如何操作」「注意什麼」。
  • 不確定資訊標示為「待確認」。
  • 不要把私人資料、未公開內容或機密資料放入正式文章。
  • AI 生成內容需人工檢查。
  • 新增文章後要更新 mkdocs.yml nav。

建議文章結構

# 文章標題

## 摘要

## 適用情境

## 核心內容

## 操作步驟

## 注意事項

## 相關頁面

## 更新紀錄

檔名與分類

  • 檔名建議使用英文小寫與連字號，例如 basic-prompt-patterns.md。
  • 中文標題可放在 Markdown 的 H1。
  • 新文章應放入最接近的分類資料夾。
  • 新增公開頁面後，請檢查 mkdocs.yml nav。

發布前提醒

  • 確認內容屬於 Public / 可公開。
  • 確認沒有 secrets、個人資料、學生資料、審稿資料或未公開研究資料。
  • 執行或準備執行 mkdocs build --strict。

更新紀錄

  • 2026-07-02：擴充格式、保密與 AI 生成內容規則。