マーメイドは永遠にダイアグラム


同僚は先日マーメイドを見せてくれたし、いつまでもダイアグラムを変えてしまった.技術のリードとして、私は常にどのようにアプリケーションが動作する必要があります表示するためにシーケンスとフロー図を作成する必要があります.通常、私はWYSIWYG図ソフトウェアを使用してきました、そして、それは働いています、しかし、それについて悩んでいる多くがあります.物事を整列し、行方不明のステップの調整を維持しようとすると、正しい形を見つけることは常に面倒なプロセスを作っている.エンターマーメイド.
図を「描く」ではなく、Mermaidは、.mdファイルのいくつかのマークダウンのような構文を使って図を作成します.最初は、私は少し懐疑的だったが、それをしようとしたの5分以内に、私はそれのハングアップして誓った私は決して戻ってない.しかし、私はあなたにサンプルを示しさせてください、そして、私はこれが合計ゲームチェンジャーである理由のいくつかに言及します.
人魚の例
sequenceDiagram
  participant System A
  participant System B
  activate System A
  System A ->> System B: POST /resource/{id}
  activate System B
  System B ->> System B: Do something
  System B -->> System A: Response
  deactivate System B
  deactivate System A
出力

どのようにクールですか?
マーメイドは、カスタマイズオプションの多くと一緒に、グラフの他の種類の数をサポートしています.ドキュメンテーションはかなり良いです、そして、私がそれをすべて捕える方法が全くないので、私はそれに入りません.ここでドキュメントをチェックアウトできます.
私はミル図ソフトウェアのあなたのランとは対照的にマーメイドを使用することから2つの主な利点を参照してください.
  • コード経由でダイアグラムを作成すると、ドキュメントを簡単にアプリケーションで有効にできます.私は私が開発しているアプリケーションに関連するいくつかのあいまいなダイアグラムのためのwikiを検索することに慣れてきた世界では、これはゲームチェンジャーです.さらに良いのは、SCMのようなGitlabは、マーメイドMarkdownを開くので、実際にページ上のグラフをロードする組み込みマーメイドプロセッサを持っています.
  • 更新はとても簡単です.一般的なダイアグラムソフトウェアでは、図に欠落したステップを追加しようとすると恐ろしいです.誤ってバックグラウンド要素を移動せずにシフトしなければならないすべての要素を選択しようとすると、まだすべての整列を保つ愚かな使いです.マーメイドでは、ちょうど新しいラインまたは2つを追加し、保存します.
  • すべてが言われて、私が気づいたいくつかの欠点があります、そして、私はそこに意識をもたらすことが公平であると思います.超巻き込まれた/長いグラフのために、テキストは本当に小さくなります、そして、私がこれまでに見たものから、ブラウザー・ズームは非常によく働きません.また、“ノート”を追加することができます問題が表示されている.私が行方不明であるカスタマイズがあるかもしれません、しかし、すべてが1つの線で現れるのを注意して、鋭く打たれてください.
    ボトムライン:マーメイドを試してみてください.それは本当に私は本当に興奮しているとevangelizeしたい珍しいJSプロジェクトです.