Skip to content

K-Dense-AI/scientific-agent-skills / skills/markdown-mermaid-writing

markdown-mermaid-writing

Unverified

Writes scientific Markdown documentation and Mermaid diagrams for workflows, relationships, timelines, and schemas. Provides syntax references, document templates, accessibility guidance, and version-aware rendering checks. Use when a user requests Markdown, Mermaid, or a text-based structural diagram; quantitative scientific figures require suitable plotting tools.

FileKindSize
SKILL.mdskill md16.3 KB
assets/examples/example-research-report.mdmarkdown3.4 KB
references/current-rendering.mdmarkdown7.6 KB
references/diagrams/architecture.mdmarkdown5.0 KB
references/diagrams/block.mdmarkdown5.0 KB
references/diagrams/c4.mdmarkdown6.7 KB
references/diagrams/class.mdmarkdown8.6 KB
references/diagrams/complex_examples.mdmarkdown16.8 KB
references/diagrams/er.mdmarkdown8.0 KB
references/diagrams/flowchart.mdmarkdown7.0 KB
references/diagrams/gantt.mdmarkdown6.0 KB
references/diagrams/git_graph.mdmarkdown2.2 KB
references/diagrams/kanban.mdmarkdown4.0 KB
references/diagrams/mindmap.mdmarkdown2.5 KB
references/diagrams/packet.mdmarkdown2.4 KB
references/diagrams/pie.mdmarkdown1.9 KB
references/diagrams/quadrant.mdmarkdown2.6 KB
references/diagrams/radar.mdmarkdown2.8 KB
references/diagrams/requirement.mdmarkdown3.0 KB
references/diagrams/sankey.mdmarkdown2.6 KB
references/diagrams/sequence.mdmarkdown5.9 KB
references/diagrams/state.mdmarkdown5.7 KB
references/diagrams/timeline.mdmarkdown4.5 KB
references/diagrams/treemap.mdmarkdown2.6 KB
references/diagrams/user_journey.mdmarkdown5.2 KB
references/diagrams/xy_chart.mdmarkdown2.6 KB
references/diagrams/zenuml.mdmarkdown2.5 KB
references/markdown_style_guide.mdmarkdown32.4 KB
references/mermaid_style_guide.mdmarkdown26.6 KB
templates/decision_record.mdmarkdown7.2 KB
templates/how_to_guide.mdmarkdown7.1 KB
templates/issue.mdmarkdown11.6 KB
templates/kanban.mdmarkdown10.6 KB
templates/presentation.mdmarkdown8.1 KB
templates/project_documentation.mdmarkdown11.5 KB
templates/pull_request.mdmarkdown11.8 KB
templates/research_paper.mdmarkdown10.1 KB
templates/status_report.mdmarkdown7.2 KB

references/diagrams/timeline.md

View on GitHub
<!-- Source: https://github.com/SuperiorByteWorks-LLC/agent-project | License: Apache-2.0 | Author: Clayton Young / Superior Byte Works, LLC (Boreal Bytes) -->

# Timeline

> **Back to [Style Guide](../mermaid_style_guide.md)** β€” Read the style guide first for emoji, color, and accessibility rules.

**Syntax keyword:** `timeline`
**Best for:** Chronological events, historical progression, milestones over time, release history
**When NOT to use:** Task durations/dependencies (use [Gantt](gantt.md)), detailed project plans (use [Gantt](gantt.md))

> ⚠️ **Accessibility:** Mermaid 12.0.0 accepts `accTitle`/`accDescr`, but the tested timeline SVG omitted their metadata. Supply a visible description and export alt text.

---

## Exemplar Diagram

_Timeline of a startup's growth milestones from founding through Series A, organized by year and quarter:_

```mermaid
timeline
    title πŸš€ Startup Growth Milestones
    section 2024
        Q1 : πŸ’‘ Founded : Built MVP
        Q2 : πŸ§ͺ Beta launch : 100 users
        Q3 : πŸ“ˆ Product-market fit : 1K users
        Q4 : πŸ’° Seed round : $2M raised
    section 2025
        Q1 : πŸ‘₯ Team of 10 : Hired engineering lead
        Q2 : 🌐 Public launch : 10K users
        Q3 : 🏒 Enterprise tier : First B2B deal
        Q4 : πŸ“Š $1M ARR : Series A prep
    section 2026
        Q1 : πŸš€ Series A : $15M raised
```

---

## Tips

- Use `section` to group by year, quarter, or phase
- Each entry can have multiple items separated by `:`
- Time labels are categorical strings in source order; horizontal spacing does not encode elapsed duration
- Keep items concise β€” 2–4 words each
- Emoji at the start of key items for visual anchoring
- **Always** pair with a Markdown text description above for screen readers

---

## Template

_Description of the timeline and the period it covers:_

```mermaid
timeline
    title πŸ“‹ Your Timeline Title
    section Period 1
        Event A : Detail one : Detail two
        Event B : Detail three
    section Period 2
        Event C : Detail four
        Event D : Detail five : Detail six
```

---

## Complex Example

_Multi-year technology platform evolution tracking a startup's journey from monolith through microservices to AI-powered platform. Six sections span 2020-2025, each capturing key technical milestones and business metrics that drove architecture decisions:_

```mermaid
timeline
    title πŸš€ Platform Architecture Evolution
    section 2020 β€” Monolith Era
        Q1 : πŸ’‘ Founded company : Rails monolith launched : 10 engineers
        Q3 : ⚠️ Hit scaling ceiling : 50K concurrent users : Database bottleneck
    section 2021 β€” Breaking Apart
        Q1 : πŸ” Extracted auth service : 🐳 Adopted Docker : CI/CD pipeline live
        Q3 : πŸ“¦ Split order processing : ⚑ Added Redis cache : 200K users
    section 2022 β€” Microservices
        Q1 : βš™οΈ 8 services in production : ☸️ Kubernetes migration : Service mesh pilot
        Q3 : πŸ“₯ Event-driven architecture : πŸ“Š Observability stack : 500K users
    section 2023 β€” Platform Maturity
        Q1 : 🌐 Multi-region deployment : πŸ›‘οΈ Zero-trust networking : 50 engineers
        Q3 : πŸ”„ Canary deployments : πŸ“ˆ 99.99% uptime SLA : 2M users
    section 2024 β€” AI Integration
        Q1 : 🧠 ML recommendation engine : ⚑ Real-time personalization
        Q3 : πŸ” AI-powered search : πŸ“Š Predictive analytics : 5M users
    section 2025 β€” Next Generation
        Q1 : ☁️ Edge computing rollout : πŸ€– AI agent platform : 10M users
```

### Why this works

- **6 sections are eras, not just years** β€” "Monolith Era", "Breaking Apart", "Microservices" tell the story of _why_ the architecture changed, not just _when_
- **Business metrics alongside tech milestones** β€” user counts and team size appear next to architecture decisions. This shows the _pressure_ that drove each evolution (50K users β†’ scaling ceiling β†’ extracted services)
- **Multiple items per time point** β€” each quarter packs 2-3 items separated by `:`, giving a dense but scannable view of everything happening in parallel
- **Emoji anchors the scan** β€” eyes land on 🧠 ML, 🌐 Multi-region, ⚑ Redis before reading the text. For a quick skim, the emoji alone tells the story


## Verified reference

Syntax examples reviewed against [official Mermaid documentation](https://mermaid.js.org/syntax/timeline.html) and rendered with Mermaid 12.0.0 (2026-10-01). Check the destination version; appearance and accessibility are not guaranteed by a successful parse.
brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation).Stars: 323kUpdated Claude CodeCodexVerifiedInstall
brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK).Stars: 198kUpdated Claude CodeCodexVerifiedInstall