mcpField
V
visual-docs-diagrams

visual-docs-diagrams

github.com/lvtd-llc文档处理146 次安装7 周前更新
代码仓库

关于 visual-docs-diagrams

用于判断开发者文档是否需要视觉内容,并指导其设计与审查。面向技术写作者和开发者,涵盖视觉类型选择、无障碍、性能及维护检查。

主要功能

  1. 01选择合适的视觉类型
  2. 02设计和审查技术视觉内容
  3. 03无障碍与性能检查
  4. 04规划源文件和维护

适用场景

  1. 01为开发者指南选择视觉内容
  2. 02检查图表的无障碍性
  3. 03规划文档视觉内容的更新

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/lvtd-llc/skills --skill visual-docs-diagrams

安装后在 Claude Code 中输入/visual-docs-diagrams确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

guidelines.md
references/core/
knowledge.md
workflows/
design-technical-visual.md

详细介绍

可视化文档图示

使用此技能判断开发者文档是否需要配图,并设计或审查图示,以提升可理解性、无障碍性、性能和可维护性。

此技能改编自 Docs for Developers: An Engineer's Field Guide to Technical Writing,尤其是第 6 章“添加可视化内容”。相关指导经过转化和改写;请勿在面向用户的输出中照搬书中原文。来源:https://link.springer.com/book/10.1007/978-1-4842-7217-6

快速开始

  1. 加载 guidelines.md,选择最精简且有用的参考资料集。
  2. 明确图示需要帮助读者理解或完成什么。
  3. 根据任务选择截图、示意图、流程图、泳道图或纯文本。
  4. 完整设计或审查图示时,使用 workflows/design-technical-visual.md。
  5. 完成前,检查无障碍性、性能、放置位置、源文件和维护事宜。

默认输出

设计或审查可视化文档时,请返回:

  1. 图示目的 - 读者需要更快或更好地理解什么。
  2. 推荐的图示类型 - 截图、框图与箭头图、流程图、泳道图、视频或不使用图示。
  3. 设计说明 - 范围、标签、注释、对比度、放置位置和格式。
  4. 无障碍性和性能检查 - 替代文本、说明文字、文字稿、SVG/图像大小、响应式适配。
  5. 维护计划 - 源文件、负责人、更新触发条件和审查频率。

目录

需求从这里开始
了解图示类型references/core/knowledge.md
应用图示规则references/core/knowledge.md
查看图示决策示例references/core/knowledge.md
设计或审查图示workflows/design-technical-visual.md
按任务选择路径guidelines.md

核心原则

  • 使用图示补充文本,不要用图示替代关键说明。
  • 每个图示尽量只表达一个观点或一个细节层级。
  • 将无障碍性和可维护性视为图示设计的一部分,而非后期润色。
  • 除非动态效果本身不可或缺且维护切实可行,否则避免使用视频。

评论

支持 Markdown