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
[2023/09/15]ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
Search
tosite
September 21, 2023
Programming
0
480
[2023/09/15]ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
7th長崎QDG
https://nagasaki-it-engineers.connpass.com/event/263690/
tosite
September 21, 2023
Tweet
Share
More Decks by tosite
See All by tosite
[2024/07/11]Guardianとして生まれ変わった俺は攻めと守りの運用で無双する 〜守りの天才が考える、攻めの運用術〜
tosite
0
220
[2024/04/23]tbls活用事例 〜 ビューポイントから データベースを整理してみた話 〜
tosite
0
220
[2022/12/07]この素晴らしいアプリケーションにテストコードを
tosite
0
33
[2022/03/25]コミュニティから学ぶエンジニアリング
tosite
0
270
[2021/12/16]テストコードのないレガシーアプリケーションとの向き合い方
tosite
0
29
[2019/07/27]はじめよう、ニコカレ!
tosite
0
22
[2019/03/23]プルリクとの上手な付き合い方
tosite
0
15
[2018-12-12]ティファニーで転職を〜夏の日の2018〜
tosite
0
27
[2018/09/15]コミュニケーションから始まるアジャイル
tosite
0
27
Other Decks in Programming
See All in Programming
CSC307 Lecture 08
javiergs
PRO
0
330
SRE チーム立ち上げ前に考えたこと・取り組んだこと / Considerations and Preparations Before Establishing an SRE Team
mackey0225
3
320
Prompt FlowによるLLMアプリケーション開発
yuto2000
1
1k
APIのない大学ログインWebサービスをWKWebViewとJavaScriptでアプリ化した話
akidon0000
1
330
コード生成を伴うLLMエージェント - 2024.07.18 Tokyo AI
smiyawaki0820
11
4.1k
Architectures with Lightweight Stores: New Rules and Options
manfredsteyer
PRO
0
100
小さな開発会社を作った理由
polidog
0
1.9k
「2024年版 Kotlin サーバーサイドプログラミング実践開発」の補講 〜O/Rマッパー編〜
n_takehata
2
260
[After Kotlin Fest 2024 LT Night @ Sansan] もっともっとKotlinを好きになる!K2 Compiler Pluginで遊んでみよう!
kitakkun
2
260
AWSでゲームサーバーを運用! Amazon GameLiftのお話
iriikeita
0
200
Terraformテスト入門
msato
0
520
CSC307 Lecture 11
javiergs
PRO
0
240
Featured
See All Featured
Code Review Best Practice
trishagee
58
16k
No one is an island. Learnings from fostering a developers community.
thoeni
17
2.8k
ParisWeb 2013: Learning to Love: Crash Course in Emotional UX Design
dotmariusz
105
6.8k
Scaling GitHub
holman
458
140k
We Have a Design System, Now What?
morganepeng
46
7k
Debugging Ruby Performance
tmm1
71
11k
[Rails World 2023 - Day 1 Closing Keynote] - The Magic of Rails
eileencodes
17
1.5k
Ruby is Unlike a Banana
tanoku
96
10k
Art, The Web, and Tiny UX
lynnandtonic
291
20k
Done Done
chrislema
179
15k
Clear Off the Table
cherdarchuk
89
320k
Fontdeck: Realign not Redesign
paulrobertlloyd
79
5.1k
Transcript
ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜 株式会社マネーフォワード クラウド経費本部 プロダクト開発部 手島 尚人 /
tosite 2023-09-15 7th長崎QDG DEJIMAメッセ長崎
初めまして ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
None
株式会社マネーフォワード クラウド経費本部 プロダクト開発部 バックエンドエンジニア 手島 尚人 / tosite
趣味: キャンプ・登山・料理・ドライブ・温泉 三線 ← New!
福岡から来ました! 前々職の関係で5年ほど長崎に住んでいました ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
JaSST'23 Kyushu の実行委員長やってます! https://www.jasst.jp/symposium/jasst23kyushu.html
2023-11-02に 福岡で開催 予定なので興味ある方はぜひ! https://www.jasst.jp/symposium/jasst23kyushu.html
本題: 起 ここまで0:45
今年の8月 からマネーフォワードでの キャリアをスタートしました ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
皆さんは入社して まず何をしますか? ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
times芸人業ですね ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜 チームリーダーからの評価
…ですが 今日話したいのはその話ではなく… ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
まずやることは ドメイン知識を身につける ところからだと思います ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
では皆さんはどうやって ドメインを理解しますか? ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
仕様書やドキュメントを読む!
ドキュメントが充実している プロダクトならいざしらず、必要十分な ドキュメントがない場合もあります 理想と現実 ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
コードから全てを理解する
配属当初から全てのコードを網羅的に 読み込むのはなかなかに厳しいと思います 木は見えるけど森は見えない ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
じゃあどうするの?
データベースから 仕様を理解する ことが早いと思っています 私の経験に基づいた一例ですが… ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
そんな私がマネーフォワードに入社して1ヶ月 どのような取り組みをしてきたかを お話ししようと思います ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
本題: 承 ここまで2:00
データベースの仕様書と言えば 真っ先に思い浮かぶものがありますね ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
そう、ER図ですね ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
でも作るの大変だし 何よりメンテが大変… 大変じゃない? https://github.com/k1LoW/tbls
私は tblsというOSS をこの上なく愛しています https://github.com/k1LoW/tbls
端的に言えば データベースドキュメント 自動生成ツール 開発者の方は「Document as Code」というキーワードを使われています https://speakerdeck.com/k1low/phpconfuk-2023
https://github.com/k1LoW/tbls 参考: 出力イメージ
仕様理解・開発スピードの向上 を目的としてこのツールの導入を進めました ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
実装イメージ https://github.com/k1LoW/tbls
Phase 1. ローカルに ドキュメント生成環境を準備 https://github.com/k1LoW/tbls
Phase 1. ローカルにドキュメント生成環境を準備 ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜 tblsのインストールと ymlファイルを準備しただけ!
あとはMakefileに便利コマンドを 追加した程度の開発 1.ローカルのDBをマイグレーション ファイルから構築 2.tbls.ymlを作成 3.コマンドを実行してデータベース ドキュメントを生成
Phase 2. CIでドキュメントの ビハインドを検知する https://github.com/k1LoW/tbls
Phase 2. CIでドキュメントのビハインドを検知する ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜 CIで利用されるテーブルは常に 最新になることを利用
コミットされているドキュメントと 最新のドキュメントに差分がある 場合はCIを落とすようにした 1.CIのDBをマイグレーション ファイルから構築 2.CIのデータベースドキュメントを生成 3.CIとコミットしたデータベース ドキュメントの差分を検知
ER図が作られただけではなく データベースドキュメントが 最新の状態に保たれる 仕組みが構築できました ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
ドキュメントを最新の状態に 維持し続けていくのが一番難しい… ここを仕組みで解決しました ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
更にビハインド発生時の マニュアルを整備する ことで他の開発者向けに情報を残しました ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
これでデータベース ドキュメントについては完璧! ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
本題: 転 ここまで4:00
…というわけではなく、 まだまだ課題は残っています ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
テーブルごとの意味を持つまとまりを どう表現するかが課題です 例えばユーザーの基本情報が格納されているテーブル群だったり 契約情報がまとまっているテーブル群だったり… ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
tblsには「ラベル」 という概念があります ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
テーブルにラベルを付与して ラベル単位でもドキュメントを出力する 仕組みを検討しています 更に開発者フレンドリーなドキュメントが生成できますね ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
他にも「Viewpoints」という 概念を用いてドキュメントを追加する こともできるでしょう https://speakerdeck.com/k1low/phpconfuk-2023?slide=34
また、他のアプローチとして モデルに定義されている 定義を機械的に収集した上で 反映させることもできそうです https://speakerdeck.com/k1low/phpconfuk-2023?slide=34
ツールを入れて終わり ではなく ドキュメントを整備し続ける ことが大事ですね https://speakerdeck.com/k1low/phpconfuk-2023?slide=34
本題: 結 ここまで4:30
以上の取り組みによって アプリケーションの仕様を データベースから理解する ことができるようになりました ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
ドキュメントは宝の山 だと思っています ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
今回取り入れた仕組みを通して オンボーディングの高速化などに 役立てばいいなと思っています ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
みなさんもドキュメント化 やっていきましょう💪 ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
終わりに ここまで4:50
マネーフォワード福岡拠点では 一緒に働ける仲間を募集しています! https://hrmos.co/pages/moneyforward/jobs?category=1666323298559537153 ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
福岡開発拠点のサイトもあるので ぜひご覧ください! https://fukuoka.moneyforward.com ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
一緒にドキュメント化を 進めていきたいという方は ぜひお声がけください ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜
ご清聴ありがとう ございました! ER図クエスト 過ぎ去りしドキュメントを求めて 〜複雑性に眠る秘宝〜