figure-table-description
图表描述补充(为缺少描述的图/表生成或提示合适的中文描述)。
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Menu
图表描述补充(为缺少描述的图/表生成或提示合适的中文描述)。
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
图表自动编号(为 Markdown 文档中的图与表生成统一编号并同步交叉引用)。
修复 svgbob/bob 绘图中 CJK(中文/日文/韩文)字符导致的竖线对齐问题。Use when: 编写或修复 ```bob 代码块中含中文的 ASCII 图、检查竖线 │ 对齐、计算混合字符串显示宽度、排查 svgbob 渲染错位。
svgbob/bob 绘图严格语法规则。Use when: 生成 ```bob 代码块、编写 svgbob ASCII 图、需要在图中显示代码标识符/函数名/路径/括号/下划线/斜杠等编程符号。DO NOT USE FOR: 普通 markdown 文本、不含编程符号的纯文本框图。
| name | figure-table-description |
| description | 图表描述补充(为缺少描述的图/表生成或提示合适的中文描述)。 |
| argument-hint | 可选:指定章节或启用自动占位标记 |
bob/plantuml/mermaid 代码块、<img>、![]())或表(Markdown 管道表格)后缺少描述性段落**图 X-Y** 或 **表 X-Y** bold 行描述为空或过于笼统audit_chapters.py 报告"图表后缺少描述"时的修复以下情况判定为"缺少描述":
、<img ...>)之后同理**图/表 X-Y** bold 行的描述部分为空(如 **图 1-1** 仅有空格)排除:以下不算"缺少描述":
根据图类型调整描述风格:
| 图类型 | 描述重点 |
|---|---|
| bob(框图) | 系统架构、模块关系、信号流向 |
| plantuml(时序/流程) | 执行步骤、消息传递、判断逻辑 |
| mermaid(示意图) | 逻辑结构、组件关联、数据流 |
| 图片(照片/截图) | 实物外观、界面操作、实验现象 |
示例(bob 框图):
上图展示了 STM32 最小系统的硬件架构。MCU 核心通过总线连接电源管理、时钟系统、
复位电路和调试接口四大模块,各模块的供电与信号路径在图中清晰标注。
示例(plantuml 时序图):
上图描述了 I2C 通信的完整时序:主机发起起始条件后,依次发送设备地址和寄存器地址,
从机在每个字节后返回 ACK 应答,最终主机以停止条件结束传输。
根据表格内容类型调整:
| 表类型 | 识别特征 | 描述重点 |
|---|---|---|
| 对比表 | 列头含"方案/类型/区别",≥3 列 | 各方案在哪些维度有差异,如何选型 |
| 参数表 | 列头含"参数/值/单位" | 关键参数的含义和典型取值 |
| 步骤表 | 列头含"步骤/阶段/顺序" | 流程要点和注意事项 |
| 排障表 | 列头含"问题/错误/解决" | 常见问题的排查思路 |
| 参考表 | 其他 | 表格梳理了哪些核心信息 |
示例(对比表):
上表对比了轮式、履带式和足式三种移动机构的承载能力、地形适应性和控制复杂度,
工程选型时应根据实际工作环境和成本预算综合权衡。
**图/表 X-Y** 后的描述应为一句话概括,不超过 40 字:
**图 3-5** STM32F103 最小系统电路原理框图**图 3-5** 上图以框图形式描绘了系统架构(套话,无信息量)**图 3-5** (空描述)使用审计脚本检测:
python scripts/audit_chapters.py
或手动搜索空 bold 行:
grep -n '^\*\*[图表].*\*\*\s*$' docs/*.md
按上述规范撰写描述,插入到图/表之后(标题之前)。
如果 **图/表 X-Y** 的描述为空,同时填入一句话概括。确保同步更新对应的 <!-- fig/tab:chX-Y 描述 --> marker 行。
python scripts/audit_chapters.py
python -m mkdocs build --strict
python scripts/auto_number_figures_tables.py --toc<!-- desc-auto --> 标记<!-- fig:chX-Y ... --> 和 <!-- tab:chX-Y ... --> 是编号系统的锚点,只修改描述文字,不要删除整行