すごく違和感がある設計書の表記方法に出会ったので、
書いてみます。
特に技術的な内容ではありません。
違和感のある設計書の表記方法
※あくまでイメージです。
1 Aテーブルの取得
Aテーブルのデータを取得する。
(1)取得件数が1件の場合は2を行う。
(2)取得件数が1件以外の場合は3を行う。
2 〇〇処理
〇〇処理を行う。
3 △△処理
△△処理を行う。
基本的に現代のプログラミングは、構造化プログラミングの思想に従っているので、上記のようにジャンプされると、混乱を招いてしまうと感じました。
この場合だと、「1(1)で2の処理を行って、3の処理はするのだろうか？」
という疑問がでてきてしまいます。
自分なら下のように書きます...
1 Aテーブルの取得
Aテーブルのデータを取得する。
2 〇〇処理
Aテーブル検索結果が1件の場合、
〇〇処理を行う。
3 △△処理
Aテーブル検索結果が1件以外の場合、
△△処理を行う。
些細なことかもしれませんが、気になったので書いてみました。
今の現場で、最初のような表記をする方が一定数おり、
違和感を覚えている今日このごろです。