skillup

技術ブログ

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

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

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

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

要件確認書

対象者:顧客

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

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

基本設計書

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

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

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

詳細設計書

対象者:開発者

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

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

文書作成において

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

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

執筆者:


comment

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

関連記事

no image

テスト対策(単体テスト、結合テスト、総合テスト)

単体テスト、結合テストで発生した障害の分析(どんな障害が起こって、原因はなんで、再発防止に関してどうすべきか)なんかをやってます。 個人的に各フェーズで留意する点などを。 Contents1 共通2 …

no image

KPT法について

プロジェクトを進めていく上では、いいこと、悪いこと様々あるかと思いますが、 よかったものは続け(Keep)、 問題点に関しては直視し(Problem)、 改善を試みる(Try) のが良いかと思います。 …

no image

総合試験でのテスト内容など

現在のプロジェクトが総合テストの段階に入っておりますが、総合テストで見るべき観点など。実際に自分らはテストしてなくて、障害があったときの対応をしているのですが(汗) Contents1 シナリオテスト …

no image

レビューについて

以前、コードレビューそのもののポイントについてはコードレビュー時のポイントでまとめましたが、レビュー自体の体制の注意点やそこでの気づきなど。 Contents1 目的2 定型的なものはチェックリストを …

no image

ドメイン決定&業務フローとの対応確認

Contents1 ドメイン決定2 業務フローとの対応2.1 実際の業務とエンティティ、画面の遷移2.2 ドメインのCRUD分析 ドメイン決定 業務フローを抽出し、エンティティを抽出した段階で次にドメ …

アーカイブ