已合并
[doc]:TTFHW需要在资料中增加约束性语言指导AI稳定执行 #428
[doc]:TTFHW需要在资料中增加约束性语言指导AI稳定执行 #428
已合并
孟广欣创建于 7月30日
孟广欣
孟广欣成员
7月30日

1. 修改描述

  • 修改原因: 产品线要求各产品的TTFHW能力要上线
  • 修改方案: 环境安装和编译过程为了让AI也能稳定执行,需要增加一些约束性语言指导AI
  • 修改内容: 增加一些约束性语言用于指导AI稳定执行

2. 功能验证


3. 代码检视

  • 要求:
    • 合入功能代码大于 200 行,需要sig会议申报代码检视议题,并在PR中标注会议。
    • committer评估是否需要在sig会议进行代码检视。
    • 参与检视的committer人员名单与检视时间。
    • 大于 1000 行代码原则上不允许合入,需进行备案。
  • 检视committer人员名单与检视时间:

4. 资料修改自检

  • 资料修改: 需要资料人员luyq11评审

likedislike
Pull Request已成功合入, 合并人@ascend-robot
(感谢 孟广欣 的贡献)
孟广欣孟广欣成员
7月30日 关联了里程碑:MindStudio 26.2.0
孟广欣孟广欣成员
7月30日 关联了issue:[Doc]: 首页readme格式问题,emoji调整
atomgit-bot
atomgit-bot成员
7月30日 评论:

变更摘要

本次 PR 主要针对 TTFHW 能力的资料文档进行修订,在环境安装和编译过程相关文档中增加约束性语言描述,以指导 AI 能够稳定、可重复地执行操作步骤,满足产品线对 TTFHW 能力上线的要求。修改整体为文档类变更(doc),涉及 3 个文件,净删除 47 行。

主要改动

  • 增加 AI 执行约束性语言:在 TTFHW 相关文档的环境安装和编译流程中,补充了约束性描述语句,使 AI 在执行时能够遵循明确的步骤和边界条件,减少歧义和不确定性。
  • 精简和替换旧有描述:删除了原有文档中缺乏约束力或不够精确的指导内容(删除 155 行),替换为更结构化、更具操作性的约束性说明(新增 108 行)。
  • 文档内容重组:对 3 个受影响的文档文件进行了内容调整,使整体指导逻辑更加清晰,便于 AI 稳定解析和执行。
likedislike
atomgit-bot
atomgit-bot成员
7月30日 评论:

代码审查

审查总结

共审查 3 个变更文件,发现 3 个问题,均为 P3 级别。

文件 审查结果
README.md ✅ 已审查 — 1 个 P3 问题(Prometheus 安全提示在重构中丢失)
docs/zh/developer_guide/development_guide.md ✅ 已审查 — 无问题(变更仅为精简环境配置章节、指向统一安装指南,逻辑清晰、无安全风险)
docs/zh/msserviceprofiler_install_guide.md ✅ 已审查 — 2 个 P3 问题(与开发指南和英文安装指南的构建方法不一致)

发现汇总

  • P3 × 3
    1. README 重构时 Prometheus/Grafana 第三方软件安全提示被移除(README.md:37)
    2. zh 安装指南改用 python3 build.py,但 zh 开发指南仍使用 build_and_upgrade.sh(安装指南:51)
    3. zh 安装指南改用 python3 build.py,但 en 安装指南未同步(安装指南:51)

整体风险评估:

本 PR 的核心目的是在文档中增加约束性语言以指导 AI 稳定执行 TTFHW 流程。变更内容均为文档结构调整、章节重组和约束指令添加,不涉及代码逻辑、安全漏洞或构建配置变更。未发现 chmod 777、禁用 TLS、硬编码密钥等危险操作指令。发现的问题均为文档一致性层面的 P3 级别,不构成安全或正确性风险。

⚠️ 已识别出整体风险,但无法提取行内评论,请参考整体评估。

likedislike
ascend-robotascend-robot成员
7月30日 添加了label:ascend-cla/yes
ascend-robotascend-robot成员
7月30日 添加了label:stat/needs-squash
ascend-robot
ascend-robot成员
7月30日 评论:

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-Ascend/msserviceprofiler 陈豪, 谢作孟 (2/2) 陈豪 (1/1)

💡 Tip:

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

CLA Signature Pass

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

likedislike
ascend-robot
ascend-robot成员
7月30日 评论:

ascend docs pipeline is running...

likedislike
ascend-robotascend-robot成员
7月30日 添加了label:docs-ci-pipeline-running
孟广欣孟广欣成员
7月30日 推送  1 个提交:340e4105-dev
ascend-robot
ascend-robot成员
7月30日 评论:

✅ 文档门禁通过!

检查项 检查结果 详情
markdownlint ✅ 已通过 查看详情
link-validity-check ✅ 已通过 查看详情
resource-existence-check ✅ 已通过 查看详情
tag-closed-check ✅ 已通过 查看详情
likedislike
ascend-robotascend-robot成员
7月30日 删除了label:docs-ci-pipeline-running
ascend-robotascend-robot成员
7月30日 添加了label:docs-ci-pipeline-success
ascend-robot
ascend-robot成员
7月30日 评论:

ascend docs pipeline is running...

likedislike
ascend-robotascend-robot成员
7月30日 删除了label:docs-ci-pipeline-success
ascend-robotascend-robot成员
7月30日 添加了label:docs-ci-pipeline-running
ascend-robot
ascend-robot成员
7月30日 评论:

✅ 文档门禁通过!

检查项 检查结果 详情
markdownlint ✅ 已通过 查看详情
link-validity-check ✅ 已通过 查看详情
resource-existence-check ✅ 已通过 查看详情
tag-closed-check ✅ 已通过 查看详情
likedislike
ascend-robotascend-robot成员
7月30日 删除了label:docs-ci-pipeline-running
ascend-robotascend-robot成员
7月30日 添加了label:docs-ci-pipeline-success
孟广欣
孟广欣成员
7月31日 评论:

compile

likedislike
AtlasAccountAtlasAccount成员
7月31日 添加了label:ci-pipeline-running
ascend-robot
ascend-robot成员
7月31日 评论:

ascend docs pipeline is running...

likedislike
ascend-robotascend-robot成员
7月31日 删除了label:docs-ci-pipeline-success
ascend-robotascend-robot成员
7月31日 添加了label:docs-ci-pipeline-running
AtlasAccountAtlasAccount成员
7月31日 删除了label:ci-pipeline-running
AtlasAccountAtlasAccount成员
7月31日 添加了label:ci-pipeline-passed
AtlasAccount
AtlasAccount成员
7月31日 评论:
流水线 PR-pipeline_msserviceprofiler#1194 [ commitID:340e4105 ] 已完成
>>>代码风格自动修复执行失败,具体请查看日志,不影响流水线执行及PR合入
阶段 任务名 状态 详情
编译构建 Build_msserviceprofiler_arm 🛑 >>>
Build_msserviceprofiler_x86 🛑 >>>
Docs_msserviceprofiler 🛑 >>>
恶意代码检查 Antipoison_msserviceprofiler 🛑 >>>
编码安全与规范检查 codecheck_pre-commit 🛑 >>>
pre-commit 🛑 >>>
开源片段检查 SCA_msserviceprofiler 🛑 >>>
开发者测试 UT_msserviceprofiler 🛑 >>>
流水线 PR-pipeline_msserviceprofiler >>>
此流水线已支持下列评论快捷指令,仅PR创建者和白名单成员评论有效
  • compile : 运行流水线
  • retry : 重试流水线所有失败子任务
  • retry <任务名> : 仅重试指定失败子任务
  • stop : 停止流水线
likedislike
ascend-robot
ascend-robot成员
7月31日 评论:

✅ 文档门禁通过!

检查项 检查结果 详情
markdownlint ✅ 已通过 查看详情
link-validity-check ✅ 已通过 查看详情
resource-existence-check ✅ 已通过 查看详情
tag-closed-check ✅ 已通过 查看详情
likedislike
ascend-robotascend-robot成员
7月31日 删除了label:docs-ci-pipeline-running
ascend-robotascend-robot成员
7月31日 添加了label:docs-ci-pipeline-success
xzm123成员
7月31日 评论:

/lgtm

likedislike
chenhao_1209成员
7月31日 评论:

/approve

likedislike
ascend-robotascend-robot成员
7月31日 添加了label:approvedlgtm
ascend-robotascend-robot成员
7月31日 合入了pull request