用途:制定并执行用 Markdown 内嵌 Mermaid 图撰写科学文档的标准,适用于报告、分析、论文、方法章节、README、决策记录、项目文档以及各类关系型图表。核心主张是:.md 中的 Mermaid 关系图比图片更有价值,它是纯文本,可在 git 中清晰 diff,无需构建步骤,可在 GitHub、GitLab、Notion、VS Code 及任何 Markdown 查看器中渲染,比同等关系的散文描述更省 token,且事后仍可转换为成品图片。
主要能力:覆盖 24 种 Mermaid 图类型,按场景匹配——流程图(实验流程/判定逻辑)、时序图(服务交互/API 调用)、ER 图(数据模型)、状态图(生命周期)、甘特图(时间线)、饼图(占比)、C4(架构)、思维导图(概念层级)、时间线(历史事件)、类图、用户旅程、象限图、需求图、桑基图、XY 图、块图、看板、架构图、雷达图、树图、数据包图、Git 图、ZenUML 及组合示例。提供 Markdown 与 Mermaid 风格指南、9 类文档模板(pull_request、issue、kanban、decision_record、presentation、research_paper、project_documentation、how_to_guide、status_report)及完整示例报告。
使用方式:先判断文档类型并尽量从对应模板起步;写作前阅读 references/markdown_style_guide.md;画图前阅读 references/mermaid_style_guide.md,再打开对应图类型文件(如 references/diagrams/flowchart.md)取示例与模板;将图与正文就近放置;提交 .md 源文件,图片仅作补充。
强制规则:每文档仅一个 H1;emoji 只出现在 H2;外部论断用脚注 [^N] 附完整 URL;每个 </details> 后加分隔线;图需带 accTitle 与 accDescr(不支持的类型则在上方加斜体说明段);禁用 %%{init} 指令(会破坏 GitHub 暗色模式)与内联样式,只用 classDef;节点 ID 用 snake_case;避免用流程图套所有场景。注意雷达图需用 radar-beta、axis、curve,而非 radar 与 x-axis。
限制:未提供收费、价格、平台或效果等事实;雷达图不支持 accTitle/accDescr。该技能的风格指南、图类型指南与模板移植自 SuperiorByteWorks-LLC/agent-project 仓库(Apache-2.0),作者 Clayton Young / Superior Byte Works, LLC;本技能随 academic-skills 以 MIT 许可分发。来源列于 https://www.skills.sh/crazymsn/academic-skills/markdown-mermaid-writing。