skillup

技術ブログ

ドキュメント作成

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

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

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

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

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

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

前提となるデータ

これが一番大事です。

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

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

マトリックス表

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

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

修正したポイント

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

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

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

-ドキュメント作成
-,

執筆者:


comment

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

関連記事

no image

業務管理アプリの商品コードに関して

一般的な業務管理アプリを作っていると商品や顧客などもオートインクリメントのidではなく、独自の仕様で決められた「商品コード」などを持っていることが一般的です。 昔通販がらみのシステムを使っている時も商 …

no image

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

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

no image

ファジープロジェクト対策 その1

5月ぐらいから着手していたプロジェクト(顧客管理ソフト)が終焉を迎え、検証段階に入ったので、記して置きたいことなど。 数ヶ月程度ですが、自分が携わったプロジェクトの中では過去最大クラスのものでした。 …

no image

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

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

no image

外結〜運用フェーズでの気をつけることなど

外結以降のフェーズで注意することなど。(主に障害発生時の原因切り分け) Contents1 エラーの情報伝達に関して2 ログの見方3 デプロイ4 タスクコミュニケーション(タスク管理ツール)5 チャッ …

アーカイブ