skillup

技術ブログ

ドキュメント作成

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

投稿日:

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

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

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

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

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

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

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

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

-ドキュメント作成
-

執筆者:


comment

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

関連記事

no image

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

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

no image

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

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

no image

ドキュメント作成(要件定義〜設計)のポイントについて

4月から新しいプロジェクトが始まり仕事がドキュメント作成(要件確認書、基本設計、詳細設計)などをしております。この仕事自体が自分にとってあまりなじみのないものだったので、そこで思ったことなどを。 Co …

no image

業務管理アプリの商品コードに関して

一般的な業務管理アプリを作っていると商品や顧客などもオートインクリメントのidではなく、独自の仕様で決められた「商品コード」などを持っていることが一般的です。 昔通販がらみのシステムを使っている時も商 …

no image

ディレクション時に重要な視点

ディレクション(ベンダーや内製時)時に留意するポイント Contents1 開発ルールの構築2 アサインと人材スクリーニング3 言葉の共通化(特にアウトプット)4 問題化のキャッチアップ5 リソースの …

アーカイブ