readme-updater

readme-updater 技能為您的軟體專案提供自動化的文檔管理，確保專案的主要文檔始終與代碼庫的當前狀態保持一致。它專為那些重視專案可維護性，並希望減少每次合併 Pull Request 或新增功能時手動更新安裝指南、功能列表及配置參考等瑣碎工作的開發者而設計。

• 自動監控 package.json、docker-compose.yml 和 .env.example 等關鍵文件，以觸發文檔更新。
• 當檢測到更改時，動態更新安裝 (Installation) 部分，包含新的依賴項或安裝步驟。
• 通過觀察代碼添加內容和專案結構中實現的新功能，維護準確的功能 (Features) 列表。
• 根據代碼庫的修改，即時更新配置 (Configuration) 部分、API 參考和環境變數文檔。
• 在插入或更新相關部分的同時，保留原始 README 的格式、Emoji 風格和語調。
• 與更廣泛的文檔工作流程集成，包括用於深入撰寫的 @docs-writer 子代理和用於 OpenAPI/Swagger 生成的 api-documenter。
• 跟蹤版本相容性，並支持與 CHANGELOG.md 集成，以實現歷史文檔的同步。

該技能的使用涉及對專案工作區的持續後台監控。當檢測到顯著的專案結構變更、依賴項調整或安裝說明修改時，該技能會建議對您的 README 進行精確修補。對於使用敏捷開發方法、頻繁發布功能的團隊來說，此技能效果顯著。它無需複雜的配置，可在各種專案環境中可靠運行。請注意，此技能針對基於 Markdown 的文檔進行了優化，當 README 遵循標準結構佈局時效果最佳。它支持 CI/CD 流水線中的自動化工作流程，以確保文檔質量與代碼質量同步驗證。當您希望將重點從編寫重複性文檔轉向構建功能，並確信專案的「門面」始終保持資訊豐富且最新時，請使用此技能。