skillup

技術ブログ

ドキュメント作成

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

投稿日:

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

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

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

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

前提となるデータ

これが一番大事です。

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

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

マトリックス表

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

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

修正したポイント

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

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

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

-ドキュメント作成
-

執筆者:


comment

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

関連記事

no image

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

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

no image

ドキュメント作成について

アプリやプロジェクトのドキュメント作りですが、時間が立ったり、複数人での開発を行うと 情報の漏れや抜けが非常に多くなる 本番との差分ができる 一部の人しか更新しなくなる 似たようなドキュメントがあちこ …

no image

APIに関して

RESTAPIのルーティングで気をつけることなんぞを。 直近のプロジェクトではRESTAPIを作ることが多かったんですが気をつけることなんぞを。 Contents1 仕様書はソースから2 ツール3 命 …

no image

コード静的解析ツールを使った際の気づきなど

最近のプロジェクトでコード静的解析ツール(phpcs,phpmd)を使った際の気づきなど コードを書きながら常時エディタがチェックするタイプのものでないとまず無理(保存するたびでも無理だし、コミット時 …

no image

バッチスクリプトで気をつけたい点

実務でバッチ処理を作る際に気をつけるべきと思ったこと。 基本的にエラーをいかに捉えていかにログに吐くかを最初に考える。まずはエラーありき。失敗するもの、想定した値がこない、あるいは値がないを前提として …