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

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5e7b9dfe9f2be7b54c8fa383e730fc5fea5fbe900ada788d46120d3c1b8f1f2f
+  data.tar.gz: 39449dda8d85830ccd3519e50c39a2aea1e63cfb657e5569b872473af0360cd9
+SHA512:
+  metadata.gz: 758551305bdc886d80d5849e8e84fb26298a9af971ca3876f4adc4182dc91991d94231f46c1aa35a039688457f57efbebb56b53bf1fc9f2079f25faa3ee395f7
+  data.tar.gz: 1f033baede6c5bf76075c03a423b8b979ec01a91447921dc7db1ba65236de61df3e610fb3f0c12271d9a9b60cd1b264d0ae4a5e57578cee6b0bc82b1a54e8c8e

data/.rabbit

@@ -0,0 +1 @@
+next-step.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-conclusion
+
+=== 表示
+
+  rabbit rabbit-slide-piroor-readable-code-workshop-2019-09-24-conclusion.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,23 @@
+---
+id: readable-code-workshop-2019-09-24-conclusion
+base_name: next-step
+tags:
+- rabbit
+- readable-code
+- sezemi
+presentation_date: 2019-09-24
+version: 2019.09.24
+licenses:
+- CC BY-SA 4.0
+slideshare_id: readable-code-workshop-2019-09-24-conclusion
+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/next-step.rab

@@ -0,0 +1,191 @@
+= まとめと次のステップ
+
+: author
+   結城洋志
+: institution
+   株式会社クリアコード
+: content-source
+   実践リーダブルコード
+: date
+   2019-09-24
+: allotted-time
+   30m
+: theme
+   clear-code
+
+= 講座の目的
+
+  * 自分の開発チームに
+  * ((*リーダブルなコードが\n
+    当たり前な文化の作り方*))を
+  * 持ち帰る
+
+= リーダブルコードの必要性
+
+  * チームの開発速度の維持のため
+    * 継続的に改良・修正したい
+    * それも現実的なコストで
+
+= 変更コストと開発速度
+
+  # image
+  # src = images/readable-code-reasonability.svg
+  # relative_width = 90
+
+== プロパティー
+
+: enable-title-on-image
+   false
+
+= 文化の作り方の流れ（1）
+
+  * チームでリーダブル基準を育む
+    * 「読む人」が\n
+      読みやすいなら\n
+      リーダブル
+    * 「読む人」が変われば基準が変わる
+    * →読む人が違うのでチーム毎に違う
+
+= 文化の作り方の流れ（2）
+
+  * 基準の育て方
+    * 各メンバーがコードを読む
+    * リーダブルだと思ったコードを共有
+    * チームとしてリーダブルかを判断
+    * →チームの基準に加わる
+
+= 基準の育て方（1）
+
+  * コードを読む文化を作る
+    * まず自分が読み始める
+    * リーダブルなコードを探す
+    * 見つけたリーダブルなコードを\n
+      他のメンバーに伝える(('note:（後述）'))
+    * →コードが読まれるという自覚が\n
+      チームに浸透
+
+(('tag:center'))
+(('note:今日やったのはここまで'))
+
+= 基準の育て方（2）
+
+(('tag:center'))
+(('note:次のステップ'))
+
+  * コミットを読む
+    * コード全体ではなく差分を読む
+    * 設計の仕方ではなく\n
+      開発の仕方が見える
+    * リーダブルなコードを\n
+      見つけるには適切
+
+= 基準の育て方（3）
+
+  * コミットの読み方
+    * pull型よりpush型がよい\n
+      (('note:（Git用のオススメツールあり：git-commit-mailer）'))\n
+      (('note:（Subversion用のツールもあり：同梱されている）'))
+    * 読むコストが下がる
+    * 流し読む（負担が多いと続かない）
+    * 問題探し視点では読まない\n
+      (('note:（必要ならコードレビューを実施）'))
+
+= 基準の育て方（4）
+
+  * リーダブルコードの伝え方
+    * Wikiに書く（全チームで有効）
+    * コードで伝える（上級チーム向け）
+
+= 基準の育て方（5）
+
+  * Wikiに書いて伝える
+    * Wikiもdiffを通知できるようにする\n
+      (('note:（RedmineとGitHub用はツールあり）'))
+    * 後で参照できるため
+    * 更新もできるため\n
+      (('note:（リーダブルコードの基準は変わることもある！）'))
+
+= 基準の育て方（6）
+
+  * コードで伝える
+    * 上級チーム向け\n
+      (('note:（チームにコードを読む文化が根付いた後）'))
+    * リーダブルコードを真似てコミット
+    * →他の人：「またこの書き方だ」
+    * →真似する人増加→チームが合意
+    * →チームが合意→Wikiにまとめる
+
+= コードを読む文化
+
+  * 新人の受け入れにも有用
+  * 人の入れ替えにも有用
+
+= どうして有用か
+
+(('tag:center'))
+開発を通じて↓を伝えられる\n
+(('note:（ただし、上級チームになってから）'))
+
+  * チームが大事にしていること
+    * チームのリーダブル
+    * チームの開発スタイル
+
+= コードを読む文化
+
+(('tag:center'))
+チームが大事にしていることを\n
+開発を通じて伝えられる\n
+↓
+
+  * 新人の受け入れにも有用
+    * 開発速度低下を抑えられる
+  * 人の入れ替えにも有用
+    * リーダブル見直しのよい機会
+
+= これからやること
+
+  * この講座をチームでもやる
+    * 資料はすべて再利用可能
+  * 自分がコードを読み始める
+    * 自分が変更するコードの周辺から\n
+      リーダブルコードを探す
+    * 見つけたリーダブルなコードを\n
+      他のメンバーに伝える
+
+= サポート（1）
+
+  * 今日の資料はすべて再利用可能
+    * チーム内で同じ講座をできる
+  * 無料のフォローアップ面談
+    * チームで実践→悩み\n
+      ↑の相談に乗る
+    * 受講後3ヶ月以内、1回限り
+
+= サポート（2）
+
+  * コミット読みの支援
+    * OSSとしてツールを公開
+    * コミット毎にメールで通知(('note:（diff入り）'))
+    * Git、Subversionで使える
+    * GitHub、GitLab連携もできる
+
+= おしらせ
+
+(('tag:center'))
+コードリーダー育成支援\n
+(('note:http://www.clear-code.com/services/code-reader/'))
+
+(('tag:center'))
+リーダブルなコードが\n
+当たり前な文化づくりを支援
+
+= クリアコード
+
+  * クリアなコードが大切
+    * クリア == clear == 意図が明確
+    * クリアなコードはリーダブルコード
+
+(('tag:center'))
+みなさんのチームが\n
+リーダブルコードが当たり前な\n
+チームになることを応援します！

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: rabbit-slide-Piro-readable-code-workshop-2019-09-24-conclusion
+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
+- next-step.rab
+- pdf/readable-code-workshop-2019-09-24-conclusion-next-step.pdf
+homepage: http://slide.rabbit-shocker.org/authors/Piro/readable-code-workshop-2019-09-24-conclusion/
+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: []