skillup

技術ブログ

ドキュメント作成 プロジェクト管理

ドキュメント作成(要件定義〜設計)のポイントについて

投稿日:2021年6月27日 更新日:

4月から新しいプロジェクトが始まり仕事がドキュメント作成(要件確認書、基本設計、詳細設計)などをしております。この仕事自体が自分にとってあまりなじみのないものだったので、そこで思ったことなどを。

要件確認書

対象者:顧客

目的:システムの全体図やできること、機能一覧、大まかな画面遷移など。

  • 現在、どんな悩みを持っていて、それをシステムでどう解決したいか
  • ユースケースの具体的なヒアリング
  • システムの図解、ざっくりとした処理フロー
  • 顧客との認識齟齬を防ぐのが目的
  • システムに関わる作業関連者のピックアップ
  • データ連携などをどう行うか(テキストデータ?DBアクセス?API?)

基本設計書

対象者:顧客&詳細設計担当者

要件定義〜詳細設計をつなぐ大まかな処理フローの記載

  • 要件が決まっている段階での具体的な処理フローを記載する
  • 具体的にいうとシーケンス図(DBと書くビジネスロジックの結びつきなど)など。画面があればざっくりとした画面遷移
  • 大まかな処理フロー(DBアクセスと他システムへの連携)
  • 新規技術の実現可能性についての調査

詳細設計書

対象者:開発者

プロジェクトごとに粒度の違いはあれど、プログラムを組む人が処理の判断材料にするもの(内部の方が見て判断材料にするもの)

  • 具体的な画面遷移やモックなど
  • 詳細な処理フロー(システムごとのDBアクセス)
  • リレーションの取得方法とデータ連携について
  • エラーハンドリング
  • APIであれば、InパラメータとOutパラメータ

文書作成において

  • wordであれば箇条書き、アウトライン機能、をフル活用する
  • ドキュメントを作る前に決定すること
  • 箇条書きのフォント、サイズ、ページ改行などに注意(HTMLなどを決めるときのように大きさをすでに決めてしまう)
  • 載せる部分の画像幅などの統一に注意(目分量ではなく、プロパティで設定すること)

-ドキュメント作成, プロジェクト管理
-

執筆者:


comment

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

関連記事

no image

エンジニアの評価指標の策定について

営業の方であれば、月間の売上以外に新規の見込み数や、見込み客でも確度別の分類数など様々な指標で評価されることが一般的だと思います。 これらは「結果」に対する指標なのですが、それ以外でも見込み客に対する …

no image

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

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

no image

テスト項目の作り方(縦項目について)

テスト項目の作り方について。 単体テスト書のレビューをしていて、なるべく効率的に網羅的にできるテスト仕様書の作成について。 納品物としてではなく、開発の高速化と品質をあげるためのテスト仕様書を。 Co …

no image

30分で完成! テーブル定義書&ER図 自動作成

現在携わっているプロジェクトでテーブル定義書やER図を作成することに。 えーこういった資料の特徴として、 年月を経るごとに本番との差分ができてしまい、結局だれも見ない・・・なんてことになりがちですよね …

no image

小〜中規模程度のWEBアプリ作成で気をつけるべきこと

初見の処理系(ライブラリ操作)などは休日などで最小パターンを確認しておくこと。実務で何時間も悩むと非常にストレスがたまる テーブル設計命。あとで終えるようにトレースができるような値を入れておくこと。 …

アーカイブ