TTechSpecs

指令用途

/grill-with-docs 是一個更強化的 /grill-me 版本。除了透過逐步追問來磨利計畫或設計外,它還會在過程中自動建立兩個重要的文件:

  1. ADR (Architecture Decision Record):記錄重要的架構決策
  2. 詞彙表 (Glossary):記錄領域專用術語和定義

這兩個文件會自動保存到 docs/ 目錄,成為專案的正式文件。


運作流程

  1. 初始對話:你提出計畫或設計,開始追問。
  2. 逐步深化:AI 針對關鍵問題進行密集訪談。
  3. 記錄決策:每次做出重要決策時,自動更新 ADR。
  4. 定義術語:遇到領域術語時,自動添加到詞彙表。
  5. 完成文件:追問結束後,檢查並確認文件完整性。

實戰對話範例

範例一:新增認證系統

  • You:
    /grill-with-docs
  • AI:

    讓我們一起磨利這個認證系統的設計。

    第一個問題:為什麼需要認證系統?要解決什麼問題?

    • You:

    目前任何人都可以訪問,需要限制存取權限。

    AI: 好的,我在 ADR 中記錄這個決策動機。

    ADR 已更新docs/adr/001-authentication-system.md

    第二個問題:你考慮過哪些認證方式?

    • You:

    OAuth 2.0 和 JWT token。

    AI: 讓我比較這兩個方案:

    OAuth 2.0

    • 優點:標準化、生態豐富、支援第三方登入
    • 缺點:複雜度較高、需要多個伺服器

    JWT Token

    • 優點:實作簡單、無狀態、跨伺服器
    • 缺點:token 難以撤銷、需要安全存儲

    哪個方案更符合你的需求?

    • You:

    JWT token,比較簡單。

    AI: ADR 已更新:選擇 JWT token 作為認證方式,因為實作簡單且符合需求。

    第三個問題:你提到「token」,這是指什麼?請定義一下。

    • You:

    JSON Web Token,一種用於資料驗證和完整性檢查的標準。

    AI: 詞彙表已更新

    • JWT Token:JSON Web Token,一種用於資料驗證和完整性檢查的標準

    讓我們繼續…


範例二:重構資料庫結構

  • You:
    /grill-with-docs
  • AI:

    讓我們一起磨利這個資料庫重構的計畫。

    第一個問題:為什麼要重構?目前的問題是什麼?

    • You:

    目前的單體資料庫太大了,查詢很慢。

    AI: 我在 ADR 中記錄這個問題。

    ADR 已更新docs/adr/002-database-refactoring.md

    第二個問題:你考慮過哪些重構方案?

    • You:

    垂直分區和水平分片。

    AI: 讓我解釋這兩個術語並記錄到詞彙表:

    詞彙表已更新

    • 垂直分區:根據業務邏輯將資料分散到不同的資料庫
    • 水平分片:根據資料的某個鍵值將資料分散到多個伺服器

    讓我比較這兩個方案:

    垂直分區

    • 優點:邏輯清晰、每個資料庫獨立維護
    • 缺點:跨資料庫查詢困難

    水平分片

    • 優點:分散負載、擴展性好
    • 缺點:實作複雜、需要分片鍵

    你的查詢模式是什麼?這會影響方案選擇。

    • You:

    大部分查詢都是單表的,很少跨表。

    AI: 這意味著垂直分區可能更適合。

    ADR 已更新:選擇垂直分區,因為查詢模式主要是單表操作。


與 /grill-me 的區別

特性 /grill-me /grill-with-docs
目的 磨利計畫或設計 磨利計畫或設計
文件生成 自動生成 ADR 和詞彙表
術語記錄 口頭確認 自動記錄到詞彙表
決策記錄 自動記錄到 ADR
適用場景 小型計畫、快速探索 中大型計畫、需要正式文件

何時使用

  • 需要正式文件的專案
  • 有重要的架構決策需要記錄
  • 領域術語需要統一定義
  • 長期維護的專案

輸出檔案

檔案會自動建立到以下位置:

docs/
├── adr/
│   ├── 001-authentication-system.md
│   └── 002-database-refactoring.md
└── glossary.md