Markdown 与 Mermaid 文档编写
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @org-02qudk26/markdown-mermaid-writing。
技能介绍
问题在哪
科学报告、ADR、README 里常见两类痛点:关系用长段 prose 描述,review 和 git diff 都费劲;一上来就用 matplotlib 或 AI 出图,产物是二进制或托管图,无法作为版本库里的单一事实来源。此技能把「带 Mermaid 的 .md」定为默认交付格式:图表是文本,GitHub/GitLab/Notion/VS Code 可直接渲染,以后仍可导出 PNG,但源码始终可改、可比对。
技能如何工作
核心是一条三阶段工作流,其中阶段 1 为必选——即便后续用 Python 或 AI 做出版级图,Mermaid 源码仍须入库。
- 识别文档类型:从 PR 记录、Issue、ADR、研究论文、操作指南等 9 类模板择一开局。
- 读样式指南:
references/markdown_style_guide.md(单 H1、H2 用 emoji、脚注引用外部声明、表格优于散文等);写 Mermaid 前读references/mermaid_style_guide.md及对应references/diagrams/*.md。 - 选对图类型:覆盖 24 种(流程图、时序图、ER、甘特、C4、雷达
radar-beta、XYxychart-beta等),按用例匹配而非一律 flowchart。 - 内联编写并提交:图表贴在相关段落旁;强制规则包括不用
%%{init}、不用内联 style(仅classDef)、节点 ID 用snake_case、支持类型使用accTitle/accDescr。
与其它文档类技能配合时,它充当文档与可视化层:例如 scientific-schematics 的 PNG 以 Mermaid 作结构说明;scientific-writing 负责正文,本技能负责结构图。
边界与注意
- 阶段 2/3:真实数据散点、逼真插图等 Mermaid 表达不了时再上 matplotlib/seaborn 或 AI 图像,但不替代阶段 1 的
.md。 - 常见坑:雷达图必须用
radar-beta与axis/curve语法,与 XY 图表关键字不同;不支持无障碍注释的类型需在代码块上方用斜体说明。 - 样式与模板内容源自 SuperiorByteWorks-LLC/agent-project(Apache-2.0),技能包内保留归属说明。
使用场景
- 撰写架构决策记录(ADR)时,用 C4 或流程图把备选方案、决策分支与服务边界写进同一篇可 git diff 的 Markdown。
- 整理实验报告或数据管道说明,用甘特图、时序图、ER 图表达步骤顺序、服务调用与数据模型,避免整页 prose。
- 开 Issue 或写 PR 说明时,从 `templates/issue.md` / `pull_request.md` 起步,在正文内联 Mermaid 描述复现路径或 API 调用链。
- 做文献或项目综述时,用思维导图归纳概念关系、时间线图排列发表或里程碑,并用流程图/时序图标注论文中的数据流。
适合人员
- 要把手稿方法部分、实验流程和服务交互写成可提交仓库、便于 co-author review 的研究人员
- 负责 sprint 状态报告、项目文档或决策记录,且需在 GitHub/GitLab 上直接预览图表的技术负责人
- 维护开源项目、需在 README 与操作指南里说明部署架构、API 时序与贡献流程的仓库维护者
- 与其它生成内容的 Agent 技能配合、需要统一 Markdown 层级、脚注引用与 Mermaid 规范的文档编辑或技术写作者