簡単に自己紹介
しがないweb広告系エンジニア(社内SE)です。
私は普段backlogを利用していますので、それを前提にしています。
「ドキュメントって何を書けばいいの？」と悩んでいる新卒エンジニアの方の参考になれば嬉しいです。
以下フォーマット。
概要
- 何の機能か端的にまとめる
要件定義
- 依頼者と要件のすり合わせをしながら記述
- 開発する前とした後で何がどう変わっていれば良いのかを明らかにする
現状調査
- 関連するコード箇所、データの所在、注意点等をまとめる
- テーブルのリレーションやuniqueインデックスが貼られているカラムなども書いておくと良い
設計
** 開発方針 **
- どのような開発を行うか
- 部分的な改修か根本的な改修か
- その方法を選んだ根拠や背景
** 作成ファイル **
- path/to/file
- path/to/file
作成table
- table_name
工数見積もり
| No. | 大項目 | 中項目 | 内容 | 工数(h) |
|---|---|---|---|---|
| 1 | ||||
| 2 | ||||
| 3 | ||||
| 4 | ||||
| 5 | ||||
| 6 | ||||
| 7 | ||||
| 8 | ||||
| 9 | ||||
| 10 | ||||
| 合計(h) | 0 | |||
| 合計(day) | 0 |
開発メモ
- 開発中に気になった点、つまずいた点などメモ
テスト項目/テストコード
- path/to/file
- path/to/file
| No. | 大項目 | 中項目や権限 | 内容 | 結果 |
|---|---|---|---|---|
| 1 | ||||
| 2 | ||||
| 3 | ||||
| 4 | ||||
| 5 | ||||
| 6 | ||||
| 7 | ||||
| 8 | ||||
| 9 | ||||
| 10 |
- ローカル環境テスト
- テスト環境テスト
- 本番環境テスト
以下コピペしやすいようmd形式
## 概要
* 何の機能か端的にまとめる
## 要件定義
* 依頼者と要件のすり合わせをしながら記述
* 開発する前とした後で何がどう変わっていれば良いのかを明らかにする
## 現状調査
* 関連するコード箇所、データの所在、注意点等をまとめる
* テーブルのリレーションやuniqueも書いておくと良い
## 設計
** 開発方針 **
* どのような開発を行うか
* 部分的な改修か根本的な改修か
* その方法を選んだ根拠や背景
*
** 作成ファイル **
* path/to/file
* path/to/file
**作成table**
* table_name
## 工数見積もり
| No. | 大項目 | 中項目 | 内容 | 工数(h) |
|-----|--------|--------------|------|------|
| 1 | | | | |
| 2 | | | | |
| 3 | | | | |
| 4 | | | | |
| 5 | | | | |
| 6 | | | | |
| 7 | | | | |
| 8 | | | | |
| 9 | | | | |
| 10 | | | | |
| 合計(h) | | | | 0 |
| 合計(day) | | | | 0 |
## 開発メモ
* 開発中に気になった点、つまずいた点などメモ
## テスト項目/テストコード
* path/to/file
* path/to/file
| No. | 大項目 | 中項目や権限 | 内容 | 結果 |
|-----|--------|--------------|------|------|
| 1 | | | | |
| 2 | | | | |
| 3 | | | | |
| 4 | | | | |
| 5 | | | | |
| 6 | | | | |
| 7 | | | | |
| 8 | | | | |
| 9 | | | | |
| 10 | | | | |
- [ ] ローカル環境テスト
- [ ] テスト環境テスト
- [ ] 本番環境テスト