rabbit-slide-Piro-readable-code-workshop-2019-09-24-introduction 2019.09.24

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 54561ec49fa967beb5d94022235164f943d3ab84be108af99ded7d4f78b94385
+  data.tar.gz: fe7df601ab22ce849e7951ddc55bb6719c13f9635501a3d68716683f8a183059
+SHA512:
+  metadata.gz: f54da5980ab32ce635d467913e3dab1fb4f9df476f8b6bef3f188bcd969132f6577a2bc83aa5c9bd3bc8122eeadceee90f6aa3c60a728271794b6d515e77abf2
+  data.tar.gz: ac7d04d8aef750f5279f361e31dba1b9f61e82abfc47fbf84f9f1a4271ca0d74130d69ba205a73900644e0c712c05f3f5573d48180f6c1851251c2a9a3400b25

data/.rabbit

@@ -0,0 +1 @@
+summary.rab

data/README.rd

@@ -0,0 +1,32 @@
+= 実践リーダブルコードの概要
+
+2019-09-24開催の実践リーダブルコードの概要と進め方の説明。
+
+== ライセンス
+
+CC BY-SA 4.0
+
+原著作者名は以下の通りです。
+
+  * 株式会社クリアコード
+
+== 作者向け
+
+=== 表示
+
+  rake
+
+=== 公開
+
+  rake publish
+
+== 閲覧者向け
+
+=== インストール
+
+  gem install rabbit-slide-piroor-readable-code-workshop-2019-09-24-introduction
+
+=== 表示
+
+  rabbit rabbit-slide-piroor-readable-code-workshop-2019-09-24-introduction.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("images/**/*.*")
+  # 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-2019-09-24-introduction
+base_name: summary
+tags:
+- rabbit
+- readable-code
+presentation_date: 2019-09-24
+version: 2019.09.24
+licenses:
+- CC BY-SA 4.0
+slideshare_id: readable-code-workshop-2019-09-24-introduction
+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/images/readable-code-reasonability.svg

@@ -0,0 +1,167 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   width="416.15005"
+   height="233.13203"
+   id="svg2"
+   version="1.1"
+   inkscape:version="0.48.5 r10040"
+   sodipodi:docname="readable-code-reasonability.svg">
+  <defs
+     id="defs4">
+    <marker
+       inkscape:stockid="Arrow1Lend"
+       orient="auto"
+       refY="0"
+       refX="0"
+       id="Arrow1Lend"
+       style="overflow:visible">
+      <path
+         id="path3764"
+         d="M 0,0 5,-5 -12.5,0 5,5 0,0 z"
+         style="fill-rule:evenodd;stroke:#000000;stroke-width:1pt"
+         transform="matrix(-0.8,0,0,-0.8,-10,0)"
+         inkscape:connector-curvature="0" />
+    </marker>
+  </defs>
+  <sodipodi:namedview
+     id="base"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1.0"
+     inkscape:pageopacity="0.0"
+     inkscape:pageshadow="2"
+     inkscape:zoom="1.979899"
+     inkscape:cx="304.97745"
+     inkscape:cy="179.2249"
+     inkscape:document-units="px"
+     inkscape:current-layer="layer1"
+     showgrid="false"
+     inkscape:window-width="1237"
+     inkscape:window-height="817"
+     inkscape:window-x="2116"
+     inkscape:window-y="68"
+     inkscape:window-maximized="0"
+     fit-margin-top="10"
+     fit-margin-left="10"
+     fit-margin-right="10"
+     fit-margin-bottom="10" />
+  <metadata
+     id="metadata7">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title></dc:title>
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <g
+     inkscape:label="レイヤー 1"
+     inkscape:groupmode="layer"
+     id="layer1"
+     transform="translate(-42.823639,-264.5498)">
+    <path
+       style="fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-end:url(#Arrow1Lend)"
+       d="m 62.629458,450.31127 286.883322,0"
+       id="path2985"
+       inkscape:connector-curvature="0" />
+    <path
+       style="fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-end:url(#Arrow1Lend)"
+       d="m 104.04571,487.18183 0,-212.13203"
+       id="path2987"
+       inkscape:connector-curvature="0" />
+    <text
+       xml:space="preserve"
+       style="font-size:20px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+       x="310.62192"
+       y="476.57526"
+       id="text4402"
+       sodipodi:linespacing="125%"><tspan
+         sodipodi:role="line"
+         id="tspan4404"
+         x="310.62192"
+         y="476.57526">時間</tspan></text>
+    <text
+       xml:space="preserve"
+       style="font-size:20px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans"
+       x="52.022858"
+       y="293.73761"
+       id="text4406"
+       sodipodi:linespacing="125%"><tspan
+         sodipodi:role="line"
+         id="tspan4410"
+         x="52.022858"
+         y="293.73761">開発</tspan><tspan
+         sodipodi:role="line"
+         id="tspan4412"
+         x="52.022858"
+         y="318.73761">速度</tspan></text>
+    <path
+       style="fill:none;stroke:#a40000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       d="m 104.02541,309.39499 c 0,0 15.15229,97.47972 90.40865,116.67261 75.25637,19.1929 140.91628,13.63706 140.91628,13.63706"
+       id="path5532"
+       inkscape:connector-curvature="0"
+       sodipodi:nodetypes="csc" />
+    <text
+       xml:space="preserve"
+       style="font-size:25px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#a40000;fill-opacity:1;stroke:none;font-family:Sans"
+       x="174.97467"
+       y="387.88406"
+       id="text5534"
+       sodipodi:linespacing="125%"><tspan
+         sodipodi:role="line"
+         id="tspan5536"
+         x="174.97467"
+         y="387.88406">リーダブルじゃない場合</tspan></text>
+    <path
+       style="fill:none;stroke:#204a87;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       d="m 103.57143,342.36218 c 0,0 63.28367,10.3815 101.53626,13.06635 43.48081,3.05182 112.03517,4.79079 132.74945,4.07651"
+       id="path5546"
+       inkscape:connector-curvature="0"
+       sodipodi:nodetypes="csc" />
+    <text
+       sodipodi:linespacing="125%"
+       id="text5548"
+       y="301.74121"
+       x="144.83182"
+       style="font-size:25px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#204a87;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans"
+       xml:space="preserve"><tspan
+         sodipodi:role="line"
+         id="tspan5552"
+         x="144.83182"
+         y="301.74121">リーダブルな場合</tspan></text>
+    <text
+       xml:space="preserve"
+       style="font-size:20px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
+       x="148.05447"
+       y="330.21933"
+       id="text5554"
+       sodipodi:linespacing="125%"><tspan
+         sodipodi:role="line"
+         id="tspan5556"
+         x="148.05447"
+         y="330.21933">開発速度が落ちにくい</tspan></text>
+    <text
+       sodipodi:linespacing="125%"
+       id="text5558"
+       y="412.21933"
+       x="177.2403"
+       style="font-size:20px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans"
+       xml:space="preserve"><tspan
+         sodipodi:role="line"
+         id="tspan5562"
+         x="177.2403"
+         y="412.21933">開発速度が落ちやすい</tspan></text>
+  </g>
+</svg>

data/summary.rab

@@ -0,0 +1,315 @@
+= 概要
+
+: author
+   結城洋志
+: institution
+   株式会社クリアコード
+: content-source
+   実践リーダブルコード
+: date
+   2019-09-24
+: allotted-time
+   30m
+: theme
+   clear-code
+
+= 今日の流れ - 午前
+
+  * 10:30- アイスブレーク
+  * 10:45- 概要と進め方の説明
+  * 11:15- 実装
+  * 11:45- ランチ
+
+= 今日の流れ - 昼下がり
+
+  * 12:45- 実装の続き
+  * 13:45- 読み方のデモ
+  * 14:00- チェンジして実装
+  * 15:30- グループふりかえり
+
+= 今日の流れ - 夕方
+
+  * 16:10- まとめ
+    * 次のステップを説明
+  * 16:30- 感想発表・ディスカッション
+
+= チューター紹介
+
+  * 参加者のサポート係
+  * 現役エンジニア
+  * 行動指針
+    * 参加者が目的を見失うのを防ぐ
+    * 新しい視点を与える
+
+= 講師紹介
+
+(('tag:center'))(('tag:margin-bottom * 2'))
+結城洋志（ゆうき ひろし）
+
+  * クリアコード所属
+  * 進行と全体を気にかける係
+
+= 講座の目的
+
+  * 自分の開発チームに
+    * ↑注意：個々人の話ではない
+  * ((*リーダブルなコードが\n
+    当たり前な文化の作り方*))を
+  * 持ち帰る
+
+(('tag:center'))
+(('note:→ 「解説」に書いていることの実践方法を学ぶ'))
+
+= 目的でないこと
+
+  * 実践前の不安のケア
+    * やらない理由の増幅は抑えられない
+    * ↑のときに外からの声は届かない
+  * 例：上司の説得方法の伝授
+    * 時間が残ったら参加者同士で\n
+      情報交換する場を用意
+    * ↑を活用するのは可
+
+= サポート
+
+  * 今日の資料はすべて再利用可能
+    * チーム内で同じ講座を再現できる
+  * 無料のフォローアップ面談
+    * チームで実践→悩み\n
+      ↑の相談に乗る
+    * 受講後3ヶ月以内に1回
+
+= そもそもの話
+
+  * リーダブルコードはなぜ必要か
+
+(('tag:center'))
+↓を目指すために\n
+チームでの共有は必須\n
+\n
+リーダブルなコードが\n
+当たり前な文化
+
+= 必要なケース
+
+チーム開発
+
+= チーム開発
+
+  * 1人しか触れないコード→危険
+    * いなくなったら変更できない
+    * 変更できてもコストが大きい
+  * チームで触れるには？
+
+(('wait'))
+(('tag:center'))
+↓\n
+既存コードの理解が必要
+
+= 既存コードの理解のため
+
+リーダブル\n
+コード
+
+= 既存コードの理解しやすさ
+
+  * コードの変更コストに影響
+    * コスト↑→修正・機能追加の時間↑\n
+      (('note:（理解しないと変更できない）'))
+    * コスト↑→リグレッションバグ↑\n
+      (('note:（理解しないまま変更すると問題発生）'))
+
+(('wait'))
+(('tag:center'))
+↓\n
+理解しやすさ→開発速度に影響
+
+= 時間が経つほど影響大
+
+  # image
+  # src = images/readable-code-reasonability.svg
+  # relative_width = 90
+
+== プロパティー
+
+: enable-title-on-image
+   false
+
+= リーダブルコードの必要性
+
+  * チームの開発速度の維持のため
+    * 継続的に改良・修正したい
+    * それも現実的なコストで
+
+= 必要性の実現方法
+
+コードを読む\n
+文化を作る
+
+= 読む？書くじゃないの？
+
+  * リーダブルコードを書くには\n
+    コードを読まないといけない
+    * なぜ？
+
+(('wait'))
+(('tag:center'))
+リーダブルコードは\n
+チーム毎に違うから
+
+= リーダブルコード
+
+「読む人」が\n
+読みやすいなら\n
+リーダブル
+
+= 読む人
+
+  * 多くの場合、いない
+    * チームのコードを読んでいますか？
+  * 読む人（チームメンバー）毎に\n
+    リーダブルの基準は違う
+    * 背景が違うので当たり前\n
+      (('note:（背景：使ってきた言語・今の知識）'))
+
+= チームでのリーダブル
+
+  * 1つずつ見つけていくしかない
+    * 各メンバーの読んだ感覚を\n
+      チームで共有
+    * 既存の基準をベースにするのはアリ\n
+      (('note:（基準：本の内容やコーディングスタイルなど）'))
+
+(('tag:center'))
+チームでのリーダブルコードは\n
+育てていくもの
+
+= リーダブルの基準の育て方
+
+  * コードを読む文化を作る\n
+    (('note:（最初の難関）'))
+  * チームのコードの中から\n
+    リーダブルなコードを見つける
+  * リーダブルなコードを\n
+    チームで共有
+  * ↑の繰り返しで基準を増やす
+
+= コードを読む文化を作る
+
+  * まず自分が読み始める
+    * 仲間がいると心強い
+  * リーダブルなコードを探す
+    * 読みにくいコードは今は置いておく\n
+      (('note:（チームにコードを読む文化ができてから！）'))
+    * 見つけたリーダブルなコードは…
+
+= リーダブルなコードは…
+
+  * 他のメンバーに教える\n
+    (('note:（例：話しかける。チャットに書く。Wikiにまとめる。）'))
+    * 「○○さんの△△という書き方、\n
+      リーダブルでしたよー」
+
+(('tag:center'))
+↓\n
+読みやすさの基準を共有\n
+コードが読まれているという自覚
+
+= 読むことを「当たり前」に
+
+  * 「あいつはコードを読むやつ」\n
+    という認識を広める
+  * 自分だけからチームへ
+
+(('tag:center'))
+…続きはセミナーの最後に
+
+= ワークショップ内容
+
+(('tag:center'))
+改良するために\n
+他の人のコードを読む
+
+  * 「まず自分が読み始める」
+  * 「リーダブルコードを探す」\n
+    (('note:（読みにくいコードは今は置いておく）'))
+  * 「リーダブルの基準を共有」\n
+    (('note:（チームでのリーダブルコードができる）'))
+
+= 注意：やらないこと
+
+(('tag:center'))
+リーダブルコードを書くための\n
+テクニックをたくさん伝授
+
+((' '))
+
+= テクニック伝授は範囲外
+
+  * 順番が違う
+  * まず読む文化を作ること
+    * 今日は↑がメイン
+  * テクニックはその後
+    * 読む文化ができていれば\n
+      効率的に広められる
+    * よい書き方でコードを書けば\n
+      みんながコードから学んでくれる！
+
+= やること
+
+読む文化作りの\n
+体験
+
+= 読む文化作り
+
+  * まず自分が読み始める
+  * リーダブルコードを探す
+  * 他のメンバーに教える
+
+= 読む文化作りの体験
+
+  * 10:45- 課題を実装
+    * リーダブルコードを書く
+  * 14:00- 実装チェンジ→開発継続
+    * 「まず自分が読み始める」
+    * 「リーダブルコードを探す」
+  * 15:30- グループふりかえり
+    * 「他のメンバーに教える」
+
+= おさらい
+
+  * 講座の目的
+  * リーダブルコードの必要性
+  * 講座でやること
+
+= 講座の目的
+
+  * 自分の開発チームに
+    * ↑注意：個々人の話ではない
+  * ((*リーダブルなコードが\n
+    当たり前な文化の作り方*))を
+  * 持ち帰る
+
+= リーダブルコードの必要性
+
+  * チームの開発速度の維持のため
+    * 継続的に改良・修正したい
+    * それも現実的なコストで
+
+= 変更コストと開発速度
+
+  # image
+  # src = images/readable-code-reasonability.svg
+  # relative_width = 90
+
+== プロパティー
+
+: enable-title-on-image
+   false
+
+= 講座でやること
+
+  * コードを読む文化作りの体験
+    * まず自分が読み始める
+    * リーダブルコードを探す
+    * 他のメンバーに教える

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: rabbit-slide-Piro-readable-code-workshop-2019-09-24-introduction
+version: !ruby/object:Gem::Version
+  version: 2019.09.24
+platform: ruby
+authors:
+- YUKI Hiroshi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-20 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: 2019-09-24開催の実践リーダブルコードの概要と進め方の説明。
+email:
+- yuki@clear-code.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rabbit"
+- README.rd
+- Rakefile
+- config.yaml
+- images/readable-code-reasonability.svg
+- pdf/readable-code-workshop-2019-09-24-introduction-summary.pdf
+- summary.rab
+homepage: http://slide.rabbit-shocker.org/authors/Piro/readable-code-workshop-2019-09-24-introduction/
+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: []