Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
Design Doc のすすめ / The Importance of Design Docs
Search
Akira Kuriyama
June 10, 2024
Technology
0
110
Design Doc のすすめ / The Importance of Design Docs
Akira Kuriyama
June 10, 2024
Tweet
Share
More Decks by Akira Kuriyama
See All by Akira Kuriyama
コンテナ脆弱性修正をRenovate,Dependabotのように行う / Fix Container vulnerabilities on CICD
sheepland
2
260
Docker Build Cloudを導入してコンテナイメージビルド時間を80%削減した話 / Speeding Up Container Builds with Docker Build Cloud
sheepland
0
68
Datadogのグラフにデプロイタイミングを表示する / deploy timing on datadog graph
sheepland
1
390
英語学習の始め方 / How to start learning English
sheepland
0
100
Other Decks in Technology
See All in Technology
エンジニア向け会社紹介資料
caddi_eng
14
270k
塩野義製薬様のAWS統合管理戦略:Organizations設計と運用の具体例
tkikuchi
0
310
Bluesky 2019〜2022
yamarten
1
120
全社を巻き込んだ業務オペレーション改善と、それは事業成長に貢献しているのか?を実感した話
marroooon
0
130
Amazon CloudWatchで小さく始めるWebサービスのオブザーバビリティ / How to start Observability for Web Sevices with Amazon CloudWatch
sms_tech
3
180
Rist_Meetup_Kaggleは業務の役にたつ - ビジネスコンテンツ情報を活用する BtoB 事業編 - / rist-meetup-20241012
taro_masuda
0
280
プロダクト開発の貢献をアピールするための目標設計や認知活動 / Goal design and recognition activities to promote product development contributions.
oomatomo
5
1k
Grafana エコシステムの活用事例 on ABEMA
tetsuya28
5
710
AWS Lambda と Amazon SQS で「わかった気になれる」FreeRTOS 入門
soracom
PRO
2
140
多数のWebサービスをECS/Fargate構成で効率よく構築・運用するなら copilot-cli
interu
2
170
20241015 Toranomon Tech Hub#1 Service Catalog使ってみた
hiashisan
0
210
とある事業会社にとっての Kaggler の魅力
hakubishin3
7
1.5k
Featured
See All Featured
How STYLIGHT went responsive
nonsquared
95
5.1k
Rebuilding a faster, lazier Slack
samanthasiow
79
8.6k
Pencils Down: Stop Designing & Start Developing
hursman
119
11k
Automating Front-end Workflow
addyosmani
1365
200k
The Language of Interfaces
destraynor
154
24k
Designing for Performance
lara
604
68k
Navigating Team Friction
lara
183
14k
Speed Design
sergeychernyshev
23
540
A Modern Web Designer's Workflow
chriscoyier
692
190k
Save Time (by Creating Custom Rails Generators)
garrettdimon
PRO
26
700
Mobile First: as difficult as doing things right
swwweet
222
8.9k
Templates, Plugins, & Blocks: Oh My! Creating the theme that thinks of everything
marktimemedia
26
2k
Transcript
Design Doc のすすめ Akira Kuriyama
03 01 02 04 Table of contents Design Docとは? どんなふうに
書くの? Design Docの利点 Design Docへの 疑問
03 01 02 04 Table of contents Design Docとは? どんなふうに
書くの? Design Docの利点 Design Docへの 疑問
Design Docとは? Design Docsは、開発前に作成するドキュメントで、高レベルな実装戦略や設 計の決定事項をまとめ、トレードオフを考慮した文書。 ドキュメントベースで議論することで、変更の背景や方針をレビュアーに理解し やすくするメリットがある。
書く前 書いた後 なんか難しそう… 書くの面倒そう… 最高! とてもよいツール!!
その前に…
こういうことはありませんか? その1: PRレビューが難しいケース でかいPRが急に来た…。 背景や課題がよく分からない な。 他にも解決方法ありそうだけど なんでこの方法選んだんだろう 。 もういいやApproveしちゃお…
こういうことはありませんか? その2: 大きな手戻りが発生するケース もうすぐでリリースできそう! そういえば◦◦のケースって考慮さ れてるっけ? (あ、抜けてた…。設計からやり直し だ…) もっと早く言って
こういうことはありませんか? その3: 中々設計レビューが通らないケース 設計書を書きました!レビューお願いします! そもそも目的ってなんだっけ? ログってちゃんと保存してる? 他にもBっていうイケてるツールあ るんだけど使わないの? セキュリティって大丈夫なの? マジ病む…
こういったケースを Design Docを書くことで防ぐ ことが出来ます!! ※LTなので断言口調ですが、実際にはその時の状況、執筆者の筆のノリ具合、 今いる世界線、その日の体調によります。
03 01 02 04 Table of contents Design Docとは? どんなふうに
書くの? Design Docの利点 Design Docへの 疑問
どうやって書けばいいんだろう Design Docsは設計書や仕様書などの厳格なドキュメントと違って、 ざっくりしたドキュメント。 また、実際にDesign Docをどのように記述すべきかという 明確な指針はありま せん。 なので、いくつかのベストプラクティスやこんな感じに書くのがいいよねというも のがあります。
どうやって書けばいいんだろう Design Docに書くと有効な項目たち(=テンプレート)を紹介します。 しかし、テンプレートの項目を常にすべてを埋める必要はありません 。 あくまでテンプレートなので不要な項目の削除、項目の追加は自由 です。 議論したい箇所が明確である場合は、 特定の項目だけを記載するなどでも問 題はありません。
つまりどういうこと だ!はやく”答え”を 教えてくれ!!
Design Doc Template https://docs.google.com/document/d/1VR2fMiGhs0Out4ZfkE8vqWUEIZ4uI nPztsW7gUK09xE/edit?usp=sharing
03 01 02 04 Table of contents Design Docとは? どんなふうに
書くの? Design Docの利点 Design Docへの 疑問
Design Docの利点 • チーム内で問題や課題を共有でき、認識合わせ ができる • 設計上の問題を早期に特定することで、 手戻りが少なくなる • フォーマットが統一されているため、
見落としがちなポイントを設計時点で検討 できる • コードには現れない、Why not (なぜ別の方法をしなかったのか? )を議論できる • 人事評価に使える(自分の成果物としてアピールしやすい)
03 01 02 04 Table of contents Design Docとは? どんなふうに
書くの? Design Docの利点 Design Docへの 疑問
疑問 その1 Design Docはいつ書けばいいの? まずDesign Docs自体を作成することは、開発を進める上ではオーバヘッドになります。 そのため基本的には、Design Docsを作成するかどうかの決定は、「Design Docsを作成するこ とに伴う労力が作成のメリットを上回るか」というトレードオフで判断
する。 例えば • いくつかの実装案が考えられる、かつどれがベストなのか決めるのが困難なとき • 技術的であったりドメイン的に新規のものや慣れていないものを扱うとき • シニアエンジニアにアーキテクチャの考察をしていただきたいとき
疑問 その2 Design Docをメンテナンスする必要あるの? Design Docで書いたソフトウェアがまだリリースされていないなら Design Docを更新したほうがよ い。 リリース後は更新しなくてよい。
質の高いレビューがされることで精度が高い設計を行うことに重点を置く。 Architecture Decision Records(ADR)のような、その時の意思決定の過程を残すためのツールと して使うのがよいでしょう。
疑問 その3 詳細設計まで書く必要がある? 必ずしも書く必要はない。 ソフトウェア設計における仕様書や設計書とは別物。
書いてみての個人的な感想 • 必要な観点がリストアップされているのでそれに沿って書けば考慮漏れを防ぐことが できる • 項目に沿って書けばいいので非常に楽 • 自身の思考が整理される • 何回か書くことで、いつDesign
Docを書くべきかが掴めそう • テックブログに流用しやすそう
参考 • Google でのデザイン ドキュメント • How to write a
good software design doc • メルカリShopsでのDesign Docs運用について | メルカリエンジニアリング • Design Docs への思い • GoogleのDesign Docsから学ぶソフトウェア設計 - Qiita • 安全安心にソフトウェア開発を行うための Design Doc導入ガイド|面川泰明| note • 【メモ】良いDesign Docs(Software Design Document)を書くためのリソース集