Rabbit Slide Show

実践リーダブルコードのまとめ

2015-03-06

Description

2015-03-06開催の実践リーダブルコードのまとめと次のステップの説明。

Text

Page: 1

まとめと次のステップ
須藤功平
株式会社クリアコード
実践リーダブルコード
2015-03-06
まとめと次のステップ
Powered by Rabbit 2.1.7

Page: 2

講座の目的
✓ 自分の開発チームに
✓ リーダブルなコードが
当たり前な文化の作り方を
✓ 持ち帰る
まとめと次のステップ
Powered by Rabbit 2.1.7

Page: 3

文化の作り方の流れ(1)
✓ リーダブルコードの必要性を
チームで共有
✓ 改良・修正が多いなら必要
✓ 継続的に改良・修正したいか
✓ チームとして改良・修正したいか
まとめと次のステップ
Powered by Rabbit 2.1.7

Page: 4

文化の作り方の流れ(2)
✓ チームでのリーダブルの基準を
育てる
✓ 「読む人」が
読みやすいなら
リーダブル
✓ 「読む人」が変われば基準が変わる
✓ →読む人が違うのでチーム毎に違う
まとめと次のステップ
Powered by Rabbit 2.1.7

Page: 5

文化の作り方の流れ(3)
✓ 基準の育て方
✓ 各メンバーがコードを読む
✓ リーダブルだと思ったコードを共有
✓ チームとしてリーダブルかを判断
✓ →チームの基準に加わる
まとめと次のステップ
Powered by Rabbit 2.1.7

Page: 6

基準の育て方(1)
✓ コードを読む文化を作る
✓ まず自分が読み始める
✓ リーダブルなコードを探す
✓ 見つけたリーダブルなコードを
他のメンバーに伝える (後述)
✓ →コードが読まれるという自覚が
チームに浸透
今日やったのはここまで
まとめと次のステップ
Powered by Rabbit 2.1.7

Page: 7

基準の育て方(2)
次のステップ
✓ コミットを読む
✓ コード全体ではなく差分を読む
✓ 設計の仕方ではなく
開発の仕方が見える
✓ リーダブルなコードを
見つけるには適切
まとめと次のステップ
Powered by Rabbit 2.1.7

Page: 8

基準の育て方(3)
✓ コミットの読み方
✓ pull型よりpush型がよい
(Git用のオススメツールあり:git-utils)
✓ 読むコストが下がる
✓ 流し読む(負担が多いと続かない)
✓ 問題探し視点では読まない
まとめと次のステップ
Powered by Rabbit 2.1.7

Page: 9

基準の育て方(4)
✓ リーダブルコードの伝え方
✓ Wikiに書く(全チームで有効)
✓ コードで伝える(上級チーム向け)
まとめと次のステップ
Powered by Rabbit 2.1.7

Page: 10

基準の育て方(5)
✓ Wikiに書いて伝える
✓ Wikiもdiffを通知できるようにする
(RedmineとGitHub用はツールあり)
✓ 後で参照できるため
✓ 更新もできるため
(リーダブルコードの基準は変わることもある!)
まとめと次のステップ
Powered by Rabbit 2.1.7

Page: 11

基準の育て方(6)
✓ コードで伝える
✓ 上級チーム向け
(チームにコードを読む文化が根付いた後)
✓ リーダブルコードを真似てコミット
✓ →他の人:「またこの書き方だ」
✓ →真似する人増加→チームが合意
✓ →チームが合意→Wikiにまとめる
まとめと次のステップ
Powered by Rabbit 2.1.7

Page: 12

おまけ:副次効果
✓ コードを読む文化
✓ 新しい人の受け入れにも有用
✓ 自分たちが大事にしていることを
開発を通じて徐々に伝えていける
まとめと次のステップ
Powered by Rabbit 2.1.7

Page: 13

来週からやること
✓ リーダブルコードの必要性を
チームで確認
✓ →この講座をチームでもやる
✓ 資料はすべて再利用可能
✓ →自分がコードを読み始める
✓ 自分が変更するコードの周辺から
リーダブルコードを探す
まとめと次のステップ
Powered by Rabbit 2.1.7

Page: 14

サポート(1)
✓ 今日の資料はすべて再利用可能
✓ チーム内で同じ講座をできる
✓ 無料のフォローアップ面談
✓ チームで実践→悩み
↑の相談に乗る
✓ 受講後3ヶ月以内、1回限り
まとめと次のステップ
Powered by Rabbit 2.1.7

Page: 15

サポート(2)
✓ コミット読みの支援
✓ OSSとしてツールを公開
✓ コミット毎にメールで通知 (diff入り)
✓ Git、Subversionで使える
✓ GitHub、GitLab連携もできる
まとめと次のステップ
Powered by Rabbit 2.1.7

Page: 16

おしらせ(1)
✓ WEB+DB PRESS Vol.86に寄稿
✓ よいコード・よいコミットについて
✓ 2015-4-24発売予定
✓ http://www.amazon.co.jp/
dp/4774172480
まとめと次のステップ
Powered by Rabbit 2.1.7

Page: 17

おしらせ(2)
コードリーダー育成支援
http://www.clear-code.com/services/code-reader/
リーダブルなコードが
当たり前な文化づくりを支援
まとめと次のステップ
Powered by Rabbit 2.1.7

Page: 18

トラブルシューティング
1人で始めたまま
なかなかチームに広げられない
✓ 実績を元に
リーダーや○○長に協力依頼
✓ 実績例:リーダブル基準集
✓ 前述の支援サービスを使う
✓ →組織として本気で取り組むぞ!
というメッセージになる
まとめと次のステップ
Powered by Rabbit 2.1.7

Page: 19

クリアコード
✓ クリアなコードが大切
✓ クリア == clear == 意図が明確
✓ クリアなコードはリーダブルコード
みなさんのチームが
リーダブルコードが当たり前な
チームになることを応援します!
まとめと次のステップ
Powered by Rabbit 2.1.7

Other slides

Mroonga!
2015-10-30