SuperAPI AI 工具集

log-doc-issues

写作与研究

查看项目

更新于 10-16 03:41

技能介绍

用途:log-doc-issues 用于把文档审计结果转化为 GitHub issue 工作项。它先调用 /check-docs 做文档检查,再按优先级创建 issue;本身不修改文档。

主要能力与流程:1) 运行 /check-docs 获取结构化发现;2) 用 gh issue list --state open --label "domain/docs" --limit 50 检查已有 issue,避免重复;3) 对每条发现用 gh issue create 创建 issue。

issue 格式:标题为 [P{0-3}] 文档缺口描述;标签为 priority/p0、priority/p1、priority/p2 或 priority/p3,外加 domain/docs、type/chore;正文分段为 Problem、Impact、Location、Suggested Fix,末尾注明由 /log-doc-issues 创建。

优先级映射:缺少 README.md 或 .env.example(含所用环境变量)为 P0;README 缺关键章节、未记录环境变量、缺架构文档为 P1;文档超过 90 天未更新、缺 CONTRIBUTING.md、缺 ADR 目录、链接失效为 P2;润色类改进为 P3。

输出示例:统计各级别创建数量与总数,并提示用 gh issue list --label domain/docs 查看。相关技能:/check-docs(仅审计)、/fix-docs(修复缺口)、/documentation(完整文档流程)、/groom(待办梳理)。限制:需要已配置可用的 gh CLI 与仓库权限;不执行修复;若审计无发现则不会创建 issue。