skillup

技術ブログ

ドキュメント作成

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

投稿日:

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

要件確認書

対象者:顧客

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

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

基本設計書

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

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

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

詳細設計書

対象者:開発者

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

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

文書作成において

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

-ドキュメント作成
-

執筆者:


comment

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

関連記事

no image

テスト分類について

一般的なテスト工程での分類や個人的に大事だと思うこと Contents1 全プロセス共通1.1 テストデータ作成バッチ1.2 ローカル、開発、ステージング、本番の分岐2 PT(プログラムテスト)、単体 …

no image

EntityとValue Objectについて

ドメイン駆動設計に関して勉強しています。参考にしている本がやたら難しいんで、トピックごとにネットで調べつつ進めていくのがよさげです。 今回はEntityとValueObjectについて Content …

no image

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

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

no image

Gitの活用に関して

今回はgitの技術的なことではなく、主に運用に関して。超基礎的なことですが、チームで開発する場合にはルールを徹底してないと混乱をきたします。 Contents1 ブランチを追加機能ごとにきる2 バグに …

no image

新しいプロジェクトに入った時にやること

新しいプロジェクトに入った時に最初にすべきことややっておくことなど Contents1 仕様理解編1.1 ユーザーの行動遷移の理解1.2 キー系のデータの理解1.3 データグルーピング1.4 サンプル …