BattleScope
簡化 BattleScope 功能的技術文檔編寫,確保 API、前端及架構層的一致性。
簡介
Feature Documenter 是 BattleScope 生態系統中開發者與架構師的必備工程工具。它自動化技術規格的建立與維護,確保每個新功能、API 端點或服務增強均符合代碼庫的嚴格標準。透過在產品、功能、技術及架構層面強制執行統一結構,此技能可防止文檔過期,並確保交叉引用的規格保持同步。
本工具專為管理分散式微服務的開發者設計,提供功能規格、OpenAPI 文檔與前端實現細節的模板。它有助於建立 IMPLEMENTATION_SUMMARY.md 文件,用以記錄關鍵技術決策、遇到的挑戰以及未來迭代的維護指導。無論您是在實現新服務、優化現有 API,還是記錄系統級的可觀測性需求,此技能都能確保您的文檔與代碼庫同樣強健。
-
自動生成標準化的 feature-spec.md、openapi-spec.md 及 frontend-spec.md 模板。
-
維護 docs/features/ 及 docs/technical-specifications/ 目錄結構的一致性。
-
追蹤功能狀態與路線圖進度,以確保開發週期的透明度。
-
記錄技術債務與架構設計決策,以支援長期的可維護性。
-
確保文檔與已實現的微服務(Ingestion、Enrichment、Battle、Search、Notification 及 BFF)之間的同步。
-
在新功能的設計階段調用此技能,以搭建文檔需求架構。
-
在修改 API 合約或變更領域服務邊界時,使用此技能進行增量更新。
-
務必更新 IMPLEMENTATION_SUMMARY.md,記錄開發過程中的發現,以協助團隊協作。
-
對所有文檔皆採用既定的模板,以符合 V3 微服務架構標準。
-
此技能需要與特定功能路徑相關的輸入;在初始化新文檔集時,請確保提供正確的 <feature-name>。
倉庫統計
- Star 數
- 0
- Fork 數
- 0
- Open Issue 數
- 0
- 主要語言
- HTML
- 預設分支
- main
- 同步狀態
- 閒置
- 最近同步時間
- 2026年5月4日 上午12:59