Roo整合自定義專案規格 - daniel-qa/RooCode GitHub Wiki

Roo整合自定義專案規格

這是讓 Roo Code 理解您專案特定規則、設計模式和架構的關鍵。有幾種方式可以實現:

1. 將規格文件化並讓 Roo Code 讀取 (推薦)

建立規格文件: 在您的專案根目錄下,建立一個專門存放專案規格的文件或資料夾。例如:

docs/project_specs.md (Markdown 格式)

docs/architecture_guide.md

docs/api_standards.md (詳細說明 RESTful API 設計原則、錯誤碼、命名約定等)

docs/frontend_components.md (說明 Element Plus、Quasar、View UI Plus 的使用約定,自定義組件庫的設計規範等)

docs/backend_services.md (說明服務層、資料存取層的設計,Cosmos DB 和 Redis 的使用模式)

docs/i18n_guidelines.md (國際化實作細節)

docs/security_best_practices.md (JWT、身分驗證、授權的實作細節)
  • 文件內容:
概述專案目標和願景。

詳細描述架構設計:前端如何與後端互動,各層職責。

程式碼規範和約定: 例如命名規範、文件註解格式、錯誤處理方式等。

技術棧的特定使用方式: 例如,說明 Pinia 和 Vuex 如何共存(如果有的話),或在哪些場景下使用 Fluid Framework。

常用業務術語和領域模型: 讓 AI 了解您的業務邏輯。
  • 將規格文件添加到 Roo Code 上下文:
在 Roo Code 聊天介面中,點擊 "Add Context" 按鈕。

選擇 "Add File",然後瀏覽並選擇您剛剛建立的規格文件 (例如 docs/project_specs.md)。

您可以添加多個文件。這樣,Roo Code 在處理您的程式碼問題時,會將這些規格作為重要的參考依據。

提示: 每次啟動新的 Roo Code 會話時,可能需要重新添加上下文,或者將常用的上下文設定為預設。