2017年9月20日水曜日

Design Docとは

プロジェクト成功確率向上の近道とは?(3):残業も減らせる!? 上級エンジニアになるためのDesign Doc超入門 (1/3) - @IT
http://www.atmarkit.co.jp/ait/articles/1606/21/news016.html


表 Design Docに含み得る項目一覧
項目名内容
1*タイトルこのソフトウェアの名称
2*著者名このDocを書いた人
3プロジェクトメンバー開発に参加するメンバー
4*目的このソフトウェアの目的
5要求仕様要求仕様書、機能仕様書などへのリンク(要求仕様の要点を書く場合もある)
6*背景このソフトウェアを開発する背景・経緯など
7既存のものとの相違点既存品があるなら、それとの違いを書く
8関連システム・仕様など関連システムやその仕様書へのリンク
9*ハイレベルアーキテクチャ(アーキテクチャ概要)システム全体を俯瞰した構成図など
10*各パート(モジュール・クラス)の概要各パートの概要・責務・目的など
11*各パート(モジュール・クラス)の内部仕様・処理フローなどデータ構造、アルゴリズムなど
12各パート(モジュール・クラス)の実装場所ソース・ファイル名、実行形式の名称など
13使用例モジュールの利用例が分かるサンプルコードなど
14セキュリティ仕様・考慮事項など想定される問題と、その対処方法などについて
15既知の問題事前に判明している問題・課題などを書く
16*テスト方案どういう観点で何をテストすればよいか、どのようにテストすればよいか
17運用方法運用時のポイント、監視の方法など
18参考文献参考文献へのリンク
19このDocの格納場所リポジトリのパス、ファイルサーバのパスなど
20メモ設計のヒントや気付いた点、関連情報など何でも
21変更履歴このDocについて、いつ・誰が・どのような変更をしたのか履歴を記述

0 件のコメント:

コメントを投稿