skillup

技術ブログ

ドキュメント作成

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

投稿日:

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

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

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

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

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

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

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

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

-ドキュメント作成
-

執筆者:


comment

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

関連記事

no image

仕様の把握で見るポイント

新しい現場に入って技術的な部分はもとより仕様の把握などでポイントになる点などを。 Contents1 ER図2 ステータス変更3 プレイヤー(イベント)整理4 タイムテーブル5 マトリックス表6 ダミ …

no image

コレクションの頻出処理に関して

PHPでコレクションを使っていますが、慣れると本当に便利ですね・・・まあforeachとかでグリグリやってもいいのですが、無駄にコードが長くなります。 自分がコレクションでよく使う再頻出のメソッドなど …

no image

Officeソフトで覚えておきたいポイント(Word,Excel)

えー実は今現在、仕事でコードを書くことはほとんどしておらず、ExcelやWordと日々格闘しております。Excelも表計算じゃなくて図を書くのに使ってます。 ExcelはまだしもWordってエンジニア …

no image

APIに関して

RESTAPIのルーティングで気をつけることなんぞを。 直近のプロジェクトではRESTAPIを作ることが多かったんですが気をつけることなんぞを。 Contents1 仕様書はソースから2 ツール3 命 …

no image

30分で完成! テーブル定義書&ER図 自動作成

現在携わっているプロジェクトでテーブル定義書やER図を作成することに。 えーこういった資料の特徴として、 年月を経るごとに本番との差分ができてしまい、結局だれも見ない・・・なんてことになりがちですよね …