skillup

技術ブログ

ドキュメント作成

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

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

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

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

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

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

前提となるデータ

これが一番大事です。

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

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

マトリックス表

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

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

修正したポイント

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

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

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

-ドキュメント作成
-,

執筆者:


comment

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

関連記事

no image

Gitの活用に関して

今回はgitの技術的なことではなく、主に運用に関して。超基礎的なことですが、チームで開発する場合にはルールを徹底してないと混乱をきたします。 Contents1 ブランチを追加機能ごとにきる2 バグに …

no image

テスト仕様書の必要な項目の定義など(横項目の定義)

前回はテストの項目をどのように作るか(分類するか)だったんですが、今回はテスト仕様書などを作る際に必要な項目の定義をまとめてみようかと。 テスト仕様書を作るとしたら前回は縦(バリデーションの組み合わせ …

no image

使える設計書作成に関して

私自身、この仕事を7〜8年やっておりますが、設計書作成については常に悩まされておりました。 設計書のメリット・デメリットとしては以下のようなものですかね。 メリット メンバー間での仕様の認識を統一でき …

no image

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

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

no image

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

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

アーカイブ