SuperAPI AI 工具集

markdown-mermaid-writing

写作与研究

查看项目

更新于 10-15 21:39

技能介绍

用途:该技能用于创建科学文档、报告、分析、方法章节、README、决策记录等,并强制以 Markdown 内嵌 Mermaid 图作为默认且权威的图表格式。核心主张是:用 Mermaid 表达关系比图片更有价值,因为它是文本,可在 git 中清晰 diff,无需构建步骤,能在 GitHub、GitLab、Notion、VS Code 等原生渲染,且比同义散文更省 token,后续仍可转换为精美图片,但文本版本始终是事实来源。

主要能力:覆盖 24 种 Mermaid 图类型,包括流程图、时序图、ER 图、状态图、甘特图、饼图、C4、思维导图、时间线、类图、用户旅程、象限图、需求图、桑基图、XY 图、块图、看板、架构图、雷达图、树图、数据包图、Git 图、ZenUML 及复杂组合示例。提供 Markdown 风格指南、Mermaid 风格指南、各图类型指南(含范例、技巧与可复制模板)以及 9 类文档模板(决策记录、操作指南、issue、看板、演示、项目文档、拉取请求、研究论文、状态报告)。

使用方式:先判断文档类型并选用模板;写任何 .md 前阅读 references/markdown_style_guide.md;创建 Mermaid 图前阅读 references/mermaid_style_guide.md,再打开对应图类型文件。强制规则包括:每图需 accTitle 与 accDescr;禁用 %%{init} 指令;禁用内联样式,仅用 classDef;每节点最多一个 emoji 且置于标签开头;节点 ID 用 snake_case 并与标签一致;每文档仅一个 H1;emoji 仅用于 H2;外部声明用脚注 [^N] 引用;每个 </details> 后加水平线。

适用场景:科学文档、报告、分析、方法章节、README、操作指南、决策记录、项目文档、工作流、数据管道、架构、时间线、关系图等任何将纳入版本控制或需要 AI 解析的输出。

限制:结构性或关系性图应优先用 Mermaid,Python matplotlib、seaborn 或 AI 图像生成属于后续可选阶段,仅在 Mermaid 无法表达时使用(如真实数据散点图、照片级图像)。radar-beta 不支持 accTitle/accDescr,需在图上方加描述性斜体段落。该技能内容移植自 SuperiorByteWorks-LLC/agent-project 仓库,采用 Apache-2.0 许可,本技能整体以 MIT 许可分发。