SuperAPI AI 工具集

docs-file-issue

写作与研究

查看项目

更新于 10-15 21:37

技能介绍

用途:帮助把 Elastic 文档需求整理成一份完整、可排期的 issue。需求方提供领域知识,技能负责结构梳理、信息查找和模板核对。

主要能力:通过访谈收集“改什么、为什么、何时、涉及哪些页面、后续找谁”等要点;对功能或 UI 变更额外追问生命周期状态、替代了哪些既有内容、是否受功能开关控制、截图、测试环境;执行预检(内容是否已存在、是否重复、产品 PR 是否已带文档、是否仍相关、技术细节是否已验证、是否只含一个可测问题、是否小到可直接改);决定写入 elastic/docs-content 还是 elastic/docs-content-internal,并按模板要求补标题前缀和标签;用 gh 创建 issue。

使用方式:输入为自由文本描述、页面 URL 或既有 issue 编号。给定既有 issue 时按第 1 至 6 步做评审,指出缺失项并提出以编辑形式补充。仓库模板用 gh api 读取,例如:gh api repos/<owner/repo>/contents/.github/ISSUE_TEMPLATE/<file> --jq .content | base64 -d;列出文件名时用 gh api repos/<owner/repo>/contents/.github/ISSUE_TEMPLATE --jq '.[].name'。查重:gh issue list --repo elastic/docs-content --search "<keywords>" --state open。查 PR 改动文件:gh pr view <n> --repo <owner/repo> --json files;查标签与目标分支:gh pr view <n> --repo <owner/repo> --json labels,baseRefName。走 API 创建 issue 时表单校验不生效,必填项、标题前缀和标签需手动落实。

限制:未经最终草稿明确批准,不得创建、编辑或评论 issue;只写临时草稿文件(mktemp),不改工作区;不得臆造字段值;敏感内容不得写入公开仓库;需求方标记为敏感且必须入正文时改选内部仓库;一条 issue 只承载一个可测问题;范围很小时可改为直接提 PR。

暂未提供:具体收费、定价、支持平台、性能效果等信息。