skillup

技術ブログ

ドキュメント作成

単体テスト仕様書について

投稿日:

おそらく開発者が書きたくないものの筆頭になるかと思う単体テスト仕様書ですが、うまく使うと有益なコミニケーションツールになります。

ユーザーのフロー体験・説明書

プロジェクトに入ったばかりですと仕様がわからず、右往左往することが多いのですね。

単体テスト仕様書の通りに進めていくと、正常なデータがどのように作られていくかを知ることができる(ユーザーのフローを知ることができる)ので基本的な仕様の理解をすることができます。

前提となるデータ

これが一番大事です。

ようはその状態を再現するのに必要なデータが揃っているかどうかで、Excelなどですとシステムとの差分が出てしまい、難しいことが多いのが現実です。

Dockerと連携させられれば状態再現が比較的に容易にできるため便利です。

マトリックス表

単純な入力値の組み合わせや仕様がやや複雑な場合分けなどのケースに。

ここはやはりExcelの出番ですかね・・・

修正したポイント

主に修正した部分などのgitの差分など。

パフォーマンスの改善など

SQLがらみのものだった場合、before,afterを書いておくと改善度がわかりやすいでしょう。

-ドキュメント作成
-

執筆者:


comment

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

関連記事

no image

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

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

no image

障害報告などでの伝える情報の視点

障害の重要度(後続タスクにブロックがあるかいなか)、調査原因(仕様不理解、設計考慮もれ、ケアレスミス)、影響度(画面単位などで) 障害が起こっているデータ(あるいはスクショなどで伝えられるか) 再現プ …

no image

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

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

no image

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

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

no image

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

基本設計書で気をつけるポイントなど。 要件が決まっており、処理の遷移や流れなどを知る時に、便利なのがシーケンス図だと思います。 アジャイルでもざっくり処理の流れを書いておけば、認識合わせに大分役立つは …