skillup

技術ブログ

ドキュメント作成

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

投稿日:

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

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

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

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

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

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

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

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

-ドキュメント作成
-

執筆者:


comment

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

関連記事

no image

ドキュメント作成について

アプリやプロジェクトのドキュメント作りですが、時間が立ったり、複数人での開発を行うと 情報の漏れや抜けが非常に多くなる 本番との差分ができる 一部の人しか更新しなくなる 似たようなドキュメントがあちこ …

no image

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

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

no image

ドメイン決定&業務フローとの対応確認

Contents1 ドメイン決定2 業務フローとの対応2.1 実際の業務とエンティティ、画面の遷移2.2 ドメインのCRUD分析 ドメイン決定 業務フローを抽出し、エンティティを抽出した段階で次にドメ …

no image

API仕様書に関する注意事項

API仕様書を作っていて、基本的な点についてのまとめ コードと連動できれば理想(現実的には設定ファイルをJSONかYamlで作るぐらいが限界だと思う) 型のチェック、必須チェック、桁数チェック、日付の …

no image

データベースのテスト環境作成

現在作っているシステムのリリースが近づいており、本番に近い環境を作成しお客様に見てもらうことに。 こういった手順はマニュアル化しておいたほうが楽だろうと思い、自分的にメモ 1 現状運用されているデータ …

アーカイブ