skillup

技術ブログ

ドキュメント作成

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

投稿日:2020年11月21日 更新日:

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

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

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

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

前提となるデータ

これが一番大事です。

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

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

マトリックス表

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

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

修正したポイント

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

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

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

-ドキュメント作成
-,

執筆者:


comment

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

関連記事

no image

テスト分類について

一般的なテスト工程での分類や個人的に大事だと思うこと Contents1 全プロセス共通1.1 テストデータ作成バッチ1.2 ローカル、開発、ステージング、本番の分岐2 PT(プログラムテスト)、単体 …

no image

開発時最低限必要かつ有用なドキュメントに関して

ウォーターフォール型の開発をかれこれ1年近くやっております。 自分がやってきた仕事とすると別職種に近いようなイメージでしたが、得ることも多かったため、ここに記しておこうと思います。 以前書いたことの記 …

no image

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

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

no image

テスト環境のデータ作りに関して

単体テスト以降の環境ですとテストのデータを作ることがなかなか大変だと思います。マスタなどはそのままもらうこともあると思いますので、主にトランザクションデータについて。 以前もこのネタに関しては色々書い …

no image

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

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

アーカイブ