Design Dawn

設計書を Git で管理する

Design Dawn はデータベースも、1つにまとまったバイナリの文書ファイルも使いません。Project は小さなテキストファイルが入ったフォルダなので、Git・差分・プルリクエストといったソースコード用の道具が、設計書にもそのまま使えます。

Project の保存形式

my-project/
├── project.json
├── system-design.dawn
└── documents/
    └── system-design/
        ├── document.json
        ├── assets/
        └── sheets/
            └── overview/
                ├── sheet.json
                └── blocks/
                    ├── markdown-1.md
                    └── mermaid-1.mmd
  • Markdown ブロックは1つずつ .md ファイル、Mermaid ブロックは1つずつ .mmd ファイルになります。
  • 位置・大きさ・並び順は、本文とは別の小さな JSON ファイル(sheet.json・document.json・project.json)に保存されます。
  • 画像は、その Document の assets/ フォルダにコピーされます。
  • すべての JSON に schemaVersion があります。Document・Sheet・Block には変わらない UUID が付き、アプリに表示される名前はフォルダ名とは独立しています。

メモの文を直せば変わるのは1つの .md ファイルだけ、ブロックを動かせば変わるのは1つの sheet.json の数値だけです。差分が小さく読みやすいままなのは、このためです。

Markdown ブロックの左右比較の Git 差分
タブで開いた、Markdown ブロックの左右比較の差分(画面は英語表示です)

アプリの中でできる Git 操作

Project のフォルダが Git リポジトリなら、サイドバーの Git タブで次のことができます。

  • 変更の一覧と、ステージ / ステージ解除
  • コミットと、直前のコミットの取り消し
  • 履歴の表示
  • タブで開く左右比較の差分
  • 変更の破棄
  • フェッチ / プル / プッシュと、リモートへのブランチの発行
  • 現在のブランチ名の表示

Git 本体に任せていること

  • アプリは PC にインストールされた git コマンドを使います。Git の機能には Git 2.25 以上が必要です。Git が無くても、それ以外の機能は使えます。
  • リポジトリの作成はアプリでは行いません。git init(またはクローン)は普段のツールで行ってください。リポジトリでないフォルダは「Git で管理されていません」と表示されます。
  • ブランチの作成・切り替え、マージ、競合の解決は、アプリではなく普段の Git ツールで行います。

アプリの外でファイルが変わったとき

プル、ターミナルでのチェックアウト、ほかのエディタ、AI ツールなどで、開いている Document のファイルが変わることがあります。Design Dawn はこれを検知します。未保存の変更が無い Document は自動で読み直し、ある場合は「読み直す / 今の内容を維持 / 比較」から選べます。

設計をプルリクエストでレビューする

メモも図もテキストなので、設計の変更をコードの変更と同じ流れでレビューできます。ブランチをプッシュしてプルリクエストを開けば、レビューする人は .md と .mmd の差分を読めます。Design Dawn を使うのをやめても、文書は普通の Markdown と Mermaid のファイルとして残ります。

同じファイルを、AI ツールはローカルの MCP サーバー経由で扱えます。図は Mermaid の GUI 編集で編集できます。

Design Dawn を試す

無料・オープンソース(MIT)です。Windows 版は zip ファイルで、登録は要りません。

ガイド: Mermaid GUI · AI / MCP · ダウンロード