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

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a396558d69419f3d0f786e78fdd5c83f44ad99c4fa0f152293a79a0b019d4dea
+  data.tar.gz: b90a4b6efa347b75853e48b6412c7acbe76bdc7d00c87961728d54a7553928c9
+SHA512:
+  metadata.gz: e65521f1e03c0af88548934baf52dd42941c622430500f76c2963047fdbeb2e6db30d83bd842c4134b6a41afc52c5329cc1274ae060e9b949e635be5267871f0
+  data.tar.gz: 9c255a1a88364fa907a02dd5689f0ad5330a413f30e31050bfd723fbeab51b57da7b65277da53e2c4a8ca8f5ed8058ed00fad16415d9cf6e5531b9534bd6861b

data/.rabbit

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

data/README.rd

@@ -0,0 +1,32 @@
+= リーダブルコード演習の概要
+
+2022-08-04開催のリーダブルコード演習の概要と進め方の説明。
+
+== ライセンス
+
+CC-BY-SA-4.0
+
+原著作者名は以下の通りです。
+
+  * 株式会社クリアコード
+
+== 作者向け
+
+=== 表示
+
+  rake
+
+=== 公開
+
+  rake publish
+
+== 閲覧者向け
+
+=== インストール
+
+  gem install rabbit-slide-piroor-readable-code-workshop-2022-08-04-introduction
+
+=== 表示
+
+  rabbit rabbit-slide-piroor-readable-code-workshop-2022-08-04-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-2022-11-02a-introduction
+base_name: summary
+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-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/introduction.rab

@@ -0,0 +1,331 @@
+= 概要
+
+: author
+   結城洋志
+: institution
+   株式会社クリアコード
+: content-source
+   実践リーダブルコード
+: date
+   2022-11-02
+: allotted-time
+   30m
+: theme
+   clear-code
+
+= 全体の流れ
+
+  * 概要と進め方の説明
+  * 実装
+  * 実装を交換、続きを実装
+  * 全体で結果を共有
+
+== ノート
+
+まず最初に、全体の大まかな予定を示すが、ここはサッと流す。
+進行の進行度合いによっては、実装作業の時間を長めに取る可能性があることを伝える。
+
+
+= 講師紹介
+
+(('tag:center'))(('tag:margin-bottom * 2'))
+結城洋志（ゆうき ひろし）\n
+aka Piro
+
+  * 株式会社クリアコード所属
+  * FirefoxやThunderbirdの\n
+    法人サポートに従事
+    * トラブルの原因や対策を探るため\n
+      ソースコードを調査することが多い
+
+== ノート
+
+Mozilla FirefoxはWebブラウザー。
+Mozilla Thunderbirdはメールクライアント。
+
+開発元のMozillaは、企業ユーザーからのトラブル問い合わせなどに回答するサービスは提供していない。
+そのため、クリアコードのような事業者が、ある意味で勝手にサポートサービスを行っている。
+クリアコードは10人未満の小規模事業者で、エンドユーザーからの電話問い合わせに対応するといったビジネスはできないので、そうではなく、企業の情報システム担当者や、大学であればシステム管理者といったレベルの方が、ある程度までは自分達で対応した上で、それでもまだ分からないことを問い合わせる（エスカレーションする）先としてテクニカルサポートを提供している。
+
+FirefoxもThunderbirdも、自分達が作っている物ではないし、作っている人達は企業ユーザーの実際の利用の仕方を知らないので、企業ユーザー向けの技術資料といった物も特にない。
+よって、問い合わせを受ける度にソースコードを読んで調査することになる。
+「リーダブルなコード」の恩恵を非常に強く受ける立場だと言える。
+
+= アジェンダ
+
+  * ((*講座の目的*))を確認
+  * リーダブルコードの\n
+    ((*必要性*))を確認
+  * リーダブルコードの\n
+    ((*実践方法*))を紹介
+  * 実践方法を((*練習*))
+
+
+= 講座の目的
+
+  * 自分の開発チームに
+    * (('note:注：個々人の話ではない'))
+  * ((*リーダブルなコードが\n
+    当たり前な文化の作り方*))を
+  * 持ち帰る
+
+(('tag:center'))
+(('note:→ 「解説」に書いていることの実践方法を学ぶ'))
+
+= 目的でないこと
+
+  * 実践前の不安のケア
+    * 「やる」と決めないと理解が進まない
+  * テクニックをたくさん覚える
+  * 難しいプログラムを実装する
+  * 早解きや実行時性能の追求
+  * 奇抜な方法で目立つ
+
+= ワークショップ後
+
+  * ぜひ実践を！
+  * 今日の資料はすべて再利用可能
+    * チーム内で同じ講座を再現できる
+
+= 　
+
+= そもそもの話
+
+  * リーダブルコードは\n
+    なぜ必要か
+
+= リーダブルコードのニーズ
+
+チーム開発を\n
+無理なく\n
+続けるため
+
+= チーム開発でのニーズ
+
+  * 既存のコードを読んで\n
+    ((*素早く内容を把握したい*))
+  * 既存のコードに\n
+    ((*素早く手を加えたい*))
+  * ((*開発速度*))を落としたくない
+
+= 読みにくいと開発が遅くなる
+
+  * 既存のコードを\n
+    理解しにくいと……
+    * 修正・機能追加に時間がかかる\n
+      (('note:（理解しないと変更できない）'))
+    * 後退バグが発生しやすい\n
+      (('note:（理解しないまま変更すると問題発生）'))
+
+(('tag:center'))
+→((*コストがかかる*))
+
+= 時間が経つほど影響大
+
+  # image
+  # src = images/readable-code-reasonability.svg
+  # relative_width = 90
+
+(('tag:center'))
+(('note:（注意：グラフではなく概念図です）'))
+
+== プロパティー
+
+: enable-title-on-image
+   false
+
+== ノート
+
+「保守性を犠牲にして開発する場合と、保守性を高く保って開発する場合に、曲線が交差する点（つまり損益分岐点）には1ヵ月くらいで到達する」と言われている。
+
+1ヵ月という数字の出典：
+質とスピード（2020秋100分拡大版） / Quality and Speed 2020 Autumn Edition
+https://speakerdeck.com/twada/quality-and-speed-2020-autumn-edition
+
+= つまり
+
+  * 現実的なコストの範囲で
+  * 既存のコードを継続的に、\n
+    無理なく改良・修正したい
+
+(('tag:center'))
+→なので、リーダブルコード
+
+= 　
+
+= リーダブルコードの実践
+
+(('note:どうすれば無理なく実践できる？'))
+
+= リーダブルコードの実践
+
+コードを((*読む*))\n
+習慣を作る
+
+= 読む？書くじゃないの？
+
+  * リーダブルコードを書くには\n
+    コードを読むことが欠かせない
+    * なぜ？
+
+(('wait'))
+(('tag:center'))
+↓\n
+読まないと\n
+何が「読みやすい」か\n
+分からないから
+
+= 何が「良い」かは受け手の状況次第
+
+  * しょっぱいのが好きな人と\n
+    甘いのが好きな人で\n
+    「おいしい」の基準は違う
+    * 自分はどんな味が好みか？
+  * 日常の運転とレースでは\n
+    「乗りやすい」の基準は違う
+    * 自分はどんな乗り方をするのか？
+
+= リーダブルコードも同じ
+
+  * チームの状況によって\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
+    という認識を広める
+  * 自分だけからチームへ
+    * 「このチームはコードを読み合う」\n
+      という認識を広める
+
+(('tag:center'))
+…続きはセミナーの最後に
+
+
+= この後の実践
+
+(('tag:center'))
+開発を続けるために\n
+((*他の人のコードを読む*))
+
+  * まず自分が読み始める
+  * リーダブルコードを探す\n
+    (('note:（読みにくいコードは今は置いておく）'))
+  * リーダブルの基準を共有\n
+    (('note:（チームでのリーダブルコードができる）'))
+
+= やること
+
+読む文化作りの\n
+体験
+
+= 読む文化作りの体験
+
+  * 10:45-12:15 課題を実装
+    * リーダブルコードを書く
+  * 13:30-14:45 実装チェンジ\n
+    　　　　　　→開発継続
+    * 「まず自分が読み始める」
+    * 「リーダブルコードを探す」
+  * 15:00- グループふりかえり
+    * 「他のメンバーに教える」
+
+= おさらい
+
+  * この講座の目的
+  * リーダブルコードの必要性
+  * この講座でやること
+
+= この講座の目的
+
+  * 自分の開発チームに
+    * ↑注意：個々人の話ではない
+  * ((*リーダブルなコードが\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-2022-11-02a-introduction
+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-04開催のリーダブルコード演習の概要と進め方の説明。
+email:
+- yuki@clear-code.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rabbit"
+- README.rd
+- Rakefile
+- config.yaml
+- images/readable-code-reasonability.svg
+- introduction.rab
+- pdf/readable-code-workshop-2022-11-02a-introduction-summary.pdf
+homepage: http://slide.rabbit-shocker.org/authors/Piro/readable-code-workshop-2022-11-02a-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: []