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 リソースの …

no image

Gitの活用に関して

今回はgitの技術的なことではなく、主に運用に関して。超基礎的なことですが、チームで開発する場合にはルールを徹底してないと混乱をきたします。 Contents1 ブランチを追加機能ごとにきる2 バグに …

no image

ファジープロジェクト対策 その1

5月ぐらいから着手していたプロジェクト(顧客管理ソフト)が終焉を迎え、検証段階に入ったので、記して置きたいことなど。 数ヶ月程度ですが、自分が携わったプロジェクトの中では過去最大クラスのものでした。 …

no image

API仕様書に関する注意事項

API仕様書を作っていて、基本的な点についてのまとめ コードと連動できれば理想(現実的には設定ファイルをJSONかYamlで作るぐらいが限界だと思う) 型のチェック、必須チェック、桁数チェック、日付の …

no image

コレクションの頻出処理に関して

PHPでコレクションを使っていますが、慣れると本当に便利ですね・・・まあforeachとかでグリグリやってもいいのですが、無駄にコードが長くなります。 自分がコレクションでよく使う再頻出のメソッドなど …

アーカイブ