已开启
[docs] 文档纠错 skill:交付说明、检视处理与最新扫描结果 #467
jacky_leeie创建于  6月25日
jacky_leeie
6月25日 创建

交付说明(2026-10-09 更新)

本 issue 是 任务 #360 的 skill、实践文档和检测报告交付件,并非 PR。
代码检视及合入入口是 PR !2751,本 issue 继续保留为交付报告。

交付提交:9d979dd8。可直接检视 SKILL.md、PRACTICE.md、回归测试。

结构扫描恒可用;format/autocorrect、terminology/Vale 是可选增强;grammar/LanguageTool 需主动指定;语义复核由交互式助手核对代码,headless 脚本只发送文档文本。候选需复核,不保证零误报、不自动替换中文混淆词。

本轮修正了 LLM JSON 提取与失败退出码、空/无效 API 内容、语义发现进入 issue 草稿、扫描/格式化排除范围、行内代码跨词误报、围栏定位、本地链接 URL 编码/根路径、--vale-config 和 GitCode 官方创建端点/认证。原来的 noqa、zhlint 返回码和同行错字去重修复已逐项核实并补充回归。

验证:34 条标准库回归测试通过;6 个脚本和测试模块语法检查通过;Ruff 0.16.10 E4/E7/E9/F 基础规则、skill frontmatter 校验、git diff --check 通过;skill 的本地资源链接和代码围栏扫描无 error。Ruff 扩展默认规则仍有格式/现代化建议,不将基础规则通过写成所有规则通过。格式化器/API 异常使用模拟响应测试,未创建测试 issue。

2026-10-09 对 upstream/master e7a2487078ea54aa8ebbc9aabb70b5a7deadfb8d 实跑:默认范围 195 个 Markdown,zh 105 / en 68 / mixed 22,结构候选 2 条(0 error / 1 warning / 1 info):

文件:行 复核结论
docs/zh/features/memory/online_data_rearrange.md:5 确认括号混用 (DP间),建议 (DP 间)
docs/zh/introduction/feature_overview.md:3 【待完善】 是待办标记;页面已有内容,需维护者确认是否仍需保留,暂不判为内容缺失

当前环境未安装 autocorrect、Vale、LanguageTool;对应道未实跑,不能称零命中。未调用外部 LLM API;交互式语义复核范围为交付脚本、skill/实践文档、关联 issue/PR 和上述候选上下文,没有宣称全仓语义检查完成。

历史复现:PR 原基线 7a54aa84d35b6b48aa17976591ee41d09eb94014 的默认范围为 126 个 Markdown(zh 104 / en 4 / mixed 18),结构 4 条(3 error + 1 warning)。旧报告“128 个文档”与默认排除范围口径不一致,现已统一。旧坏链/未闭合围栏在当前 master 不再出现;术语 99 处、排版约 3661/3662 处等历史数字未在本轮重跑,不作为最新验收结论。

当前评审与验收状态

  1. 9 条原行内检视意见已逐条回复修正提交、处理说明及回归依据;代码侧处理完成。当前 API 仍显示 9 条 resolved=false:当前账号调用解决状态接口收到 403 / You don't have the authority to resolve this.,没有权限关闭讨论,请维护者/检视人确认后标记已解决。
  2. 新提交 9d979dd8 的远端文档 CI已通过:markdownlint、link-validity-check、resource-existence-check、tag-closed-check 均为通过,PR 标签为 docs-ci-pipeline-success。
  3. CLA 仍为 ascend-cla/no,明确指向历史提交 6b302683 的作者邮箱 charlie@scitix.ai;本轮追加提交使用已登记的 jianghao091@outlook.com,追加提交不改变历史作者。两提交还触发 stat/needs-squash。
  4. 本地已准备单提交 d9bbf13bccd193beca598553c4e476f939e60198(分支 cla-ready/doc-quality-review-20261009),作者和提交者均为 jianghao091@outlook.com,与已推送修正的 tree 完全相同,仅包含本 skill 目录的交付内容。它尚未发布:修正原 PR 历史需要用户在终端执行受 lease 保护的强推,当前助手安全规则禁止执行强推;没有用其他发布操作绕过这一限制。发布后仍以机器人 CLA/squash 复核为准。
  5. PR 尚未合入,maintainer 的 lgtm/approve 和任务验收未完成。社区任务池 #356 记录最晚验收日期 2026-09-30,当前已过,请对接人确认继续验收的安排。
likedislike
Jjacky_leeie
6月25日 修改了issue 的描述
Jjacky_leeie
6月25日 修改了issue 的描述
Jjacky_leeie
6月25日 修改了issue 的描述
Jjacky_leeie
6月25日 修改了issue 的描述
jacky_leeie
6月25日 评论:

关联 PR

likedislike
Jjacky_leeie
7月2日 关联了pull request:feat: add mindspeed-mm-doc-quality-review skill
ascend-robotascend-robot成员
7月3日 关联了看板:MindStudio ISSUE管理
young256young256成员
7月8日 关联了里程碑:MindSpeed 26.2.0
yeqm成员
7月14日 评论:

感谢您对 MindSpeed-MM 社区的贡献!文档体验相关skill及关联 PR 已收到,后续将由社区 Maintainer 进行审核,并关注评审意见及时更新。

likedislike
且奏长歌且奏长歌成员
9月15日 issue状态由 TODO 改变为 DONE
且奏长歌且奏长歌成员
9月15日 关闭了 issue
ascend-robotascend-robot成员
9月15日 添加了label:resolved
Yyeqm成员
24 天前 关联了里程碑:MindSpeed 26.3.0
Yyeqm成员
24 天前 issue状态由 DONE 改变为 TODO
Yyeqm成员
24 天前 重新打开了 issue
ascend-robot
ascend-robot成员
24 天前 评论:

您好,当前Issue标记为resolved且有一段时间未进一步更新,因此我们将其标记为'stale'(闲置)状态。若您认为这是误操作,可通过添加任意评论来去除'stale'标签。标记为stale的Issue在4天内无更新活动将自动关闭。

likedislike
ascend-robotascend-robot成员
24 天前 添加了label:stale
ascend-robotascend-robot成员
20 天前 关闭了 issue
ascend-robotascend-robot成员
20 天前 issue状态由 TODO 改变为 DONE
Yyeqm成员
15 天前 issue状态由 DONE 改变为 TODO
Yyeqm成员
15 天前 重新打开了 issue
Yyeqm成员
15 天前 删除了label:stale
ascend-robot
ascend-robot成员
15 天前 评论:

您好,当前Issue标记为resolved且有一段时间未进一步更新,因此我们将其标记为'stale'(闲置)状态。若您认为这是误操作,可通过添加任意评论来去除'stale'标签。标记为stale的Issue在4天内无更新活动将自动关闭。

likedislike
ascend-robotascend-robot成员
15 天前 添加了label:stale
Yyeqm成员
15 天前 删除了label:stale
jacky_leeie
15 天前 评论:

@ascend-robot 我需要签署cla。给我链接和签署方法

likedislike
jacky_leeie
15 天前 评论:

@ascend-robot 我需要签署cla,请告诉我链接和方法

likedislike
jacky_leeie
15 天前 评论:

/check-cla

likedislike
Jjacky_leeie
13 天前 修改标题为 “[docs] 文档纠错 skill:交付说明、检视处理与最新扫描结果”,原标题为“[docs] 文档质量体检 skill 与首轮检测报告(mindspeed-mm-doc-quality-review)”
Jjacky_leeie
13 天前 修改了issue 的描述
jacky_leeie
13 天前 评论:

当前进展汇总(2026-10-09)

交付报告在本 issue,代码评审和合入入口为 !2751,任务总结已回报 #360。刚重新核对远端,PR 仍为 open,目标分支为 master,最新提交为 9d979dd8。

已完成:

  • 修订 skill 的 6 个脚本、SKILL.md、PRACTICE.md 和相关资产,补充 34 条标准库回归测试。
  • 原 9 条行内检视意见均已逐条回复,附修正提交、处理说明与测试依据;已核实原有 noqa、zhlint 返回码及同行错字去重修复,并补充异常路径验证。
  • 修复 LLM JSON 提取及失败被当成零命中、空/无效 API 内容、语义结果未进入 issue 草稿、行内代码跨词误报、默认排除范围等问题;补齐 --vale-config,修正 GitCode 创建端点和认证方式。
  • 统一扫描版本/数量和语义检查方式,撤回“零误报”承诺,明确候选需要上下文复核。旧报告中的历史数字不作为本轮验收结果。
  • 34 条回归测试、语法检查、基础 Ruff E4/E7/E9/F、skill 校验及 git diff --check 通过。新提交的远端文档 CI 四项全部通过,标签为 docs-ci-pipeline-success。

实跑范围与结果:

基于 upstream/master e7a2487078ea54aa8ebbc9aabb70b5a7deadfb8d,默认范围 195 个 Markdown,结构扫描 0 error / 1 warning / 1 info。确认 docs/zh/features/memory/online_data_rearrange.md:5 括号混用;docs/zh/introduction/feature_overview.md:3 的“待完善”标记需维护者确认是否保留。

autocorrect、Vale、LanguageTool 本轮未实跑,未调用外部 LLM API。交互式语义复核覆盖交付代码/文档、关联 issue/PR 和上述候选上下文,没有宣称完成全仓语义检查或批量修复业务文档。

尚待完成:

  1. 9 条讨论仍为 resolved=false。当前账号尝试标记解决时返回 403,提示无解决权限,需维护者/检视人确认后关闭讨论。
  2. PR 当前仍有 ascend-cla/no 和 stat/needs-squash:历史提交 6b302683 的作者邮箱与已登记的 CLA 邮箱不一致,追加提交不能改变历史作者。已准备内容完全相同、邮箱正确的本地单提交分支,尚未强推发布。
  3. 维护者 lgtm/approve、PR 合入及任务验收尚未完成;任务池原验收期限为 2026-09-30,需对接人确认后续验收安排。

当前状态为:交付代码和说明已更新、检视意见已逐条回应、回归与文档门禁通过,待检视确认、CLA/squash 处理及评审合入验收。

likedislike
zhaoyuhang22成员
10 天前 评论:

感谢补充信息,我们已记录本次更新并会继续核查;有进展会在本 Issue 中同步。

likedislike
ascend-robot
ascend-robot成员
3 天前 评论:

您好,当前Issue标记为resolved且有一段时间未进一步更新,因此我们将其标记为'stale'(闲置)状态。若您认为这是误操作,可通过添加任意评论来去除'stale'标签。标记为stale的Issue在4天内无更新活动将自动关闭。

likedislike
ascend-robotascend-robot成员
3 天前 添加了label:stale