Auggie 使用者規則範例檔案（優化版）

為什麼需要優化？

原始的使用者規則檔案可能包含許多對 AI 助手來說不必要或甚至會造成干擾的內容：

• ❌ Git Commit 格式 ：Auggie 不會執行 git commit

• ❌ 分支命名規範 ：Auggie 不會建立分支

• ❌ 具體的測試覆蓋率數字 ：過於具體，不適合所有情境

• ❌ 文件撰寫規範 ：可能與系統提示衝突

這個優化版本專注於 Auggie 真正需要的指引。

完整範例檔案（優化版）

將以下內容儲存為 ~/.augment/rules/personal-preferences.md：

優化說明

這個優化版本相較於原始範例，做了以下調整：

建立步驟

1. 建立目錄 （如果不存在）：

   mkdir -p ~/.augment/rules

2. 建立規則檔案：

   cat > ~/.augment/rules/personal-preferences.md << 'EOF' # 個人開發偏好設定 ## 系統環境 - **作業系統**：macOS (ARM64 - Apple Silicon) - **主要語言**：繁體中文（zh-tw） - **回應風格**：使用台灣慣用的繁體中文，技術術語保留英文但提供中文說明 ## Shell 工具偏好 ⚠️ **重要**：優先使用以下現代化工具，而非傳統 Unix 指令（如果尚未安裝，請先安裝）： | 任務類型 | 必須使用 | 不要使用 | |---------|---------|---------| | 尋找檔案 | `fd` | `find`, `ls -R` | | 搜尋文字 | `rg` (ripgrep) | `grep`, `ag` | | 分析程式碼結構 | `ast-grep` | `grep`, `sed` | | 互動式選擇 | `fzf` | 手動過濾 | | 處理 JSON | `jq` | `python -m json.tool` | | 處理 YAML/XML | `yq` | 手動解析 | ## 程式碼風格通用原則 ### 命名慣例 - 使用有意義的變數名稱，避免單字母變數（除了迴圈索引） - 函式名稱應該是動詞或動詞片語 - 類別名稱使用名詞 - 常數使用全大寫加底線（如 `MAX_RETRY_COUNT`） ### 註解原則 - 優先寫自解釋的程式碼，而非依賴註解 - 註解應該解釋「為什麼」而非「是什麼」 - 複雜的業務邏輯必須加上註解說明 - 公開的 API 必須有完整的文件註解 ### 錯誤處理 - 永遠處理可能的錯誤情況 - 使用具體的錯誤類型，避免捕捉通用的 Exception - 錯誤訊息應該提供足夠的上下文資訊 - 記錄錯誤時包含相關的變數值 ## 安全性考量 - 永遠不要在程式碼中硬編碼敏感資訊（密碼、API 金鑰等） - 使用環境變數或安全的密鑰管理服務 - 驗證所有使用者輸入 - 使用參數化查詢防止 SQL 注入 - 定期更新相依套件以修補安全漏洞 ## 效能最佳化 - 避免過早優化，先確保程式碼正確性 - 使用適當的資料結構和演算法 - 對資料庫查詢進行索引優化 - 實作適當的快取策略 - 監控和記錄效能指標 EOF

3. 驗證：

   # 檢查檔案是否建立成功 cat ~/.augment/rules/personal-preferences.md # 啟動 Auggie 並測試規則是否生效 auggie

進階技巧

相關資源

• Auggie CLI Rules 設定指南

• Auggie MCP 整合指南