Skip to content

foryourhealth111-pixel/Vibe-Skills / bundled/skills/markdown-mermaid-writing

markdown-mermaid-writing

Unverified

Comprehensive markdown and Mermaid diagram writing skill that establishes text-based diagrams as the DEFAULT documentation standard. Use this skill when creating ANY scientific document, report, analysis, or visualization — it ensures all outputs are in version-controlled, token-efficient markdown with embedded Mermaid diagrams as the source of truth, with clear pathways to downstream Python or AI-generated images. Includes full style guides (markdown + mermaid), 24 diagram type references, and 9 document templates ready to use.

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

references/diagrams/requirement.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) -->

# Requirement Diagram

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

**Syntax keyword:** `requirementDiagram`
**Best for:** System requirements traceability, compliance mapping, formal requirements engineering
**When NOT to use:** Informal task tracking (use [Kanban](kanban.md)), general relationships (use [ER](er.md))

---

## Exemplar Diagram

```mermaid
requirementDiagram

    requirement high_availability {
        id: 1
        text: System shall maintain 99.9 percent uptime
        risk: high
        verifymethod: test
    }

    requirement data_encryption {
        id: 2
        text: All data at rest shall be AES-256 encrypted
        risk: medium
        verifymethod: inspection
    }

    requirement session_timeout {
        id: 3
        text: Sessions expire after 30 minutes idle
        risk: low
        verifymethod: test
    }

    element auth_service {
        type: service
        docref: auth-service-v2
    }

    element crypto_module {
        type: module
        docref: crypto-lib-v3
    }

    auth_service - satisfies -> high_availability
    auth_service - satisfies -> session_timeout
    crypto_module - satisfies -> data_encryption
```

---

## Tips

- Each requirement needs: `id`, `text`, `risk`, `verifymethod`
- **`id` must be numeric** — use `id: 1`, `id: 2`, etc. (dashes like `REQ-001` can cause parse errors)
- Risk levels: `low`, `medium`, `high` (all lowercase)
- Verify methods: `analysis`, `inspection`, `test`, `demonstration` (all lowercase)
- Use `element` for design components that satisfy requirements
- Relationship types: `- satisfies ->`, `- traces ->`, `- contains ->`, `- derives ->`, `- refines ->`, `- copies ->`
- Keep to **3–5 requirements** per diagram
- Avoid special characters in text fields — spell out symbols (e.g., "99.9 percent" not "99.9%")
- Use 4-space indentation inside `{ }` blocks

---

## Template

```mermaid
requirementDiagram

    requirement your_requirement {
        id: 1
        text: The requirement statement here
        risk: medium
        verifymethod: test
    }

    element your_component {
        type: service
        docref: component-ref
    }

    your_component - satisfies -> your_requirement
```
rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file).Stars: 198kUpdated Claude CodeCodexUnverifiedInstall
doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.Stars: 198kUpdated Claude CodeCodexVerifiedInstall