6/12.log

シーケンス図を描いていく

研究室で作っているアプリケーションで自分が作成した箇所のシーケンス図を作成しました。これ本来は実装前に作るものですよね？次からそうします。

作成した手順についてですがとりあえず手書きで手順を書き出してからツールを使いつつ図に起こしていました。ツールはplant umlを使って作成しました。公式サイトを見た感じ本来はツールをダウンロードする必要がありそう？なのですがvscodeの拡張機能を使う方法もあるみたいなので自分はその方法で作成しました。

そのツール自体コードを書くことによって図を書いていく形のものでUIがあってドラッグ＆ドロップで、、、といった感じではなかったのでどのようなコードを書けば良いか理解するのに少し時間を要しましたが思った以上に難しいものではありませんでした。

具体的な書き方などは記事にしたいと思っています！

シーケンス図について少し書く

シーケンス図があればコードを読まなくともどのような処理を行なっているかがわかるようになって便利ですよね。swaggerとかのapiの設計書があればどのapiがどのような機能を果たすかはわかりますがそのapiの内部の処理は記述できないというよりしないですよね？そのような点ではシーケンス図・swaggerの役割自体が違うと思っています。

そのような考えのもと自分たちの研究室ではシーケンス図＋swagger両方を作成しているのですが実際の現場でもそのように両方使っているんですかね？

そもそもシーケンス図は新たにプロジェクトに入ってきた人が参照したり実装方法に迷ったら確認といったものでswaggerはどのapiにどのような機能を持たせるべきか考える時やapiを叩くときにどれを叩くべきか考えるときに使用するので両方を同時に参照することはなく一つにしたからといってものすごく便利になるかと言われればそうではないのですが同じようなことを2回書く必要があったりとそもそもドキュメントを書くのに手間が増えています。もっと効率の良い書き方やツールはないものか。