用途:repo-doku 用于在源码仓库内直接生成或更新文档,把 README.md 作为文档的真实来源(Source of Truth),下游文档系统可据此同步。较大项目额外维护 DEVELOPMENT.md。
主要能力与工作方式:先判断项目类型与文档目标,确定只写 README.md 还是再加 DEVELOPMENT.md(见 references/doku-ziel.md)。再用 Git 定位上次文档更新的位置,缩小需要补充的范围,例如 git log -1 --format='%H %ci' -- README.md 和 git log --oneline <letzter-stand>..HEAD,并按 Conventional Commits 类型分组,feat 与 BREAKING CHANGE 通常与文档相关,chore、ci、test 多数无关。随后按顺序收集来源:现有文档、Changelog 文件、上次文档状态以来的 Git 提交、以及用于细节的源码(公开 API、选项、签名和真实示例)。写作时遵循 references/konventionen.md 中的语言、代码注释语言、Changelog、图表和项目专属规则,最小侵入地只补充或修正与新提交、新功能相关的内容,示例从真实代码推导,不编造 API。
结束阶段:若文档有改动,可在项目惯用的情况下用任务列表跟踪,并建议一个 Conventional Commit(如 docs: README um Feature X ergänzen),但不自行提交或推送。
限制与边界:不自动执行 commit 或 push,只提出提交建议。若评估显示现有文档已是最新且完整(例如自上次以来仅有内部修复、测试或发布),则不强制修改,也不编造内容、不生成任务列表、不提出提交建议,而是简要报告所查来源与结论,包括需由用户判断的边界情况。
适用场景:仓库需要维护 README 或在大型项目中维护 DEVELOPMENT.md,并希望基于 Git 历史与源码精准补齐文档缺口时使用。其它收费、价格与具体平台支持信息暂未提供。