已开启
【GEO 优化】为文档图片补充 alt 属性,提升 img 标签语义性 #38
huangshijun创建于 5 天前
5 天前 将 persimmonzzz、MrRlu、solarhu、Gemshunter、yangzhao_kl、hjx_gitff、byrobins、luanjianhai、snoweay、lostway1 设为负责人
5 天前 将 persimmonzzz、MrRlu、solarhu、Gemshunter、yangzhao_kl、hjx_gitff、byrobins、luanjianhai、snoweay、lostway1 设为负责人
5 天前 添加了label:sig/sig-ops
openeuler-ci-bot
5 天前 评论:
5 天前 评论:
Welcome To openEuler Community
Hey @persimmonzzz , thanks for your contribution to the community.
Bot Usage Manual
I'm the Bot here serving you. You can find the instructions on how to interact with me at Here . That means you can comment below every pull request or issue to trigger Bot Commands. You can self-configure the PR merge rules for this repository. For more details, please refer to Here.
Contact Guide
If you have any questions, please contact the SIG: sig-ops ,
and any of the maintainers: @Gemshunter, @MrRlu, @byrobins, @hjx_gitff, @lostway1, @luanjianhai, @snoweay, @solarhu, @yangzhao_kl ,
and any of the committers: @Vchanger, @byrobins, @hongwentakkk1, @m0_58016603, @wangfenglai, @webankto, @weli1, @xuhou, @yaozhenhe .


【GEO 优化】为文档图片补充 alt 属性,提升 img 标签语义性
一、背景
为提升 openEuler 文档在搜索引擎与生成式 AI 引擎中的可发现性与引用准确率(GEO),文档中心正在对发布到
docs.openeuler.org的内容进行语义化优化。文档中的图片最终渲染为<img>标签,但 alt 属性普遍缺失或无意义,导致:二、需要做什么
为
docs/zh/与docs/en/下、所有被_toc.yaml引用并发布到文档中心的.md文件中的图片补充描述性 alt:,方括号内容即 alt;<img>上补充alt属性; ← 空 alt  ← 无意义占位  ← 无意义占位  ← 仅编号  ← 转换工具生成的文件名式占位  ← 文件名回显 <img src="./figures/topo.png" width="500"> ← HTML 标签缺 alt 属性<img>的 alt 属性,无需网站侧工程改造。三、alt 撰写规范
基本原则:
图片:、图:、截图:开头(alt 本身已隐含"这是一张图片");分场景示例:
RAM-A 架构图:管理面通过 RPC 接口连接内核态模块与远端存储后端安装概览页面,"软件选择"选项处于高亮状态执行 rpm -qa 查询已安装软件包的输出结果系统升级流程:检查更新、下载软件包、安装、重启各版本启动耗时对比:24.03 LTS 较 22.03 LTS 缩短约 30%四、示例
Markdown 修改示例:
<!-- 修改前 --> 系统整体架构如下图所示。  <!-- 修改后 --> 系统整体架构如下图所示。 HTML 标签修改示例:
<!-- 修改前 --> <img src="./figures/topo.png" width="500"> <!-- 修改后 --> <img src="./figures/topo.png" width="500" alt="集群组网拓扑:三个计算节点通过交换机与存储节点互联">五、注意事项
<img>标签外部,搜索引擎与屏幕阅读器无法将其与图片关联,因此不能用图注替代 alt;docs/zh/24.03_LTS_SP2/、docs/zh/master/)中的图片请一并处理。如本仓库文档不涉及图片请忽略此issue,如有疑问欢迎在本 issue 下讨论。感谢配合!