skillup

技術ブログ

ドキュメント作成

使える設計書作成に関して シーケンス図

投稿日:

使える仕様書ですが、細かいロジックなどシーケンス図も結構役に立つのでは・・と思いましたね。

シーケンス図とは下記のようなものです。

https://cacoo.com/ja/blog/what-is-sequence-diagram/

メリットとしては

  • 業務用の複雑なロジックを口頭で齟齬なく伝えるのはかなり難しい
  • 他のメンバーに仕事を触ることができる
  • コードから起こせば時間もそれほどかからない

などが考えられるでしょう。

そう言った観点から

ツールを漁っていましたが、下記のツールがかなりおすすめかと思います。

PlantUML

https://plantuml.com/ja/

このツールですが、

のように書いておけば、

のような画像ができます。(vscodeならすぐにリアルタイムで上記のような画像が作れます)

マークダウンとかでコードとセットにして入れておくといいのではないかなあと思います。

上の図からソースの大まかなロジックを作ることができますし、画像から仕様の齟齬を防ぐことができます。

すっごい簡単なサンプルですが作って見ました。

https://github.com/umanari145/uml/

なお、シーケンス図以外にも色々と用途はあるようで、様々な使い方ができます。

PlantUML Cheat Sheet

-ドキュメント作成
-

執筆者:


comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

関連記事

no image

テスト分類について

一般的なテスト工程での分類や個人的に大事だと思うこと Contents1 全プロセス共通1.1 テストデータ作成バッチ1.2 ローカル、開発、ステージング、本番の分岐2 PT(プログラムテスト)、単体 …

no image

30分で完成! テーブル定義書&ER図 自動作成

現在携わっているプロジェクトでテーブル定義書やER図を作成することに。 えーこういった資料の特徴として、 年月を経るごとに本番との差分ができてしまい、結局だれも見ない・・・なんてことになりがちですよね …

no image

ドキュメント作成(要件定義〜設計)のポイントについて

4月から新しいプロジェクトが始まり仕事がドキュメント作成(要件確認書、基本設計、詳細設計)などをしております。この仕事自体が自分にとってあまりなじみのないものだったので、そこで思ったことなどを。 Co …

no image

単体テスト仕様書について

おそらく開発者が書きたくないものの筆頭になるかと思う単体テスト仕様書ですが、うまく使うと有益なコミニケーションツールになります。 Contents1 ユーザーのフロー体験・説明書2 前提となるデータ3 …

no image

新しいプロジェクトに入った時にやること

新しいプロジェクトに入った時に最初にすべきことややっておくことなど Contents1 仕様理解編1.1 ユーザーの行動遷移の理解1.2 キー系のデータの理解1.3 データグルーピング1.4 サンプル …