rabbit-slide-Piro-readable-code-workshop-2022-11-02a-retrospective 2022.11.02

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 40e3146d0ac7668254e8f18f1d25ae4f6ccdba2ae05176bd2ced0e37a7669fb4
+  data.tar.gz: 55cdb8f52401fbafbe34817db87cd68b6840c0431e1078b0228709bf33492684
+SHA512:
+  metadata.gz: 40feb6340b036ba41abbe2789050af80858739749e04d125dae6320950857294c0c4059109b83202d1ff84d1b6403d4fefa6a8e3cca43bf1ce262daa581a68d8
+  data.tar.gz: c105350e959ab833c4b38399fa629c1273b70c2c6f5348930eef6b9a5aacdeae6faa4e74d3d1e7cad17cf316f51ed559a2829dc964e45919ddcc481dd50afee1

data/.rabbit

@@ -0,0 +1 @@
+how-to-look-back.rab

data/README.rd

@@ -0,0 +1,32 @@
+= 実践リーダブルコードのふりかえり
+
+2022-08-05開催のリーダブルコード演習でのふりかえりの進め方の説明。
+
+== ライセンス
+
+CC-BY-SA-4.0
+
+原著作者名は以下の通りです。
+
+  * 株式会社クリアコード
+
+== 作者向け
+
+=== 表示
+
+  rake
+
+=== 公開
+
+  rake publish
+
+== 閲覧者向け
+
+=== インストール
+
+  gem install rabbit-slide-Piro-readable-code-workshop-2022-08-05-retrospective
+
+=== 表示
+
+  rabbit rabbit-slide-Piro-readable-code-workshop-2022-08-05-retrospective.gem
+

data/Rakefile

@@ -0,0 +1,17 @@
+require "rabbit/task/slide"
+
+# Edit ./config.yaml to customize meta data
+
+spec = nil
+Rabbit::Task::Slide.new do |task|
+  spec = task.spec
+  # spec.files += Dir.glob("doc/**/*.*")
+  # spec.files -= Dir.glob("private/**/*.*")
+  spec.add_runtime_dependency("rabbit-theme-clear-code")
+end
+
+desc "Tag #{spec.version}"
+task :tag do
+  sh("git", "tag", "-a", spec.version.to_s, "-m", "Publish #{spec.version}")
+  sh("git", "push", "--tags")
+end

data/config.yaml

@@ -0,0 +1,22 @@
+---
+id: readable-code-workshop-2022-11-02a-retrospective
+base_name: how-to-look-back
+tags:
+- rabbit
+- readable-code
+presentation_date: 2022-11-02
+version: 2022.11.02
+licenses:
+- CC-BY-SA-4.0
+slideshare_id: readable-code-workshop-2022-11-02a-retrospective
+speaker_deck_id: 
+ustream_id: 
+vimeo_id: 
+youtube_id: 
+author:
+  markup_language: :rd
+  name: YUKI Hiroshi
+  email: yuki@clear-code.com
+  rubygems_user: Piro
+  slideshare_user: pirooutsiderreflex
+  speaker_deck_user: piroor

data/how-to-look-back.rab

@@ -0,0 +1,197 @@
+= ふりかえりの進め方
+
+: author
+   結城洋志
+: institution
+   株式会社クリアコード
+: content-source
+   実践リーダブルコード
+: date
+   2022-11-02
+: allotted-time
+   10m
+: theme
+   clear-code
+
+= 目的
+
+  * リーダブルの基準を\n
+    他の人と共有
+
+= おさらい：今日の体験内容
+
+  * ((*まず自分が読み始める*))
+  * 他の人が書いたコードから\n
+    ((*リーダブルコードの工夫*))を探す\n
+    (('note:（「読みにくいコード」は探さない）'))
+  * リーダブルの基準を\n
+    他人と共有する\n
+    (('note:（チームのリーダブルコードができる）'))
+
+= ポイント
+
+(('tag:center'))
+リーダブルじゃないコードより\n
+リーダブルなコード
+
+((' '))
+
+= リーダブルじゃないコード
+
+  * 見つけやすい
+    * 異質
+    * 読んでいると詰まる
+  * 今日のチャレンジ
+    * 気をとられない
+
+= リーダブルなコード
+
+  * 見つけにくい
+    * まわりのコードになじんでいるから
+    * すーっと理解できてひっかからない
+  * 今日のチャレンジ
+    * 意識して見つけよう！
+
+= 共有の準備
+
+  * 3人～4人でグループを編成
+  * グループ代表者を1人決める\n
+    （誰でも可）
+  * 代表者の「他の人から開発を\n
+    引き継いだリポジトリ」に\n
+    「発表用まとめissue」を\n
+    作成する
+
+= やること
+
+  * 各自：よいコードを共有
+  * グループ：共有したよいコードを整理
+    * 自分たちの「リーダブルコード」
+
+= リーダブルなコードを共有
+
+  * 他の人に説明すること
+    * 実際のコード
+    * リーダブルな理由
+    * 見つけたきっかけ
+
+= 共有するときのポイント
+
+  * 他の人と\n
+    同じことを言ってもよい
+  * 同じことを言った\n
+    →より一般的にリーダブル\n
+    　ということ
+
+= 共有方法
+
+  * グループの代表者ごとに発表
+    * 持ち時間は1グループ1回につき\n
+      3分くらいが目安
+    * 講師の画面でissueを表示、\n
+      それを見ながら説明
+
+= グループ内共有の準備
+
+(('note:時間：5分'))
+
+  * グループから代表者を1人選ぶ
+    * 名前順で最初の人とかでよい
+      * 発表時は画面を共有
+    * その人のリポジトリーにissueを\n
+      1つだけ作る
+    * ↑は共有したリーダブルコードを\n
+      集める場所とする（まとめスレ）
+
+= 共有方法
+
+  * コードを見せながら順に紹介
+    (1) 代表者から順に紹介
+    (2) 1ターンにつき1人1つ紹介
+    (3) 自分の画面をグループに\n
+        共有して見せる
+    (4) issueに紹介内容をコメント
+    (5) 何ターンか繰り返す
+
+= 共有内容
+
+  * 書き方の名前
+  * コードへのリンク/コード片
+  * リーダブルと感じた理由
+  * 見つけたきっかけ
+
+= 共有内容の例1
+
+  * 名前：「統一されたスタイル」
+  * コード：
+      
+      # _
+      void open_TermList(TermList *list, char *path) {
+        FILE *fp;
+        /* ファイルを開く */
+        if ((fp = fopen(path , "r")) == NULL) {
+          fprintf (stderr, "ファイルが開けません\n");
+          fclose(fp);
+          exit(EXIT_FAILURE);
+
+= 共有内容の例2
+
+  * 理由:
+    * ファイル内で「)」と「{」の間にスペースを空ける、という
+      スタイルに統一しているので読みやすくなっている。
+  * きっかけ:
+    * その場所を自然に読み過ごせたから。
+
+= 聞くときは
+
+  * 自分が気付いていなかった\n
+    リーダブルの基準がないか、\n
+    気をつけて聞こう
+
+= グループのリーダブル基準を検討
+
+  * グループのみんなが\n
+    リーダブルと思うコードを選ぶ
+    * 選んだコードを貼るissueを作る
+    * あがったコードを1つずつ検討
+    * リーダブルなら↑のissueに貼る
+
+= グループのリーダブル基準
+
+  * issueのコードがそのグループの基準になる
+  * 集めてグループの文化にする
+    * メンバーのレベルアップで変わる
+
+
+= ここまでの説明
+
+腑に落ちましたか？
+
+
+= 共有の準備
+
+(('note:時間：10分'))
+
+  * 代表で発表する人を決める
+    * グループ内で1人
+    * 発表時は画面を共有
+  * グループで発表する\n
+    「リーダブルの基準」を選出
+    * 「これは確かにそうだ！」と\n
+      深く納得できたものを優先
+    * 書籍「リーダブルコード」に\n
+      ないものも優先
+
+= 発表
+
+  * 自分が気付いていなかった\n
+    リーダブルの基準がないか、\n
+    気をつけて聞こう
+
+= グループ内での共有開始
+
+15:30まで
+
+= 全体への共有開始
+
+15:40まで

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: rabbit-slide-Piro-readable-code-workshop-2022-11-02a-retrospective
+version: !ruby/object:Gem::Version
+  version: 2022.11.02
+platform: ruby
+authors:
+- YUKI Hiroshi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rabbit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: rabbit-theme-clear-code
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 2022-08-05開催のリーダブルコード演習でのふりかえりの進め方の説明。
+email:
+- yuki@clear-code.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rabbit"
+- README.rd
+- Rakefile
+- config.yaml
+- how-to-look-back.rab
+- pdf/readable-code-workshop-2022-11-02a-retrospective-how-to-look-back.pdf
+homepage: http://slide.rabbit-shocker.org/authors/Piro/readable-code-workshop-2022-11-02a-retrospective/
+licenses:
+- CC-BY-SA-4.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: 実践リーダブルコードのふりかえり
+test_files: []