わたし流・よわよわDesignDocのテンプレート
DesignDocとは、ざっくり言うと「開発者目線で書かれたシステムに関するドキュメント。DesignDocを作ってから開発するし、メンテする時もまずはここからするもの」だと思っております。詳しくはもっと詳しい人の記事が沢山あるので調べてみて下さい。よわよわ。
テンプレートは色々世の中に出回っていますしgoogleが公開してくれていたりするんですが、毎回検索するの面ど……ゴホゴホ、大変なので、自分用のテンプレートだけここにまとめておきます。
# タイトル
## 目的
このシステムを開発する目的。実現したい目標。
## 背景
なぜこのシステムを作る必要があるのか。
## 概要
システムの構成について
### リポジトリの場所
### ソースコードについて(コードを読めば分かることは書かない)
#### 各クラスの概要
### データベースについて
### 既知の問題点
## 誰が関わっているか
## 更新履歴(更新日・内容・担当者)
ほんとに超最小限のよわよわDesignDocです。(これに実際書き込んでいくとクラスの概要の辺りとかが結構な分量になるんですが)
多分世間一般のDesignDocに比べて大幅に足りないと思うんですが、小規模な(関わる人数が一桁の)プロジェクトなら、これくらいあればまあなんとかボチボチやれますよということで……合い言葉は「無いよりマシ」。
この記事が気に入ったらサポートをしてみませんか?