ARTICLE DETAIL

资讯详情

深耕编程入门与网站建设的一线实战洞察。

使用 Mermaid Timeline 图绘制科研时间线:scientific-agent-skills 中 markdown-mermaid-writing 技能实战指南

使用 Mermaid Timeline 图绘制科研时间线:scientific-agent-skills 中 markdown-mermaid-writing 技能实战指南 使用 Mermaid Timeline 图绘制科研时间线scientific-agent-skills 中 markdown-mermaid-writing 技能实战指南【免费下载链接】scientific-agent-skillsTurn any AI agent into an AI Scientist. The #1 Agent Skills library for science, used by 190,000 scientists worldwide. 165 ready-to-use validated skills plus 100 scientific databases covering biology, chemistry, medicine, and drug discovery. Compatible with Cursor, Claude Code, Codex, Pi, Antigravity, and the open Agent Skills standard.项目地址: https://gitcode.com/GitHub_Trending/cl/scientific-agent-skills时间线Timeline是 Mermaid 24 种图表类型中专门用于表达按时间顺序发生的事件的图型。本文以scientific-agent-skills仓库中 markdown-mermaid-writing 技能的 Timeline 图类型参考 文档为核心完整讲解timeline语法的适用场景、无障碍性要求、示例与模板并结合仓库内的样式指南、示例研究报告与组合图模式给出可直接复制运行的完整代码块。读完本文你将掌握用 Mermaid timeline 表达实验里程碑、发布历史、学术时间线等时序信息的完整方案。Timeline 是什么语法关键字与适用边界在scientific-agent-skills中markdown-mermaid-writing技能将 Mermaid 确立为文本优先的科学文档标准一张以 Mermaid 形式内嵌在.md文件里的关系图比任何静态图片都更有价值——它在 git 中可以干净地 diff、无需构建步骤、能在 GitHub/GitLab/Notion/VS Code 中原生渲染、比同等信息的散文消耗更少的 token并且可以随时转换为精美图片详见 SKILL.md。Timeline 是这套体系中的一员。其核心定义如下属性说明语法关键字timeline最佳用途按时间顺序的事件、历史演进、随时间推移的里程碑、发布历史不要使用的情形任务持续时间与依赖关系改用 Gantt 图、详细项目计划改用 Gantt 图⚠️无障碍性AccessibilityTimeline不支持accTitle/accDescr。务必在代码块正上方放置一段描述性的斜体Markdown 段落供屏幕阅读器与 AI 理解图意。这一不支持无障碍注解的特征在 Mermaid 样式指南 中有完整罗列不支持的图型包括 Mindmap、Timeline、Quadrant、Sankey、XY Chart、Block、Kanban、Packet、Architecture、Radar、Treemap统一的对策就是在代码块上方写斜体描述段落。何时选 Timeline与 Flowchart、Gantt 的边界技能文档反复强调一条原则Pick the right type, not the easy type.选择正确的图型而不是最容易的图型——不要所有场景都用 Flowchart 兜底。从 Markdown 样式指南的图表选择表 与 Mermaid 样式指南的选择表 可以看出三种易混淆场景的边界内容类型应选图型类型文件步骤/流程/决策逻辑Flowchartflowchart.md项目时间线/路线图/任务依赖Ganttgantt.md按时间顺序的事件/里程碑/历史Timelinetimeline.md三者的判断要点Timeline 关注什么时候发生了什么——它不表达持续时长也不表达任务之间的依赖只按时间轴罗列事件Gantt 关注每项任务占多久、谁依赖谁——它需要dateFormat、after taskId依赖语法、:milestone里程碑和:crit关键路径标记Flowchart 关注逻辑流向与分支——与时间轴无关。例如描述一篇论文从投稿到见刊的审稿流程用 Timeline 合适而这个月要排期完成的 8 个开发任务及依赖则应改用 Gantt。技能在 mindmap.md、user_journey.md、kanban.md 等文件中也以 When NOT to use 交叉引用的方式互相锚定保证了整库图型选择的一致性。基础语法结构title、section 与冒号分隔条目Timeline 的核心语法由三部分组成timeline声明图表类型的关键字title图表标题建议用 emoji 前缀做视觉锚点section按年份、季度或阶段分组的时间段条目行每条事件名 : 细节一 : 细节二同一个时间点可以用冒号分隔多个并列条目。示例图初创公司增长里程碑以下示例图完整复现自 timeline.md演示了按年份与季度组织事件的标准写法初创公司从创立到 A 轮融资的增长里程碑按年份与季度组织模板可直接套用的空骨架写作时建议从模板出发先搭出骨架再填充内容对时间线及所覆盖时间段的描述关键使用技巧Tipstimeline.md 给出的技巧是实战中最直接的规则必须逐条落实用section按年份、季度或阶段分组——分组的粒度决定了时间线的可读性每个条目可以有多个事项用:分隔——一个时间点可同时表达 23 个并列事件条目保持简洁——每条 24 个词——时间线的信息密度靠并列条目实现而不是靠冗长文字在关键条目开头使用 emoji 作为视觉锚点——如 创立、 Beta、 融资读者扫一眼 emoji 即可抓住叙事主线务必在图上配一段 Markdown 文字描述通常为斜体段落供屏幕阅读器理解。结合 Mermaid 样式指南的 emoji 规则emoji 使用还有四条附加约束放置在标签开头、每个节点最多一个、同一 emoji 在全项目内语义必须一致、仅用于需要视觉区分的关键节点并禁止使用 等纯装饰性 emoji。例如只表示金融/成本/计费只表示实验/测试/QA。复杂示例把架构演进写成讲故事的时间线当时间线跨越多年、承载业务指标与技术里程碑时可以借鉴复杂示例的结构——把section当作时代而非年份来使用。以下完整复现自 timeline.md多年代技术平台演进追踪一家初创公司从单体架构走向微服务、最终成为 AI 驱动平台的历程。六个 section 横跨 2020-2025 年每个 section 记录驱动架构决策的关键技术里程碑与业务指标为什么这个写法有效Why this works原文档对该复杂示例给出了四条经验总结值得逐条内化6 个 section 是时代而非简单年份——Monolith EraBreaking ApartMicroservices讲的是架构为什么要变而不只是什么时候变。section 名称本身就是叙事业务指标与技术里程碑并列——用户数与团队规模紧挨着架构决策出现50K 用户 → 触顶 → 拆服务直观呈现驱动每次演进的压力来源每个时间点塞入多个条目——每个季度用:分隔 23 个事件形成信息密集但可扫读的并行视图emoji 锚定扫读路径——视线会先落在 ML、 Multi-region、⚡ Redis 上再读文字快速浏览时仅凭 emoji 就能读懂整个故事。仓库实战在科研报告中落地 Timelinetimeline并不只是演示代码——技能自带的一篇完整科研报告 example-research-report.md 中就有一个真实的 CRISPR 基因编辑实验里程碑时间线。它演示了科研场景的标准用法以月为 section 粒度每个 section 内并列两条实验进度注意这个示例与参考文档示例的一个差异它在timeline之后、title之前写入了accTitle与accDescr。这实际上提示了兼容性问题——根据 Mermaid 样式指南Timeline 并不支持无障碍注解更稳妥的做法仍是斜体段落 纯 timeline 语法参考文档示例图的写法以保证在 GitHub 及各类渲染器上的行为一致。这也说明以参考文档为语法权威、以示例报告为内容灵感是使用该技能最可靠的组合方式。从报告整体结构看该示例同时使用了xychart-beta柱状图、gantt、flowchart、sequenceDiagram等图型Timeline 被定位为研究方法章节的时序骨架与量化图表各司其职——这正是技能倡导的让每种关系都落到最匹配的图型上。与其他图型的组合编排单一时间线只能表达一个视角。当文档需要同时服务管理层与工程师时可以参考 complex_examples.md 的组合模式。其中与 Timeline 直接相关的组合包括正在记录的场景图型组合为什么有效迁移项目Gantt时间线 Architecture改造前后 Flowchart迁移流程进度给管理层、拓扑给基础设施团队、步骤给迁移团队文献综述Mindmap概念地图 Timeline/Gantt发表时间线 Quadrant/Radar方法对比见 SKILL.md 的 literature-review 集成技能文档对文献综述场景给出的具体建议是用 Mindmap 绘制文献版图用 Timeline 或 Gantt 展示发表时间线用 Quadrant 或 Radar 对比方法论用 Sequence 或 Flowchart 绘制论文中描述的数据流。这意味着时间线在综述类文档中的典型角色是呈现某个领域或某条研究线的演化史——与 Timeline 图Chronological events / history的定位完全吻合。写入文档前的检查清单结合 timeline.md 与 Mermaid 样式指南的 Quality Checklist每个 timeline 图在提交前应通过以下检查代码块正上方有描述性的斜体Markdown 段落因 Timeline 不支持accTitle/accDescrsection按年份、季度或阶段分组粒度一致每个条目 24 个词多个事项用:分隔且不过载emoji 来自 样式指南的批准集每条最多一个、置于开头、全库语义一致无%%{init}主题指令、无内联style以保证 GitHub 深色模式正常渲染时间轴形态为事件罗列而非任务依赖/时长后者请改用 Gantt 图图型选择正确确认 Flowchart、Sequence、Gantt 均不是更贴切的表达图表内联放置在相关文字旁而不是集中堆在文末的独立 Figures 章节。完成以上检查后将.md文件内嵌 Mermaid 源码直接提交即可——文本源码即真相来源source of truth后续如需出版级配图可再以该源码为 brief 交给 scientific-schematics 生成 PNG 作为补充图实现Phase 1 文本定稿、Phase 3 视觉精修的三阶段工作流。【免费下载链接】scientific-agent-skillsTurn any AI agent into an AI Scientist. The #1 Agent Skills library for science, used by 190,000 scientists worldwide. 165 ready-to-use validated skills plus 100 scientific databases covering biology, chemistry, medicine, and drug discovery. Compatible with Cursor, Claude Code, Codex, Pi, Antigravity, and the open Agent Skills standard.项目地址: https://gitcode.com/GitHub_Trending/cl/scientific-agent-skills创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表