SuperAPI AI 工具集

docs-fix-changelog

通用与其它

查看项目

更新于 10-15 21:37

技能介绍

用途:作为 Elastic 文档的变更日志写作助手,针对现有或新建的 changelog YAML 提供改进建议,帮助字段文本符合当前 Elastic 标准。准确优先于风格,不得为格式牺牲事实正确性。

主要能力:可处理单个文件、整个目录下的 *.yaml 与 *.yml,或针对尚无文件的新变更日志建议内容。建议覆盖标题标准化(去除 feat:、fix: 等开发标签,动词用 Fix/Add/Remove,句首大写)、技术术语规范(NPE 展开为 NullPointerException、PIT 展开为 point-in-time、ESQL 规范为 ES|QL)、内容质量、YAML 引号转义、UI 元素格式、类型与标题一致性、技术实现语言改写为用户可感知结果等。会加载仓库 docs/changelog.yml 的 pivot.areas 做 area 校验,并尽量读取 PR/issue 上下文。

使用方式:/docs-fix-changelog path/to/changelog.yaml、/docs-fix-changelog path/to/directory/,或 /docs-fix-changelog "Create new changelog for: [PR context]"。默认为仅建议模式,仅在用户明确确认后才写入磁盘。文件创建始终由 docs-builder changelog add 或 docs-builder changelog note 完成。

流程与限制:先加载规范指南(docs-content 检出、已发布指南或内置清单)、再解析输入、解析 PR/issue 上下文、套用检查清单、评估字段、生成带高/中/低置信度的建议。上下文不足时会请求补充;对无用户可见影响的 PR 链接型变更日志建议删除而非改写。字符目标为标题 80、描述 600。

资料未提供:安装方式、收费与价格、支持平台、具体版本要求及实测效果暂未提供。