実際のチーム開発の現場において、どのようなドキュメントを作ればよいか悩みますよね。
この記事では、開発生産性の向上につながるおすすめのドキュメント(仕様書、資料)10選を紹介します。
前提として、フロントエンド(Web画面)とバックエンド(データ処理)から構成されるようなWebアプリ・Webサービス開発を想定しています。
もちろん、開発の事前にしっかりとした製品企画(製品企画書)がある前提です。
■必要なドキュメント10選
①画面設計書
②サイトマップ
③スタイルガイド
④コーディングルール
⑤機能一覧書
⑥API仕様書
⑦テーブル定義書
⑧ER図
⑨インフラ構成図
➉フローチャート
■ドキュメントが必要な理由
- プロジェクトの成否を決めます。
- ドキュメントがないと後で困ります。
- 人が増えたり変わった時に、一から説明する必要がなくなります。
■まとめ
プロジェクトのスピード感にもよりますが、プロジェクトのどこかのタイミングで作成した方がベターです。プロジェクトをスケールする上で助けにもなります。
■参考
この記事は、「セイト先生のWeb・IT塾」の動画を参考にさせて頂きました。
本動画で紹介されていた内容を、自分なりに備忘録としてまとめました。
■参考元のYouTube動画
アプリを設計する上で必要な仕様書・ドキュメント10選【PM必須】
以上です。