已关闭
[Bug] PR 800 词条文档类型命名与校验链接规范问题 #453
joejoezhou创建于  27 天前关闭于  24 天前
joejoezhou成员
27 天前 创建

问题描述

PR 800(docs_standards 资料规范 + docs-management skill)合入后,词条相关文档存在命名与链接规范问题:

  1. 词条文档类型命名不符:文档类型写作「算法词条」、模板/校验清单文件名为 01_quantization_glossary_*、标题为「量化术语百科」。实际词条覆盖全部术语百科(encyclopedia,含概念、算法、格式、指标等),并非仅算法,命名范围不符;应统一为「术语词条」、文件名 term_glossary

  2. 文档类型表链接锚文本不规范:README 2.2 文档类型表中模板/校验清单链接锚文本为英文文件名(如 [01_term_glossary_template](./…)),非中文正式标题,违反《公共校验清单》CE-05 书名号规范;应改为 [《术语词条模板》](./…) 形式。

  3. 01 词条模板可选章节标记渲染失效[OPTIONAL] ## 背景与动机 等前缀写在 ## 之前,不作为标题渲染;应改为 ## [OPTIONAL] 背景与动机(与 02-05 模板一致)。

  4. README 正文文档标题引用缺书名号:如「流程指南模板」「词条模板」在正文单独提及未加《》,违反 CE-05。

  5. 「排版规范」失效示例残留:01 词条模板的「排版规范」脚手架章节已在 PR 800 中移除,但《公共校验清单》CE-02 判定条件、SKILL.md、validation_rules、example.md 仍引用该示例,属失效引用。

修复方案

  • 词条文档类型统一为「术语词条」,01 模板/校验清单更名 term_glossary
  • 文档类型表链接锚文本改为中文正式标题(书名号);
  • 修复 [OPTIONAL] ## 前缀顺序;
  • 补齐正文文档标题书名号;
  • 清理「排版规范」失效示例。

修复见关联 bugfix PR。

likedislike
anreywmh成员
27 天前 评论:

👋 您好,欢迎向 MindStudio msModelSlim 提交 Issue!
我们已收到您的反馈,感谢你对开源社区的支持。🎉

📅处理时效: 维护团队将在24小时内 查看并回复您的问题(工作日)。
🔍自助查询: 在等待期间,建议您先查阅以下资料,可能已有解决方案:

📖 MindStudio msModelSlim 官方文档
📝 贡献者指南

请确保 Issue 描述清晰,包含复现步骤和日志,这将帮助我们更快定位问题。谢谢!

likedislike
Aanreywmh成员
27 天前 添加了label:triaged
ascend-robotascend-robot成员
27 天前 添加了label:bug
Jjoejoezhou成员
27 天前 关联了pull request:[Bugfix] 修复 PR 800 词条文档类型命名与校验链接规范问题
Zzhangz200102成员
27 天前 关联了里程碑:MindStudio 26.2.0
Zzhangz200102成员
27 天前 将 joejoezhou 设为负责人
zhangz200102成员
24 天前 评论:

关联pr已合入
/label add resolved

likedislike
ascend-robotascend-robot成员
24 天前 添加了label:resolved
Zzhangz200102成员
24 天前 issue状态由 TODO 改变为 DONE
Zzhangz200102成员
24 天前 关闭了 issue