わかりやすい技術記事を書くための心構えとテクニック / #railsdm 20171206

「【Rails Developers Meetup 特別編】『プロを目指す人のためのRuby入門』出版記念イベント&リファクタリングコンテスト」で使用したスライドです。

https://techplay.jp/event/647072

Transcript

1. Θ͔Γ΍͍ٕ͢ज़هࣄΛॻ͘
 ͨΊͷ৺ߏ͑ͱςΫχοΫ ҏ౻ ३Ұ
2. ࣗݾ঺հ • ҏ౻३Ұ • 1977೥େࡕ෎๛தࢢੜ·Εɺฌݿݝ੢࿬ࢢࡏॅ • גࣜձࣾιχοΫΨʔσϯ • Իָ޷͖ɺΪλʔ޷͖ • ༁ॻ Everyday Rails - RSpecʹΑΔRailsςετೖ໳ • ஶॻ ϓϩΛ໨ࢦ͢ਓͷͨΊͷRubyೖ໳ʢνΣϦʔຊʣ
3. ँࣙ • Rails Developers Meetupͷฏ໺͞Μɺݹڮ͞ΜʢΦʔΨφΠβʔʣ • גࣜձࣾSpeee͞Μʢձ৔ఏڙʣ • גࣜձࣾιχοΫΨʔσϯʢҿ৯ఏڙʣ • Έͳ͞ΜɺͲ͏΋͋Γ͕ͱ͏͍͟͝·͢ʂʂ
4. େࣄͳ͜ͱ͸ҎԼͷ4ͭ 1.ಡऀͷࢹ఺ʹཱͭ 2.ࣗ෼ͷݴ༿Ͱઆ໌͢Δ 3.ϝϦοτΛࣔ͢ 4.۩ମྫΛग़͢
5. 1. ಡऀͷࢹ఺ʹཱͭ • ॻ͖͍ͨɺͱ͍͏ؾ͚࣋ͪͩͰ͸ɺಠΓΑ͕ΓʹͳΓ͕ͪ • ಡऀͷঢ়گ΍ݱ࣌఺ͷ஌ࣝϨϕϧΛ૝૾͢Δ • ࣗ෼ͩͬͨΒͲ͏આ໌ͯ͠΄͍͔͠Λߟ͑Δ • ໨ͷલʹ୭͔͍Δؾ࣋ͪͰઆ໌͢Δ • աڈͷͰ͖ͳ͔ͬͨࣗ෼Λࢥ͍ग़͢ • ϖϧιφʢԾ૝ಡऀʣΛཱͯΔ
6. — ·ͭ΋ͱΏ͖ͻΖ ݪߘΛಡΜͰ͍ͯʮ͋͋ɺਓͷؾ͕࣋ͪΘ͔Δͱ͸ ͜͏͍͏͜ͱͳΜͩͳ͋ʯͱԿ౓΋ײ͡·ͨ͠ɻ ” “
7. 2. ࣗ෼ͷݴ༿Ͱઆ໌͢Δ • ࣗ෼ͷݴ༿Ͱɺ೉͍͠࿩Λ͔Έ͍ͩͯ͘આ໌͢Δ • ͦͷͨΊʹ͸ࣗ෼͕ͪΌΜͱཧղ͓ͯ͘͠ • ͪΌΜͱཧղͯࣗ͠෼ͷݴ༿Ͱઆ໌͢Ε͹આಘྗ͕ग़Δ • ࣗ෼ͷݴ༿Ͱઆ໌Ͱ͖ͳ͍৔߹͸ɺͪΌΜͱཧղͰ͖͍ͯͳ͍
8. 3. ϝϦοτΛࣔ͢ • ٕज़ͷʮ͓͍͠͞ʯΛ఻͑Δ • ͓͍͠͞ʹ໘ന͞ɺָ͠͞ɺ͢͝͞ɺศར͞ɺetc • ࢖͏ͱͲ͏خ͍͠ͷ͔ɺ࢖Θͳ͍ͱͲ͏ࠔΔͷ͔ • ࣮຿Ͱͷར༻γʔϯʹؔ࿈ͤ͞Δ • ʮ͋ʔɺͦ͏͍͏͜ͱɺ͋Δ͋ΔʂʯͱࢥΘͤͨΒউͪ
9. 4. ۩ମྫΛग़͢ • αϯϓϧίʔυ΍εΫϦʔϯγϣοτΛࡌͤΔ • ඦฉ͸Ұݟʹ͔ͣ͠ • આ໌͚ͩͰ΋μϝɺίʔυ͚ͩͰ΋μϝ • ࣮຿Ͱͷར༻γʔϯ͕૝૾Ͱ͖ΔྫΛߟ͑Δ • Ճ͑ͯɺγϯϓϧͰΘ͔Γ΍͍͢΋ͷ͕๬·͍͠ • ཱ྆Ͱ͖ͳ͍৔߹͸ɺ΍ΉΛ͑ͣγϯϓϧ͞ΛऔΔ͜ͱ΋͋Δ
10. ;Γ͔͑Γ 1.ಡऀͷࢹ఺ʹཱͭ 2.ࣗ෼ͷݴ༿Ͱઆ໌͢Δ 3.ϝϦοτΛࣔ͢ 4.۩ମྫΛग़͢ ݴΘΕͯΈͨΒ౰ͨΓલɺͰ΋શ෦ຬͨ͢ͷ͸೉͍͠ʂ
11. ͻͬ͘Γฦ͢ͱɺ͜͏ 1.ಠΓΑ͕ΓͰҰํతʹઆ໌͢Δ 2.Ͳ͔͜ͰԿ౓΋ฉ͍ͨΑ͏ͳઆ໌ 3.ͦͷٕज़Λ࢖ͬͯ΋Կ͕خ͍͠ͷ͔Θ͔Βͳ͍ 4.αϯϓϧίʔυ͕શ͘ͳ͍ɺ·ͨ͸࣮຿Ͱ࢖͑Δؾ͕͠ͳ͍ ΪΫοͱͯ͠Δਓɺ͍·ͤΜ͔ʁʁʢসʣ
12. ͜ͷ4ͭͷ఺Λҙࣝ͢Ε͹ɺ͋ͳͨ΋ɾɾɾʁ
13. ࠷ޙʹٕज़ॻʹ͍ͭͯগ͠
14. ٕज़ॻɺͲΕ͘Β͍ಡΜͰ·͔͢ʁ • ੲʢ15೥લ͙Β͍ʁʣ • ٕज़ॻ͕ڧ͔ͬͨ • ωοτ΋͕͋ͬͨɺࠓ΄Ͳڧ͘ͳ͔ͬͨ • ࠓ • άάΕ͹ԿͰ΋ग़ͯ͘Δ / λμͰखʹೖΔ • ΦϯϥΠϯνϡʔτϦΞϧ / ΦϯϥΠϯಈը • ϓϩάϥϛϯάεΫʔϧ • ٕज़ॻʹཔΒͳͯ͘΋ֶ΂Δ࣌୅
15. ͦΕͰ΋ಡΉՁ஋͸͋Δ͔ʁˠ͋Δʂ • ମܥͩͬͨ஌ࣝΛखʹೖΕΒΕΔ • ωοτͷ৘ใʹͭ·Έ৯͍ͷ܁Γฦ͠ • ٕज़ॻʹҰྲྀϨετϥϯͷϑϧίʔε • ͭ·Έ৯͍͚ͩͰҰྲྀγΣϑʹͳΕΔ͔ʁ • ஶऀͷ๲େͳܦݧͱ஌ࣝΛखʹೖΕΒΕΔ • ࣗྗͰͦͷ஌ࣝΛಘΔͨΊʹ͔͔Δ࣌ؒΛ૝૾͢Ε͹͍҆ • άάͬͯ΋ग़ͯ͜ͳ͍৘ใ͕ଟ͍΄ͲɺͦͷຊͷՁ஋͸ߴ͍ • ٕज़ॻͱͦΕҎ֎ͷखஈΛ্खʹ૊Έ߹ΘͤΑ͏
16. ࠓ೔ͷ·ͱΊ • Θ͔Γ΍͍ٕ͢ज़هࣄΛॻͨ͘Ίʹ 1.ಡऀͷࢹ఺ʹཱͭ 2.ࣗ෼ͷݴ༿Ͱઆ໌͢Δ 3.ϝϦοτΛࣔ͢ 4.۩ମྫΛग़͢ • ٕज़ॻͷՁ஋ • ମܥͩͬͨ஌ࣝΛखʹೖΕΒΕΔ • ஶऀͷ๲େͳܦݧͱ஌ࣝΛखʹೖΕΒΕΔ • ٕज़ॻͱͦΕҎ֎ͷखஈΛ্खʹ૊Έ߹ΘͤΑ͏
17. ͝ਗ਼ௌ͋Γ͕ͱ͏͍͟͝·ͨ͠