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 全般2 要件定義3 基本設計4 詳細設計5 製造6 単体テスト〜内 …

no image

バッチスクリプトで気をつけたい点

実務でバッチ処理を作る際に気をつけるべきと思ったこと。 基本的にエラーをいかに捉えていかにログに吐くかを最初に考える。まずはエラーありき。失敗するもの、想定した値がこない、あるいは値がないを前提として …

no image

アジャイル開発について

エンジニアとして仕事をしてから7〜8年立ちましたが、その間9割近くはいわゆるアジャイル開発でやってきたと思っていました。今は比較的大規模な開発をしておりますので、ウォータフォールですが・・・ が、先日 …

no image

APIに関して

RESTAPIのルーティングで気をつけることなんぞを。 直近のプロジェクトではRESTAPIを作ることが多かったんですが気をつけることなんぞを。 Contents1 仕様書はソースから2 ツール3 命 …

no image

テスト分類について

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

アーカイブ