ログラスを支える設計標準について / loglass-design-standards

設計カンファレンス extends OOCの発表資料です。

Transcript

1. 1 ©2024 Loglass Inc. ログラスを支える設計標準について 2024.3.29 設計カンファレンス extends OOC Yuta Muramoto / Loglass, Inc.
2. 2 2 ©2024 Loglass Inc. 株式会社ログラス 開発部 エンジニア 村本 雄太 / Yuta Muramoto (@urmot2) 自己紹介 2021年11⽉にログラスにソフトウェアエンジニアとして⼊社。 Loglass経営管理の開発に2年ほど携わり、 現在は新規事業であるLoglass⼈員計画の開発に勤しんでいる
3. 3 ©2024 Loglass Inc. 設計標準とは？
4. 4 ©2024 Loglass Inc. 設計標準とは何か？
5. 5 ©2024 Loglass Inc. ex ・テストコードの書き方 ・ドメインオブジェクトの書き方 ・ドメインサービスの書き方 ・バリデーションの書き方 ・フロントエンドのAPIコールの仕方 設計標準 より良い設計の追求を目的とする ・理由がなければ、基本的に従う ・設計時やレビュー時に参照される ・より良い設計案がされば更新される コーディング規約 品質を均一化することを目的とする ・必ず従うべきもの ・違反したらRequest changesにする ・必要に応じて更新する コーディング規約との違い ex ・命名規則 ・スタイル規約 ・ディレクトリ構造 ・クラス設計 ・DB設計
6. 6 ©2024 Loglass Inc. コレクション 設計標準の事例紹介
7. 7 ©2024 Loglass Inc. 関数 設計標準の事例紹介
8. 8 ©2024 Loglass Inc. サーバーサイドテストコード設計標準 設計標準の事例紹介
9. 9 ©2024 Loglass Inc. サーバーサイドテストコード設計標準 設計標準の事例紹介
10. 10 ©2024 Loglass Inc. 設計標準の運用
11. 11 ©2024 Loglass Inc. 設計標準の運用
12. 12 ©2024 Loglass Inc. 設計標準の運用 プロポーザルを書いて Slackで投げかける
13. 13 ©2024 Loglass Inc. 設計標準の運用 ポストモーテムの再発防止策として
14. 14 ©2024 Loglass Inc. 設計標準の効果
15. 15 15 ©2024 Loglass Inc. 開発組織の資産になる 設計標準の効果 1. 設計で迷う時間を省くことができる ◦ ⾃分が⼀度迷ったところは、他の⼈も絶対迷う ◦ そういうときに既に答えがあると、迷う時間を短縮できる 2. 良い設計が伝播していく ◦ 設計標準がないと、良い設計もその場限りのものになってしまう ◦ 設計標準に追加することによって、コードへ反映しようとする圧⼒がかかる 3. 現在の設計の意図がわかる ◦ なぜこのようになっているのか？がドキュメントとしてまとまっている ◦ オンボーディングの役に⽴つ ◦ 同じ轍を踏まない
16. 16 ©2024 Loglass Inc. 今後の課題
17. 17 ©2024 Loglass Inc. うまくいってるいるように話したけど ... 今後の課題 • ここ1年だけでも開発組織が急拡⼤している → 来年はもっと増える ◦ 開発者 → 1.5倍 ◦ チーム数 → 2倍 • 設計標準の重要性は増していくが、今の運⽤⽅針だとドキュメントの維持が⼤変 ◦ ex. 古いドキュメントの更新、バラバラなフォーマット、検索性、etc.. • 仕組み化と浸透施策が今後の課題 ◦ ADRのテンプレを作って運⽤を回す ◦ 各チームにアンバサダー的な⼈を置く