エントリーの編集
エントリーの編集は全ユーザーに共通の機能です。
必ずガイドラインを一読の上ご利用ください。
ドキュメントを書くために設計書を作る|Koushi Kagawa
記事へのコメント0件
- 注目コメント
- 新着コメント
このエントリーにコメントしてみましょう。
注目コメント算出アルゴリズムの一部にLINEヤフー株式会社の「建設的コメント順位付けモデルAPI」を使用しています
- バナー広告なし
- ミュート機能あり
- ダークモード搭載
関連記事
ドキュメントを書くために設計書を作る|Koushi Kagawa
私はドキュメントを書く前に、設計書を書いて書く内容をまとめています。 設計書、開発の時には必須で作... 私はドキュメントを書く前に、設計書を書いて書く内容をまとめています。 設計書、開発の時には必須で作成しますが、ドキュメントも同様であった方が色々と便利なのではと思ったのが発端です。 設計書を作成することの利点としてはいくつかありますが、大きくは下記2つだと思っています。 ドキュメントの目的を把握しやすくなる 他のメンバーにタスクをパスしても、文脈が理解できるようになる ドキュメントはできれば少ない方が読む方の負担は減ります。そのため、無駄なドキュメントは極力作らない方が良いでしょう。設計の時点で、ドキュメントの目的を見直すことで、本当に必要なドキュメントなのかを判断することができます。 また、ドキュメントは最後まで書き切ることが一番難しいです。どうしても書ききれなくなった場合、必要なドキュメントは他のメンバーにパスして続きを書いてもらうことがあります。その際に、設計書があることでスムーズな