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
設計という共通認識
Search
yjszk
October 20, 2023
0
630
設計という共通認識
yjszk
October 20, 2023
Tweet
Share
More Decks by yjszk
See All by yjszk
DMARCレポートの可視化ツールの作成と運用した結果
yjszk
0
50
リブセンスのソリューションチームについて
yjszk
0
610
トイル撲滅から始める改善手法とその結果
yjszk
0
1.6k
LT駆動生活
yjszk
1
880
Featured
See All Featured
Code Reviewing Like a Champion
maltzj
518
39k
What's new in Ruby 2.0
geeforr
340
31k
Happy Clients
brianwarren
96
6.6k
Creatively Recalculating Your Daily Design Routine
revolveconf
215
12k
Building a Scalable Design System with Sketch
lauravandoore
458
32k
A Modern Web Designer's Workflow
chriscoyier
690
190k
Raft: Consensus for Rubyists
vanstee
135
6.5k
A Tale of Four Properties
chriscoyier
155
22k
Facilitating Awesome Meetings
lara
49
5.9k
Put a Button on it: Removing Barriers to Going Fast.
kastner
58
3.4k
Scaling GitHub
holman
458
140k
Pencils Down: Stop Designing & Start Developing
hursman
118
11k
Transcript
設計という共通認識 クラウド移⾏で感じた、読まれるPR 2023.10.20 インフラグループ 鈴⽊裕⼆ Copyright © Livesense Inc.
0. 自己紹介 Yuji Suzuki(@yjszk666) Copyright © Livesense Inc. • 株式会社リブセンスでSRE的なしごとしてます
◦ 採用広報(ブログ運営etc..)もしてる • 趣味:公営競技の鑑賞、ホームは平塚競輪 • 略歴 ◦ 大学無内定卒業→フリーター ▪ 占い師とか出版社で校正とか色々 ◦ 金融SE ◦ 夜勤オペレータ ◦ SIer ◦ コンサルでSE ◦ リブセンス • 写真は青森競輪のあおいもりんちゃん ◦ 推し
移⾏でも設計書いてますか? クラウド移⾏で気づきを得たので 共有したいと思います Copyright © Livesense Inc.
1 2 3 4 ⾃分しかわからないPR 共通認識を作ろう PRを⾒てもらえるようになるTips まとめ Copyright ©
Livesense Inc.
1. 自分しかわからないPR - オンプレの社内認証システムをECS Fargateに移す仕事がありました - チームメンバーに現⾏の状態と、これから作るものの共有をしていませんでした - その状態でいきなりステージングを作りました -
レビュアーからしたらよくわからない⼤きいPRが突然来ました - ⾃分しかわからない - 結果、誰もレビューせず放置されてました 設計を共有せずにステージングを作るPRを出した Copyright © Livesense Inc.
1. 自分しかわからないPR - 共通認識が揃っていないので、確認にコストがかかる - よくわからないものはレビューされず、タブをそっ閉じされる - 共通認識ってなんだ? - どうしてをそれをするのかという設計、意図などの共有
- これらの共有をしていなかったのがダメだった レビュアーと共通認識が揃っていないと読まれない Copyright © Livesense Inc.
実際のPRを ⾒てみましょう Copyright © Livesense Inc.
Copyright © Livesense Inc.
移⾏は状況が⼤きく変わる、コミュニケーションコストが⼤きい Copyright © Livesense Inc. - 現状(オンプレ)と移⾏後(クラウド)の認識を共有しつつ進める必要がある - 現状と移⾏後、2つある -
つまり新規に作るより単純に2倍コストがかかる - コードの共有の前に設計の共有をした⽅がいい - 設計という共通認識を共有することで、コミュニケーションコストを⼩さくする 2. 共通認識を作ろう
経緯を資料として残そう Copyright © Livesense Inc. オンプレの何某をマネージドサービスに移⾏した…etc - こういうのはインターネットにいくらでも情報があるし⽂書化しないでもいいか… - 技術的なことは書かずとも、経緯は書いたほうがいいです
- 議事録から経緯だけ抜粋でもいい 移⾏に⾄った経緯、関係者の考え、何故そうなったのかを知るのは今いる⼈しかいません 「ADR 設計」で検索すると超いいです、今移⾏しているサービスではADRを作っています ※ADR (Architectural Decision Records)とは、特定のアーキテクチャ決定を記述した短いテキストファイルのこと 2. 共通認識を作ろう
3. PRを見てもらえるようになるTips 概要に設計が書いてあるPR Copyright © Livesense Inc. - ドキュメントへのリンクが概要に貼られている -
ドキュメント書くまでもないなら、概要に設計が書かれている - 図があると分かりやすい - GitHubがmermaid対応しているので、GPTに書かせてもいい - ロジックがあるなら… - ロジックを⽇本語で簡潔に説明 - パラメータ変更や追加なら… - 移⾏だとPRが⼤きくなりがち - 既存とのdiffがあると親切 - nginxのconf200⾏を複数ファイルとか読めない
No ビッグバンPR 3. PRを見てもらえるようになるTips Copyright © Livesense Inc. - 1つのPRで複数機能を追加すると読む⼈が⾟い
- PRを機能ごとに分割する - ちいさくてかわいいPR - 例えばTerraformでECSを作るとすれば… - ECR/IAMロールから作る - どんなコンテナ/権限を使うかで後続作業がチョットわかる - タスクロールとタスク実⾏ロールのPRが来たら… - 次にECSがくるのがわかる - 既存実装のコピーなら、どこどこのコピーと明記してdiffを貼り付ける - stg作った後の本番環境etc…
実際のPRを ⾒てみましょう Copyright © Livesense Inc.
Copyright © Livesense Inc.
4. まとめ - 設計や実装意図の共有をして、共通認識を作ろう - PRはちいさくかわいくする Copyright © Livesense Inc.
None
None