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

開発時最低限必要かつ有用なドキュメントに関して

ウォーターフォール型の開発をかれこれ1年近くやっております。 自分がやってきた仕事とすると別職種に近いようなイメージでしたが、得ることも多かったため、ここに記しておこうと思います。 以前書いたことの記 …

no image

プロジェクトマネジメントについて

ある程度、大規模なプロジェクトを経験させていただき、経験だけでなくプロジェクトマネジメントを体系的に理解しておきたいため、ポツポツと本を読んでます。 比較的初心者でも読みやすいと思った本としてを2冊メ …

no image

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

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

no image

テーブル設計に関するメリデメ

昨日も書いた記事なんですが、基本的に実装にしても設計にしてもこれが最強っていう手法はなくて(あったとしたら全員がそれを使うのでそもそも選択肢という概念がなくなる・・)メリットデメリットをしっかりと考慮 …

no image

設計業務での改善点など

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

アーカイブ