skillup

技術ブログ

ドキュメント作成

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

投稿日:

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

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

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

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

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

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

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

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

-ドキュメント作成
-

執筆者:


comment

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

関連記事

no image

アジャイル開発について

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

no image

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

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

no image

新アプリの本番環境デプロイについて

新しく作ったWEBアプリを本番配置しようとしたんですが、何度もやっているはずの処理がいざやろうとするといろいろと手間取ってしまい、1時間近くかかりました。 容量悪いなーと思いつつ、こういった行為はなる …

no image

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

前回に引き続き、大事だと思ったこと。一部単なるフレームワークの作り方的な内容になっているかも。 Contents1 テンプレート共通化2 バリデーション3 ログ出し4 異常系の処理5 新規プラグイン+ …

no image

使える設計書作成に関して

私自身、この仕事を7〜8年やっておりますが、設計書作成については常に悩まされておりました。 設計書のメリット・デメリットとしては以下のようなものですかね。 メリット メンバー間での仕様の認識を統一でき …