massgen-release-documenter

release-documenter 工具是 MassGen 專案維護者不可或缺的助手，旨在確保發布文件的品質、一致性與稽核就緒狀態。它提供了一個遵循 docs/dev_notes/release_checklist.md 中權威檢查清單的結構化、分階段框架。透過自動化發布流程中的心智負擔，此工具確保了從更新 CHANGELOG.md 到同步 README_PYPI.md 的每個關鍵步驟都不會被遺漏。它作為文件管線的編排器，要求嚴格遵守特定的操作順序，以維持專案里程碑的一致性。目標用戶包括專案維護者、發布經理以及負責維護專案程式碼、文件與路線圖的貢獻者。

• 編排完整的發布生命週期：更新變更日誌、Sphinx 文件構建、配置文件、案例研究、README.md 更新以及路線圖同步。

• 整合預先提交 (pre-commit) 掛鉤的驗證檢查，確保如 README_PYPI.md 等自動同步檔案與主要文件保持一致。

• 透過要求在最終發布前進行 Sphinx 文件構建與連結檢查 (make html, make linkcheck) 來執行嚴格的品質控制。

• 簡化開發分支與主分支之間的轉換，並提供標準化的提交訊息範本，以提高清晰度與可追溯性。

• 支援使用提供的 docs/source/examples/case_studies/ 結構，為新功能與能力建立詳細、範本導向的案例研究。

• 務必將 docs/dev_notes/release_checklist.md 視為唯一真理來源；此工具是該檢查清單的執行促進者。

• 遵循強制執行順序：先更新 CHANGELOG，接著是 Sphinx 文件、設定 README、案例研究、專案 README，最後是 ROADMAP。

• 盡可能利用內建的自動化掛鉤；此工具可識別預先提交掛鉤何時已執行同步。

• 保持文件來源整潔，一般內容使用 Markdown，複雜的 Sphinx 指令使用 reStructuredText。

• 要求持續使用版本命名規範 (例如 v0.1.X)，以維持自動化路線圖進度與變更日誌的準確性。