已合并
docs: 新增 Skill 复用指南(面向无 cannbot 的外部开发者)(#195) #1371
docs: 新增 Skill 复用指南(面向无 cannbot 的外部开发者)(#195) #1371
已合并
高煜博创建于 7月20日
高煜博
高煜博成员
7月20日

描述

本次 PR 新增 Skill 复用指南文档(中英文双版),面向没有 cannbot 的外部开发者,说明如何复用工程内置的 17 个 Skill(接入其他 AI 工具或作为人工开发指南阅读)。

关联 Issue: #195

变更类型

关联的Issue

#195

如何测试

  1. 检查文档链接可达性:文档中引用的 SKILL.md 路径在 develop 分支存在(sk-* skill 保留描述但无链接,注明 master 分支可用)
  2. 运行 pre-commit 检查:pre-commit run --files docs/zh/skill-reuse-guide.md docs/en/skill-reuse-guide.md
  3. 检查中英双版章节结构一致性

核对清单

其他信息

  • 7 个 sk-* Skill 仅在 master 分支可用,develop 分支暂未合入,文档中保留描述但 SKILL.md 列不提供链接
  • 补充了 af-reg-ascir Skill(upstream/develop 和 master 均有,原设计遗漏)
  • 完整设计文档在 docs/superpowers/specs/2026-07-20-skill-reuse-guide-design.md,已按项目设计文档模板编写,含跨特性交叉影响、编码红线、测试设计、性能评估检查
likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 高煜博 的贡献)
高煜博高煜博成员
7月20日 创建了 pull request,commit 52366150
高煜博高煜博成员
7月20日 关联了issue:[Requirement|需求建议]: 新增 Skill 复用指南文档(面向无 cannbot 的外部开发者)
atomgit-bot
atomgit-bot
7月20日 评论:

变更摘要

本次 PR 新增了面向外部开发者(无 cannbot 环境)的 Skill 复用指南文档(中英双版),说明如何将工程内置的 17 个 Skill 接入其他 AI 工具或作为人工开发参考。文档覆盖了完整的 Skill 清单与复用方式,并对仅在 master 分支可用的 sk-* 系列 Skill 做了明确标注(保留描述但不提供 SKILL.md 链接),同时补充了此前遗漏的 af-reg-ascir Skill。

主要改动

  • 新增中文版 Skill 复用指南:创建 docs/zh/skill-reuse-guide.md,以中文向外部开发者介绍 17 个内置 Skill 的功能描述、SKILL.md 路径引用及复用方法。
  • 新增英文版 Skill 复用指南:创建 docs/en/skill-reuse-guide.md,提供与中文版章节结构一致、内容对等的英文文档,便于国际化场景使用。
  • 区分分支可用性说明:针对 7 个仅在 master 分支可用的 sk-* Skill,文档保留功能描述但不提供 SKILL.md 超链接,避免 develop 分支下的死链。
  • 补充遗漏 Skill 条目:在 Skill 清单中补全了 af-reg-ascir Skill,该 Skill 在原设计中遗漏但在 upstream/developmaster 分支均已存在。
likedislike
atomgit-bot
atomgit-bot
7月20日 评论:

代码审查

SK_BIND references are purely descriptive (documenting what the sk-operator-codegen skill generates). No issues there. I've now completed a thorough review of both files.


关闭摘要

审查文件清单:

文件 审查结果
docs/en/skill-reuse-guide.md 发现 1 个问题(P3)
docs/zh/skill-reuse-guide.md 相同问题(同一根因,已合并报告)

问题统计:

  • P0: 0
  • P1: 0
  • P2: 0
  • P3: 1

P3(1 个): 本地 Skill 数量描述不一致 — 文档自身 Skill 总览表列出 6 个通用 + 7 个 SK 流水线 = 13 个本地 Skill,但 .gitignore 白名单注释和 FAQ 中均写为"12"。根因是 af-reg-ascir 作为"原设计遗漏"补充的第 6 个通用 Skill 使总数从 12 增至 13,但硬编码数字未同步更新。中英文双版均受影响。

整体风险评估: 低风险。这是一份纯文档变更,不涉及代码逻辑、安全、构建或运行时行为。除了一处数值不一致外,文档内容准确、链接可达、无危险操作指令或安全误导。

类型 数量
🔴 阻塞 0
🟡 建议 2

💬 仅评论

likedislike
CANN-robotCANN-robot成员
7月20日 添加了label:cann-cla/yes
CANN-robot
CANN-robot成员
7月20日 评论:

Thanks for your pull-request.
The full list of commands accepted by me can be found at here
You can get sig-info at here


PR Approval Progress

Congratulations! All modules have met the lgtm and approve requirements.

Module Approval Details

module lgtm status approve status
repo-cann/graph-autofusion zhanj, xchu42, xuyafei (3/2) zhanj (1/1)

💡 Tip:

  • Committer can comment /approve or /lgtm
  • Commenting /approve implies both code review (lgtm) and intent to merge (approve)

CLA Signature Pass

hamburgerbobo, thanks for your pull request. All authors of the commits have signed the CLA. 👍

likedislike
CANN-robotCANN-robot成员
7月20日 将yangyongqiang0606,xchu42,zhang_shengjie,depeng1994,wqtshg_wt,peiyang,shengnan666,XuebinYang,sjtulxh,zhanj,zhujingjing,xuyafei,wangxiaotian995设为评审人
CANN-robotCANN-robot成员
7月20日 将yangyongqiang0606,xchu42,zhang_shengjie,depeng1994,wqtshg_wt,peiyang,shengnan666,XuebinYang,sjtulxh,zhanj,zhujingjing,xuyafei,wangxiaotian995设为审查人
高煜博高煜博成员
7月21日 update merge request[project id: 8005834, iid: 1371, commit_id: 6207dbebc84946df712d49fc78f6caef3933030e] virtual merging success
高煜博高煜博成员
7月21日 强制推送  1 个提交:14fc730c-docs: 新增 Skill 复用指南(面向无 cannbot 的外部开发者)
高煜博高煜博成员
7月21日 update merge request[project id: 8005834, iid: 1371, commit_id: 0bdf13bb8e705eb888933f0107ffe612595829a7] virtual merging success
高煜博
高煜博成员
7月21日 评论:

/compile

likedislike
高煜博高煜博成员
7月21日 update merge request[project id: 8005834, iid: 1371, commit_id: 44e1cded314edf7f4ddf5c7a50cdcf469698483b] virtual merging success
CANN-robotCANN-robot成员
7月21日 添加了label:ci-pipeline-running
CANN-robot
CANN-robot成员
7月21日 评论:

流水线任务触发成功
任务链接 [76f3844936f14b8aba3b319845a42412][流水线指导]

任务名称状态日志下载链接
Compile_Ascend_X86 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM ✅ SUCCESS >>>>> >>>>>
pre_comment ✅ SUCCESS >>>>>
PreSmoke_A900_npupool ✅ SUCCESS >>>>>

[2026-07-21 10:27:44]    CI执行结束

likedislike
CANN-robot
CANN-robot成员
7月21日 评论:

流水线任务触发成功
任务链接 [2f0d3cf165a24984b953cd46f875464f][流水线指导]

任务名称状态日志下载链接
UT_Test_Python_superkernel ✅ SUCCESS >>>>>
ST_Test_Python_superkernel ✅ SUCCESS >>>>>
UT_Test_superkernel ✅ SUCCESS >>>>>
UT_Test_autofuse_framework ✅ SUCCESS >>>>>
ST_Test_autofuse_framework ✅ SUCCESS >>>>>
UT_Test_autofuse_ascendc_api ✅ SUCCESS >>>>>
ST_Test_autofuse_ascendc_api ✅ SUCCESS >>>>>
ST_Test_autofuse_e2e ✅ SUCCESS >>>>>
pre_comment ✅ SUCCESS >>>>>

[2026-07-21 10:20:47]    CI执行结束

likedislike
CANN-robot
CANN-robot成员
7月21日 评论:

流水线任务触发成功
任务链接 [bec53b0e594247a9ac214316944359b0][流水线指导]

任务名称状态日志下载链接
codecheck ✅ SUCCESS >>>>>
SCA ✅ SUCCESS >>>>>
antipoison ✅ SUCCESS >>>>>
codecheck_checkpr ✅ SUCCESS
pre_comment ✅ SUCCESS >>>>>
codecheck_codestyle ✅ SUCCESS >>>>>
codecheck_precommit ✅ SUCCESS >>>>>

[2026-07-21 10:22:11]    CI执行结束

likedislike
CANN-robotCANN-robot成员
7月21日 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
7月21日 添加了label:ci-pipeline-passed
xchu42
xchu42成员
7月21日 评论:

/lgtm

likedislike
xuyafei成员
7月21日 评论:

/lgtm

likedislike
CANN-robotCANN-robot成员
7月21日 添加了label:lgtm
atomgit-bot
atomgit-bot7月21日进行代码检视1
docs/en/skill-reuse-guide.md
@@ -0,0 +22,4 @@
22+| `af-build-runner` | Build assistant (`build.sh` args, CMake errors, dependency matching) | None | [Link](../../.claude/skills/af-build-runner/SKILL.md) |
23+| `af-test-developer` | UT/ST test development (gtest/mockcpp, pytest, coverage) | None | [Link](../../.claude/skills/af-test-developer/SKILL.md) |
24+| `af-code-reviewer` | Code review and contribution standards (redlines, format, PR template) | None | [Link](../../.claude/skills/af-code-reviewer/SKILL.md) |
25+| `af-reg-ascir` | ASCIR registration assistant (add/modify ops, dtype, tmp buffer, UT/ST gen) | None | [Link](../../.claude/skills/af-reg-ascir/SKILL.md) |
atomgit-bot
atomgit-bot7月21日评论:

🟡 Medium Priority

与中文版相同的问题:英文文档将 af-reg-ascir 列为 6 个本地 Skill 之一(第 25 行),并提供 SKILL.md 链接,但 .claude/skills/.gitignore 的白名单中缺少 af-reg-ascir 条目。

同时文档声称 "12 local Skill whitelist entries"(第 231 行),实际仅有 10 条(5 个 Skill × 每 Skill 2 条)。

建议:与 docs/zh/skill-reuse-guide.md 同步修复:更新 .gitignore 白名单并修正文档第 231 行条目数描述。

likedislike
atomgit-bot
atomgit-bot7月21日进行代码检视1
docs/zh/skill-reuse-guide.md
@@ -0,0 +22,4 @@
22+| `af-build-runner` | 编译构建辅助(`build.sh` 参数、CMake 错误、依赖匹配) | 无 | [链接](../../.claude/skills/af-build-runner/SKILL.md) |
23+| `af-test-developer` | UT/ST 测试开发辅助(gtest/mockcpp、pytest、覆盖率) | 无 | [链接](../../.claude/skills/af-test-developer/SKILL.md) |
24+| `af-code-reviewer` | 代码审查与贡献规范(红线、格式、PR 模板) | 无 | [链接](../../.claude/skills/af-code-reviewer/SKILL.md) |
25+| `af-reg-ascir` | ASCIR 注册辅助(新增/修改算子、dtype、tmp buffer、UT/ST 生成) | 无 | [链接](../../.claude/skills/af-reg-ascir/SKILL.md) |
atomgit-bot
atomgit-bot7月21日评论:

🟡 Medium Priority

两份文档均将 af-reg-ascir 列为 6 个本地 Skill 之一(zh 第 25 行 / en 第 25 行),并提供指向其 SKILL.md 的链接。但 .claude/skills/.gitignore 的白名单中缺少 af-reg-ascir 的条目(只列出了其他 5 个:cann-toolkit-installer、default-skills、af-build-runner、af-test-developer、af-code-reviewer)。

同时,文档在描述 .gitignore 内容时声称有"12 个本地 Skill 白名单条目"(zh 第 231 行 / en 第 231 行),而实际的白名单条目仅有 10 条(5 个 Skill × 每 Skill 2 条),数量对不上。

触发条件:维护者按文档指南新增 Skill 时,参照现有 .gitignore 模式添加白名单,但发现 af-reg-ascir 不在其中,产生困惑;或者某次 git 操作后 af-reg-ascir 因未被白名单覆盖而被意外忽略。

  1. 修正文档中 .gitignore 示例描述,使其与实际条目一致(补充 af-reg-ascir 后应为 12 条 Skill 白名单条目)。

建议:在 .claude/skills/.gitignore 的白名单中追加 af-reg-ascir 的两条条目,并修正文档第 231 行对白名单条目的描述。

likedislike
zhanj
zhanj成员
7月21日 评论:

/approve

likedislike
CANN-robotCANN-robot成员
7月21日 添加了label:approved
CANN-robotCANN-robot成员
7月21日 解决了最后一个问题
CANN-robotCANN-robot成员
7月21日 合入了pull request