使える仕様書ですが、細かいロジックなどシーケンス図も結構役に立つのでは・・と思いましたね。
シーケンス図とは下記のようなものです。
https://cacoo.com/ja/blog/what-is-sequence-diagram/
メリットとしては
- 業務用の複雑なロジックを口頭で齟齬なく伝えるのはかなり難しい
- 他のメンバーに仕事を触ることができる
- コードから起こせば時間もそれほどかからない
などが考えられるでしょう。
そう言った観点から
ツールを漁っていましたが、下記のツールがかなりおすすめかと思います。
PlantUML
このツールですが、
|
1 2 3 4 5 |
@startuml title シーケンス図 アリス -> ボブ: リクエスト ボブ --> アリス: レスポンス @enduml |
のように書いておけば、
のような画像ができます。(vscodeならすぐにリアルタイムで上記のような画像が作れます)
マークダウンとかでコードとセットにして入れておくといいのではないかなあと思います。
上の図からソースの大まかなロジックを作ることができますし、画像から仕様の齟齬を防ぐことができます。
すっごい簡単なサンプルですが作って見ました。
https://github.com/umanari145/uml/
なお、シーケンス図以外にも色々と用途はあるようで、様々な使い方ができます。
