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

設計業務での改善点など

比較的大規模なプロジェクトの設計段階で思ったことなど。会議など頻繁に開かれると思いますが、聞いているだけだったり、各人が色々なことを喋って内容がまとまっていなかったり・・結局何をやりたいかわからなくな …

no image

Gitの活用に関して

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

no image

APIのエラーコードに関して

APIのよく使われるHTTPステータスコードに関して。 基礎の基礎で当たり前に使ってましたが、基本的なことに関してまとめ。 主に4XXエラーのタイプ分けに関して。 Contents1 2002 201 …

no image

コード静的解析ツールを使った際の気づきなど

最近のプロジェクトでコード静的解析ツール(phpcs,phpmd)を使った際の気づきなど コードを書きながら常時エディタがチェックするタイプのものでないとまず無理(保存するたびでも無理だし、コミット時 …

no image

外結〜運用フェーズでの気をつけることなど

外結以降のフェーズで注意することなど。(主に障害発生時の原因切り分け) Contents1 エラーの情報伝達に関して2 ログの見方3 デプロイ4 タスクコミュニケーション(タスク管理ツール) 主にスト …

アーカイブ