skillup

技術ブログ

ドキュメント作成

設計業務での改善点など

投稿日:2021年7月4日 更新日:

比較的大規模なプロジェクトの設計段階で思ったことなど。

明確なゴールを決める

会議や打ち合わせのたびにポツポツと問題点が出てきてしまい、設計などがひっくり返る、なかなか決まらないことが多い場合、ユースケースから満たすべきテストケースを割り出し、そのテストケースを満たすことをゴールと考えると良いのではないかと思います。理想論かもしれないが・・・・

プログラムを造らない段階でもデータイメージは想定することが可能なため、テストケースの想定は可能なはず・・。

理想論を追求しすぎるといつまでたっても決まらないことが多いため、ある程度現実的な案を考えましょう。

どうしたら「ゴールになるのか」という点を明確に設けるように。

レビュー時はチェックリストを設ける

レビューのたびにポツポツと問題点が出てくる場合、仕様、ドキュメントの体裁的なことに関して、チェックポイントを決めておくと内容に差異がなくなると思います。

チーム内での情報の情報共有方法を考える

チーム内での仕様の認識に齟齬が出るのは仕方ないかもしれませんが、各人でレビューをしあう、説明をし合うなどして、一人の人間が仕様を握っているということがないようにしておくと良いと思います。

データのテストパターンが一番現実的だと思います。

出来るだけ情報の同期ができる便利なツールを使う

1つの資料の情報の変更が、別の資料にも影響されるような資料を作るのが良いでしょう。

Excelであればなるべく関数やマクロを使い、手作業での修正量を押さえることが必要。(1つの修正で何箇所も修正が発生するような事態をなるべく避ける)

開発時と連携できるような資料がベスト(コードからドキュメントが開発できるなど)

-ドキュメント作成
-

執筆者:


comment

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

関連記事

no image

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

前回に引き続き、大事だと思ったこと。一部単なるフレームワークの作り方的な内容になっているかも。 Contents1 テンプレート共通化2 バリデーション3 ログ出し4 異常系の処理5 新規プラグイン+ …

no image

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

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

no image

ER図作成ツールについて(Mac版)

ER図作成ツールについてMacで色々と調べましたので、メモを。 フリー限定で。 ちなみにwindowsを使っていればA5:SQLが一番使えるかと思います。 以前も下記リンクで説明させていただきました。 …

no image

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

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

no image

新アプリの本番環境デプロイについて

新しく作ったWEBアプリを本番配置しようとしたんですが、何度もやっているはずの処理がいざやろうとするといろいろと手間取ってしまい、1時間近くかかりました。 容量悪いなーと思いつつ、こういった行為はなる …