Steering | Book of Kiro

• 一致的代碼生成 - 每個組件、API 端點或測試都遵循您團隊建立的模式和約定。
• 減少重複 - 無需在每次對話中解釋項目標準。Kiro 會記住您的偏好。
• 團隊協調 - 所有開發者都使用相同的標準，無論他們是項目新手還是資深貢獻者。
• 可擴展的項目知識 - 隨着代碼庫增長的文檔，記錄決策和模式，與項目一起演進。

Kiro 自動創建三個基礎文件，建立核心項目上下文：

• 產品概述 (product.md) - 定義您產品的目的、目標用戶、關鍵功能和業務目標。這幫助 Kiro 理解技術決策背後的”爲什麼”，並建議與您產品目標一致的解決方案。
• 技術棧 (tech.md) - 記錄您選擇的框架、庫、開發工具和技術約束。當 Kiro 建議實現方案時，它會優先選擇您已建立的技術棧而非替代方案。
• 項目結構 (structure.md) - 概述文件組織、命名約定、導入模式和架構決策。這確保生成的代碼無縫融入您現有的代碼庫。

這些基礎文件默認包含在每次交互中，形成 Kiro 項目理解的基線。

通過專門的 Steering 擴展 Kiro 的理解，滿足您項目的獨特需求：

1. 導航到 Kiro 面板中的 Steering 部分

2. 點擊 + 按鈕創建新的 .md 文件

3. 選擇描述性的文件名（例如 api-standards.md）

4. 使用標準 markdown 語法編寫您的指導

5. 使用自然語言描述您的要求，然後選擇Refine按鈕，Kiro 會爲您格式化

Steering 文件可以配置爲根據您的需求在不同時間加載。這種靈活性有助於優化性能，並確保在需要時提供相關上下文。

通過在 Steering 文件頂部添加前置元數據來配置包含模式。前置元數據使用 YAML 語法，必須放在文件的最開始，用三個破折號（---）包圍。

---

Inclusion: always 

---

這些文件會自動加載到每次 Kiro 交互中。將此模式用於應該影響所有代碼生成和建議的核心標準。示例包括您的技術棧、編碼約定和基本架構原則。 

使用場景：項目範圍的標準、技術偏好、安全策略和普遍適用的編碼約定。

---

Inclusion: fileMatch

FileeMatchPattern: ‘compents/**/*.tsx’

---

文件僅在處理匹配指定模式的文件時自動包含。這通過僅在需要時加載專門指導來保持上下文相關性並減少噪音。

常見模式：

• “*.tsx” - React components and JSX files

• “app/API/**/*” - API routes and 後端 logic

• “**/.測試.” - 測試 files and 測試環境 utilities

• “src/components/**/*” - 組件-specific guidelines

• “*.md” - 文件 files

適用場景：特定領域的標準，如組件模式、API 設計規則、測試方法或僅適用於特定文件類型的部署程序。

---

Inclusion: manual 

---

通過在聊天消息中使用 #steering-file-name 引用文件，按需提供文件。這讓您精確控制何時需要專門上下文，而不會使每次交互變得混亂。 

使用方法：在聊天中輸入 #troubleshooting-guide 或 #performance-optimization 來爲當前對話包含該 Steering 文件。

適用場景：專門的工作流程、故障排除指南、遷移程序或僅偶爾需要的上下文豐富文檔。

鏈接到實時項目文件以保持 Steering 的時效性：

#[[file:<relative_file_name>]]

示例：

• API specs: #[[file:api/openapi.yaml]]

• 組件 patterns: #[[file:components/ui/button.tsx]]

• Config templates: #[[file:.env.example]] 

保持文件專注 每個文件一個領域 - API 設計、測試或部署程序。

使用清晰的名稱

• api-standards.md - REST API 標準

• testing-unit-patterns.md - 單元測試的方法 

• components-form-validation.md - 表單組件標準

包含上下文 解釋爲什麼做出決策，而不僅僅是標準是什麼。

提供示例 使用代碼片段和前後對比來演示標準。

安全第一 永遠不要包含 API 密鑰、密碼或敏感數據。Steering 文件是代碼庫的一部分。 

定期維護

• 隨着項目發展更新 Steering 文件

• 刪除過時的約定

• 添加新的模式和決策 

• API 標準 (api-standards.md) - 定義 REST 約定、錯誤響應格式、認證流程和版本控制策略。包括端點命名模式、HTTP 狀態碼使用和請求/響應示例。
• 測試方法 (testing-standards.md) - 建立單元測試模式、集成測試策略、模擬方法和覆蓋率期望。記錄首選測試庫、斷言樣式和測試文件組織。
• 代碼風格 (code-conventions.md) - 指定命名模式、文件組織、導入排序和架構決策。包括首選代碼結構、組件模式和要避免的反模式示例。
• 安全指南 (security-policies.md) - 記錄認證要求、數據驗證規則、輸入清理標準和漏洞預防措施。包括特定於您應用程序的安全編碼實踐。
• 部署流程 (deployment-workflow.md) - 概述構建程序、環境配置、部署步驟和回滾策略。包括 CI/CD 管道詳細信息和環境特定要求。

自定義 Steering 文件存儲在 .kiro/steering/ 中，並立即在所有 Kiro 交互中可用。