Skip to content

用户指南 10 页缺失操作截图(README 铁律「能配图必须配图」未达标)

状态: 🟡 搁置

日期: 2026-08-03 严重程度: 🟠 P2 影响范围: docs/guide/formation.mddocs/guide/external-import.mddocs/guide/drag-mode.mddocs/guide/stage.mddocs/guide/fog.mddocs/guide/cloud.mddocs/guide/shadow.mddocs/guide/mirror.mddocs/guide/gaze-tracking.mddocs/guide/camera-control.md发现方式: 开发发现(guide 全量审核,2026-08-03)


问题描述

docs/guide/README.md 铁律「截图优先:能配图的操作步骤必须配图」——但 docs/guide/img/ 目录仅 17 张图,覆盖 28 篇指南页约 60%。以下 10 页正文零截图grep -c "\.png" 为 0):

页面路由建议截图
formation.mdmodels:formation队形预设切换后的舞台站位
external-import.mdmotion:retarget外部动作导入重定向面板
drag-mode.mdscene:dragMode拖拽模式开启 + 吸附设置面板
stage.mdscene:render:stage舞台加载与多舞台管理
fog.mdenv:fog雾参数面板
cloud.mdenv:cloud云参数面板
shadow.mdenv:shadow阴影设置面板
mirror.mdscene:mirror镜面参数面板
gaze-tracking.mdmotion:gaze视线追踪面板
camera-control.md动作面板 → 相机相机参数面板

docs/package.json 已有 prebuild 门禁:node scripts/check-screenshots.mjs(截图缺口仅 warn 不阻断构建)。

修复方案

  1. 运行应用逐个进入上述面板,按 README 命名规范截图:img/<page>-<n>.png(如 img/mirror-1.png
  2. 正文 ## 操作步骤 对应小节插入 ![描述](../guide/img/<page>-<n>.png)
  3. 截图就绪后删除「(截图占位)」文字标注(当前无残留)
  4. 建议分轮推进(每轮 3-4 页),每轮验证 npm run build(docs)通过

教训

VitePress 站点渲染后无图页最显眼;截图是最终用户可读性的核心差距,优先级高于文档措辞优化。截图需运行应用逐面板操作,属人工密集型任务,故登记 🟡 搁置分轮处理。