1
0
しくじりエンジニア!私みたいになるな!
Qiita Engineer Festa20242024年7月17日まで開催中!

作成するドキュメントが多すぎ問題について立ち止まって考える

Last updated at Posted at 2024-07-15

課題意識

作成するドキュメントが多すぎる。
本当にコレって必要なの?と思うことがある。

プロジェクトにおける成果物を文書化するケースとしないケースをもっと明確にしたい。
文書化する範囲としない範囲はどのように画定するのがよいだろうか?

文書化するかどうかを決めるにあたって考慮するとよい要因を記載した。このソースは、参考資料に記載する。

文書化するかどうかに影響する要因

1. プロジェクトリスク
例えば、文書化して合意をとらないと後で「言った言わない」論争になるリスクを考慮する、あるいは、文書化してはいけないものもある

2. ドキュメントがプロジェクトに提供する「付加価値」
本当に、「付加価値」はあるか?
あるならば、どれくらいの量か?
を明確にしよう。ないor少ない、なら文書化しない方が時間の損失が少ないかもしれない。

3. 開発手法または使用するアプローチ
開発手法とは、ウォーターフォール型か、アジャイル型か、など。アジャイルアプローチでは、必要最小限の文書化を目標にする。

4. 成果物の間にトレーサビリティが必要か否か
トレーサビリティとは、要素間が対応づけられており、遡及できること。例えば、どのテストケースが、どのシステムの要件や仕様と対応づいているかを遡及できるようになっているか、などが相当する。テストケースが適切に要件をカバーしているかを知りたいならば、トレーサビリティが必要であり、テストケースの文書化が望ましいだろう。

さいごに

成果物を文書化するかは、上記の4点を考慮しつつ判断しましょう。プロジェクトに無駄なドキュメントが減り、本当に必要なタスクに時間を割けますように!

参考資料

ISTQB®テスト技術者資格制度
Advanced Level シラバス日本語版
テストアナリスト
Version 3.1.1.J03
p.20

1
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
1
0