markdown-mermaid-writing

Par mkurman · zorai

Skill complet de rédaction Markdown et diagrammes Mermaid pour la plateforme Zorai, incluant guides de style, 24 types de diagrammes et 9 templates de documents scientifiques.

npx skills add https://github.com/mkurman/zorai --skill markdown-mermaid-writing

markdown-mermaid-writing

Ce skill fait partie de la collection scientific-skills intégrée à Zorai, une plateforme d'exécution multi-agents durable développée par mkurman. Son rôle est d'établir un standard de documentation textuelle cohérent pour tous les agents et workflows de la plateforme : chaque document produit par un agent doit suivre les règles de style Markdown définies ici et utiliser Mermaid comme format privilégié pour les visualisations structurelles.

Contrairement à un simple squelette, ce skill est pleinement fonctionnel. Il fournit un workflow en cinq étapes (identifier le type de document, lire le guide de style, choisir le type de diagramme, rédiger, committer en texte), ainsi qu'un index de références complet : un guide de style Markdown (~733 lignes), un guide de style Mermaid (~458 lignes), 24 fichiers de référence pour chaque type de diagramme (flowchart, sequence, gantt, radar-beta, etc.), et 9 templates de documents prêts à l'emploi (research paper, decision record, kanban, pull request…).

Le skill documente également les pièges courants à éviter, notamment la syntaxe correcte de radar-beta vs xychart-beta, et les règles d'accessibilité (accTitle/accDescr) pour les types de diagrammes qui les supportent. Ces précisions sont particulièrement utiles pour éviter des erreurs silencieuses dans le rendu GitHub.

Il est conçu pour s'intégrer avec les autres skills de la collection scientific-skills : scientific-writing pour la rédaction de manuscrits, scientific-schematics pour la génération d'images publication-quality, et literature-review pour la cartographie de corpus bibliographiques. Ensemble, ces skills forment un pipeline de production documentaire pour les agents Zorai.

Les guides de style, références de diagrammes et templates inclus sont portés depuis le repository SuperiorByteWorks-LLC/agent-project sous licence Apache-2.0 (auteur : Clayton Young), avec attribution conservée dans les en-têtes de fichiers. Le skill lui-même est distribué sous licence MIT dans le cadre de claude-scientific-skills.

Skills similaires