Rabbit Slide Show

実践リーダブルコードのふりかえり

2022-11-02

Description

2022-08-05開催のリーダブルコード演習でのふりかえりの進め方の説明。

Text

Page: 1

ふりかえりの進め方
結城洋志
株式会社クリアコード
実践リーダブルコード
2022-11-02
ふりかえりの進め方
Powered by Rabbit 2.2.1

Page: 2

目的
✓ リーダブルの基準を
他の人と共有
ふりかえりの進め方
Powered by Rabbit 2.2.1

Page: 3

おさらい:今日の体験内容
✓ まず自分が読み始める
✓ 他の人が書いたコードから
リーダブルコードの工夫を探す
(「読みにくいコード」は探さない)
✓ リーダブルの基準を
他人と共有する
(チームのリーダブルコードができる)
ふりかえりの進め方
Powered by Rabbit 2.2.1

Page: 4

ポイント
リーダブルじゃないコードより
リーダブルなコード
ふりかえりの進め方
Powered by Rabbit 2.2.1

Page: 5

リーダブルじゃないコード
✓ 見つけやすい
✓ 異質
✓ 読んでいると詰まる
✓ 今日のチャレンジ
✓ 気をとられない
ふりかえりの進め方
Powered by Rabbit 2.2.1

Page: 6

リーダブルなコード
✓ 見つけにくい
✓ まわりのコードになじんでいるから
✓ すーっと理解できてひっかからない
✓ 今日のチャレンジ
✓ 意識して見つけよう!
ふりかえりの進め方
Powered by Rabbit 2.2.1

Page: 7

共有の準備
✓ 3人~4人でグループを編成
✓ グループ代表者を1人決める
(誰でも可)
✓ 代表者の作業リポジトリに
「発表用まとめissue」を
作成する
ふりかえりの進め方
Powered by Rabbit 2.2.1

Page: 8

やること
✓ 各自:よいコードを共有
✓ グループ:共有したよいコード
を整理
✓ 自分たちの「リーダブルコード」
ふりかえりの進め方
Powered by Rabbit 2.2.1

Page: 9

リーダブルなコードを共有
✓ 他の人に説明すること
✓ 実際のコード
✓ リーダブルな理由
✓ 見つけたきっかけ
ふりかえりの進め方
Powered by Rabbit 2.2.1

Page: 10

共有するときのポイント
✓ 他の人と
同じことを言ってもよい
✓ 同じことを言った
→より一般的にリーダブル
ということ
ふりかえりの進め方
Powered by Rabbit 2.2.1

Page: 11

共有方法
✓ グループの代表者ごとに発表
✓ 持ち時間は1グループ1回につき
3分くらいが目安
✓ 講師の画面でissueを表示、
それを見ながら説明
ふりかえりの進め方
Powered by Rabbit 2.2.1

Page: 12

グループ内共有の準備
時間:5分
✓ グループから代表者を1人選ぶ
✓ 名前順で最初の人とかでよい
✓ 発表時は画面を共有
✓ その人のリポジトリーにissueを
1つだけ作る
✓ ↑は共有したリーダブルコードを
集める場所とする(まとめスレ)
ふりかえりの進め方
Powered by Rabbit 2.2.1

Page: 13

共有方法
✓ コードを見せながら順に紹介
a. 代表者から順に紹介
b. 1ターンにつき1人1つ紹介
c. 自分の画面をグループに
共有して見せる
d. issueに紹介内容をコメント
e. 何ターンか繰り返す
ふりかえりの進め方
Powered by Rabbit 2.2.1

Page: 14

共有内容
✓ 書き方の名前
✓ コードへのリンク/コード片
✓ リーダブルと感じた理由
✓ 見つけたきっかけ
ふりかえりの進め方
Powered by Rabbit 2.2.1

Page: 15

共有内容の例1
✓ 名前:「統一されたスタイル」
✓ コード:
void open_TermList(TermList *list, char *path) {
FILE *fp;
/* ファイルを開く */
if ((fp = fopen(path , "r")) == NULL) {
fprintf (stderr, "ファイルが開けません\n");
fclose(fp);
exit(EXIT_FAILURE);
ふりかえりの進め方
Powered by Rabbit 2.2.1

Page: 16

共有内容の例2
✓ 理由:
✓ ファイル内で「)」と「{」の間にス
ペースを空ける、というスタイルに
統一しているので読みやすくなって
いる。
✓ きっかけ:
✓ その場所を自然に読み過ごせたか
ら。
ふりかえりの進め方
Powered by Rabbit 2.2.1

Page: 17

聞くときは
✓ 自分が気付いていなかった
リーダブルの基準がないか、
気をつけて聞こう
ふりかえりの進め方
Powered by Rabbit 2.2.1

Page: 18

グループのリーダブル基準を
検討
✓ グループのみんなが
リーダブルと思うコードを選ぶ
✓ 選んだコードを貼るissueを作る
✓ あがったコードを1つずつ検討
✓ リーダブルなら↑のissueに貼る
ふりかえりの進め方
Powered by Rabbit 2.2.1

Page: 19

グループのリーダブル基準
✓ issueのコードがそのグループの
基準になる
✓ 集めてグループの文化にする
✓ メンバーのレベルアップで変わる
ふりかえりの進め方
Powered by Rabbit 2.2.1

Page: 20

ここまでの説明
腑に落ちました
か?
ふりかえりの進め方
Powered by Rabbit 2.2.1

Page: 21

時間:10分
共有の準備
✓ 代表で発表する人を決める
✓ グループ内で1人
✓ 発表時は画面を共有
✓ グループで発表する
「リーダブルの基準」を選出
✓ 「これは確かにそうだ!」と
深く納得できたものを優先
✓ 書籍「リーダブルコード」に
ないものも優先
ふりかえりの進め方
Powered by Rabbit 2.2.1

Page: 22

発表
✓ 自分が気付いていなかった
リーダブルの基準がないか、
気をつけて聞こう
ふりかえりの進め方
Powered by Rabbit 2.2.1

Page: 23

グループ内での共有開始
15:30まで
ふりかえりの進め方
Powered by Rabbit 2.2.1

Page: 24

全体への共有開始
15:40まで
ふりかえりの進め方
Powered by Rabbit 2.2.1

Other slides