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)，以维持自动化路线图进度与变更日志的准确性。