PHPerKaigi 2023
LT(5分)

Design Doc の失敗談

app1e_s meihei app1e_s
2

Design Doc とは、開発者がコーディングに着手する前に、ソフトウェア設計の基本的な要点を説明するためのドキュメントです。
新しく追加する機能の設計を Design Doc を用いてドキュメントにしてきましたが、不慣れなうちは質の低い Design Doc を書いて、シニアエンジニアに指摘されてきました。
そんな自分の失敗を振り返る発表をしたいと思います。

話すこと

  • 要約で伝わるようにする
  • Design Doc で Approve を貰うことが目的ではない
  • 体裁が整ったものが良い Design Doc ではない
  • とにかく手を動かす