markdown-mermaid-writing

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.

Quality

82%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

Passed

No findings from the security scan

Quality

Content

81%Weight 40%Scale 1-5

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

The content is a well-structured overview that leverages progressive disclosure effectively with a real, organized bundle and clear navigation. It is actionable and concisely written, with only minor verbosity and the lack of explicit validate-then-proceed feedback loops in the workflow.

Suggestions

Add explicit validation/feedback-loop steps to the core workflow (e.g., 'render-check each Mermaid block before committing') to strengthen workflow_clarity.

Trim the 'Why text-based diagrams win' comparison table and pull-quote to reduce token overhead while preserving the key points.

Dimension	Reasoning	Score
Conciseness	Mostly efficient overview with tables and short rules, but the comparison table, three-phase diagram, and pull-quote add length that could be trimmed; it does not heavily re-explain concepts Claude already knows.	4 / 5
Actionability	Provides concrete copy-paste Mermaid snippets (radar-beta correction, accTitle/accDescr block), file-path guidance, and a checklist; minor gaps where it points to guides rather than inlining the executable detail.	4 / 5
Workflow Clarity	The five-step core workflow is clearly sequenced with reading the style guide before writing, but validation checkpoints are mostly a final checklist rather than explicit validate-then-proceed feedback loops.	4 / 5
Progressive Disclosure	Clear overview body with well-signaled one-level-deep references to real bundle files (references/markdown_style_guide.md, references/diagrams/*.md, assets/examples/) and an organized reference index; navigation is easy and structure is appropriate.	5 / 5
	Total	17 / 20 Passed

Description

83%Weight 40%Scale 1-5

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

The description is strong and explicit, clearly stating both what the skill does and when to use it with concrete trigger phrases and a distinct niche. Minor overlap risk and a few missing synonyms/extensions keep it just below perfect.

Suggestions

Tighten the trigger scope from 'ANY scientific document' to a more specific niche to reduce overlap with general scientific-writing skills.

Add common file extensions or synonyms (e.g., '.md', 'README', 'decision records') to broaden natural keyword coverage.

Dimension	Reasoning	Score
Specificity	Lists several concrete capabilities ('embedded Mermaid diagrams as the source of truth', '24 diagram type references', '9 document templates', 'downstream Python or AI-generated images') with only minor gaps in coverage.	4 / 5
Completeness	Explicitly answers both what ('establishes text-based diagrams as the DEFAULT documentation standard') and when ('Use this skill when creating ANY scientific document, report, analysis, or visualization') with concrete trigger phrases.	5 / 5
Trigger Term Quality	Good coverage of natural user phrasing ('scientific document, report, analysis, or visualization', 'version-controlled', 'markdown') but is missing common synonyms and explicit file extensions like .md.	4 / 5
Distinctiveness Conflict Risk	Clear niche (Mermaid-in-markdown documentation layer) with distinct triggers, but the broad 'ANY scientific document' scope creates minor overlap risk with general writing/scientific-writing skills.	4 / 5
	Total	17 / 20 Passed

Validation

81%

Warnings & errors only

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 13 / 16 Passed

Validation for skill structure

Criteria	Description	Result
metadata_version	'metadata.version' is missing	Warning
metadata_field	'metadata' should map string keys to string values	Warning
referenced_paths_exist	Referenced path issues: 26 deeper-than-1-level	Warning

	Total	13 / 16 Passed

Repository: foryourhealth111-pixel/Vibe-Skills
Path: bundled/skills/markdown-mermaid-writing/SKILL.md
Commit: d5ae560

Reviewed: 1 day ago

Table of Contents

Discovery Implementation Validation

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.