Structurizr Liteから始める

Structurizr LiteはStructurizrの無料版です.そして、Docker Containerとしてパッケージ化されて、すぐに著者と/または表示ソフトウェア・アーキテクチャ図、ドキュメンテーションと建築決定記録(ADRS)を望む開発者のために設計されます.ソフトウェアアーキテクチャモデル、ビュー、およびドキュメント(一緒に“ワークスペース”と呼ばれる)は、構造体のDSLを使用して定義することができます特に、ソフトウェアアーキテクチャおよびC4 modelをサポートするように設計されたテキスト言語.始めましょう.

1 .新規ディレクトリの作成

まず、ワークスペースを格納するディレクトリを作成する必要があります.

2 .ワークスペースを作成します。DSLファイル

次に、ディレクトリ内のworkspace.dslというファイルを作成する必要があります.

workspace {

    model {
        user = person "User"
        softwareSystem = softwareSystem "Software System"

        user -> softwareSystem "Uses"
    }

    views {
        systemContext softwareSystem "Diagram1" {
            include *
            autoLayout
        }

        theme default
    }

}

あなたはhttps://github.com/structurizr/dslでStructurizr DSLについての詳細を見つけることができますが、本質的にこのDSLファイルは以下のように言います.

ユーザーがソフトウェアシステムを使用しているユーザとソフトウェアシステムでモデルを作成します.

AutoLayoutを使用して、デフォルトの設定を追加するソフトウェアシステムのシステムコンテキストビューを作成します.

スタイル要素と関係のためにdefaultテーマを使用してください.

3 .スタートアップ

Dockerをインストールしたと仮定すると、次のコマンドを使用してStructurizr Liteを起動できます.

docker pull structurizr/lite
docker run -it --rm -p 8080:8080 -v PATH:/usr/local/structurizr structurizr/lite

PATHには、ステップ1で作成したディレクトリへのフルパスに置き換えてください.例えば、ディレクトリが/Users/alice/structurizrにあるなら、コマンドは以下の通りです.

docker pull structurizr/lite
docker run -it --rm -p 8080:8080 -v /Users/alice/structurizr:/usr/local/structurizr structurizr/lite

図を見る

Webブラウザで作業スペースをhttp://localhost:8080に向かって開き、図を参照してください.

DSLファイルを変更して保存する場合は、Webブラウザを更新したときに直ちに変更が反映されていることを確認してください.

ドキュメントを追加する

私たちのソフトウェアシステムを記述するためにいくつかのドキュメンテーションを加えましょう.これを行うには、docsという名前のサブディレクトリを作成し、そのサブディレクトリ内の01-context.mdというファイルを作成します

## Context

Here is a description of my software system...

![](embed:Diagram1)

以下のようにworkspace.dslファイルの内容を変更します(!docs行の追加に注意してください).

workspace {

    model {
        user = person "User"
        softwareSystem = softwareSystem "Software System" {
            !docs docs
        }

        user -> softwareSystem "Uses"
    }

    views {
        systemContext softwareSystem "Diagram1" {
            include *
            autoLayout
        }

        theme default
    }

}

すべてのファイルを保存し、Webブラウザをリフレッシュし、本のようにアイコンを左上のボタンをクリックします.これで、既存のシステムコンテキスト図を埋め込んでいます.

概要

Structurizr Liteは、Structurizrツールを起動するには、迅速かつ無料の方法を提供します.これは、能力をC/Cのモデル図の完全なセットをサポートし、能力をマークダウン/ASCIDCドキュメントを発行するとアーキテクチャの決定記録(ADRS).楽しむ!