skillup

技術ブログ

ドキュメント作成

基本設計書(シーケンス図)

投稿日:

基本設計書で気をつけるポイントなど。

要件が決まっており、処理の遷移や流れなどを知る時に、便利なのがシーケンス図だと思います。

アジャイルでもざっくり処理の流れを書いておけば、認識合わせに大分役立つはず。

書いたあとで、実はそこ違った・・・ってことを防げる

基本的に各ポイントなど自分が思ったことを。

  • 横軸にはView(画面)→Controller→Service→Repository→Modelやその他サブシステムの流れ。
  • 横軸はService〜Modelの部分は混合にさせた方があとで迷わなくて良いかも。
  • →でどの処理にどの処理が移っていくのかを表記する。Inパラメータ/Outパラメータまで余裕があれば書いておく
  • 処理は四角記号、条件分岐はひし形などある程度記号のルール表記を決めておく。
  • 書いておくべきは処理がどこに遷移しているのかという情報が必須。
  • ループや条件分岐のロジック部分なども簡便な表記でいいのでしっかりと書いておく。
  • エラー時のreturn処理が結構迷うので、要注意。
  • SQLはwhereとJOINを書いておく。

マークダウンで行けるかもしれませんが、結局MicrosoftExcelが最強かも・・・

ウォーターフォールではなくても、実装する前にざっくりと書いておけば認識の齟齬を防ぐことができて良いかも。

-ドキュメント作成
-

執筆者:


comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

関連記事

no image

アジャイル開発について

エンジニアとして仕事をしてから7〜8年立ちましたが、その間9割近くはいわゆるアジャイル開発でやってきたと思っていました。今は比較的大規模な開発をしておりますので、ウォータフォールですが・・・ が、先日 …

no image

使える設計書作成に関して シーケンス図

使える仕様書ですが、細かいロジックなどシーケンス図も結構役に立つのでは・・と思いましたね。 シーケンス図とは下記のようなものです。 https://cacoo.com/ja/blog/what-is- …

no image

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

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

no image

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

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

no image

EntityとValue Objectについて

ドメイン駆動設計に関して勉強しています。参考にしている本がやたら難しいんで、トピックごとにネットで調べつつ進めていくのがよさげです。 今回はEntityとValueObjectについて Content …

アーカイブ