Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
人の役に立ちたい一心でドキュメントを改善してみたら思っていた以上に効果が出た話
Search
HikaruMaruyama
May 19, 2017
Programming
5
2k
人の役に立ちたい一心でドキュメントを改善してみたら思っていた以上に効果が出た話
HikaruMaruyama
May 19, 2017
Tweet
Share
More Decks by HikaruMaruyama
See All by HikaruMaruyama
OSS CMS「Drupal 10」 エッセンシャル:最新版でのWeb開発の魅力を探る #oscnagoya
hmaruyama
0
260
スタイリッシュでモダンな「Gin」管理テーマの紹介 #drupal_haneda
hmaruyama
0
210
DrupalのWeb Profiler #drupal_haneda
hmaruyama
0
320
非エンジニアから開発者まで!DrupalPodを使用したDrupal環境の作成
hmaruyama
1
320
Drupal認定試験にチャレンジしよう!アクイア認定プログラムのご紹介 / introduction of Acquia Drupal Certification Program
hmaruyama
0
970
「Docker/Kubernetes実践コンテナ開発入門」学習のポイント #dockerbg / 20191108
hmaruyama
0
130
enebularでobnizを Lチカ してみた #enebular / 20181122
hmaruyama
0
570
駅すぱあとWebサービス連携ハンズオンパート ノンプログラミングでClovaスキルハンズオン&お茶会 #linebootawards #Clova_CEK / 20180919
hmaruyama
1
620
Agent Friends Xperia Ear Duoで誰でも コミュニケーションにコミット #linebootawards / 20180826
hmaruyama
0
110
Other Decks in Programming
See All in Programming
テストから始めるAgentic Coding 〜Claude Codeと共に行うTDD〜 / Agentic Coding starts with testing
rkaga
14
5.1k
The Niche of CDK Grant オブジェクトって何者?/the-niche-of-cdk-what-isgrant-object
hassaku63
1
390
なぜ適用するか、移行して理解するClean Architecture 〜構造を超えて設計を継承する〜 / Why Apply, Migrate and Understand Clean Architecture - Inherit Design Beyond Structure
seike460
PRO
3
780
チームで開発し事業を加速するための"良い"設計の考え方 @ サポーターズCoLab 2025-07-08
agatan
1
440
テスト駆動Kaggle
isax1015
1
480
ruby.wasmで多人数リアルタイム通信ゲームを作ろう
lnit
3
500
Google Agent Development Kit でLINE Botを作ってみた
ymd65536
2
260
型で語るカタ
irof
0
230
20250704_教育事業におけるアジャイルなデータ基盤構築
hanon52_
5
880
Python型ヒント完全ガイド 初心者でも分かる、現代的で実践的な使い方
mickey_kubo
1
150
MDN Web Docs に日本語翻訳でコントリビュートしたくなる
ohmori_yusuke
1
130
VS Code Update for GitHub Copilot
74th
2
660
Featured
See All Featured
Connecting the Dots Between Site Speed, User Experience & Your Business [WebExpo 2025]
tammyeverts
6
320
Code Review Best Practice
trishagee
69
19k
Become a Pro
speakerdeck
PRO
29
5.4k
Navigating Team Friction
lara
187
15k
StorybookのUI Testing Handbookを読んだ
zakiyama
30
5.9k
Rebuilding a faster, lazier Slack
samanthasiow
83
9.1k
Chrome DevTools: State of the Union 2024 - Debugging React & Beyond
addyosmani
7
740
Designing for Performance
lara
610
69k
Typedesign – Prime Four
hannesfritz
42
2.7k
Gamification - CAS2011
davidbonilla
81
5.4k
VelocityConf: Rendering Performance Case Studies
addyosmani
332
24k
Sharpening the Axe: The Primacy of Toolmaking
bcantrill
44
2.4k
Transcript
ਓͷʹཱ͍ͪͨҰ৺Ͱ υΩϡϝϯτΛվળͯ͠ΈͨΒ ࢥ͍ͬͯͨҎ্ʹޮՌ͕ग़ͨ API Meetup Fukuoka ؙࢁ ͻ͔Δ
None
None
ࣗݾհ • גࣜձࣾϰΝϧݚڀॴ • ؙࢁ ͻ͔Δ • ςΫχΧϧΤόϯδΣϦετ • ਆಸݝ૬ݪࢢࡏॅ
ܦྺ 20144݄ 20147݄ 20157݄ 2017݄1݄ ϰΝϧݚڀॴ ೖࣾ WebAPIʮӺ͢ͺ͋ͱwebαʔϏεʯ ։ൃϝϯόʔʹ ৽ػೳ։ൃอकɺج൫ͷվम
υΩϡϝϯτվળνʔϜͷҰһʹ ձࣾॳ ςΫχΧϧΤόϯδΣετʹ
2014
None
WebAPIͷ෦ॺʹଐ • ૣ͘νʔϜʹೃછΈ͍ͨ • Կ͔Βͳ͍ɺ͕ࣝͳ͍
ͦ͏ͩɺLTΛ͠Α͏
ࣾLTͷࢀՃ • αʔϏεͷࣝΛਂΊΔͨΊʹ • Πϯϓοτ͢ΔʹΞτϓοτ͕Ұ൪ • ࣦഊ͢ΔͳΒࠓ͔͠ͳ͍ • ࣾͰ݄ʹ̍ճߦΘΕΔLTʹ 5ճ࿈ଓͰࢀՃ͢Δ͜ͱΛܾҙ
LT༰ͷࡧ ʮͦ͏͍͑͏ͪͷυΩϡϝϯτɺ ٯҾ͖ϦϑΝϨϯεతͳͷͬͯͳ͍ΜͰ͢Ͷɻ ྫ͑ɺ͋Δܦ࿏Λఆظ݊Λར༻ͯͬͨ͠ͱ͖ͷ ӡܭࢉ͕͍ͨ࣌͠ʹɺAPIͷ༷͔Β ࣗͰ୳͞ͳ͍ͱ͍͚ͳ͍ΜͰ͢Ͷɻʯ ʮ͔֬ʹݴΘΕͯΈΕͦ͏ͩͶɻ͏ͪͷWebAPIͬͯ ͍ํ͕ෳࡶ͔ͩΒɺ͋ΔͱศརͩͶɻʯ
ͦΕͩʂ
• ࣾһͷԠ • ؒతͳϑΟʔυόοΫ • ࣾͰ Ӻ͢ͺ͋ͱWebαʔϏεʹ ؙࢁʁ • WebAPIͷֶͼ
• ײతͰͳ্͍ʹ υΩϡϝϯτ؆ૉ • Ӻ͢ͺ͋ͱWebαʔϏεʹ Θ͔ΓͮΒ͍WebAPI
2015
;ͱͨ͠ձ͔Β ʮSSLରԠ͔ͨ͠ΒυΩϡϝϯταΠτʹࡌ͓͍ͤͯͯʔʯ ʮͲ͜ʹࡌͤΔΜͰ͔͢ɻࠓAPIͷ༷͔͠ࡌͤͯͳ͍͔Βɺࡌͤ Δͱͨ͠Β৽͘͠ίϯςϯπΛ࡞Δඞཁ͕͋ΔΜ͡Όͳ͍Ͱ͔͢ʁʯ ʮ͔֬ʹಋೖ෦ͷ͍߹Θͤଟ͍͠ʲελʔτΞοϓΨΠυʳͱ ͔ཉ͍͠Ͷ͑ʯ ʮSSLରԠͷ݅ʲΑ͋͘Δ͓͍߹ΘͤʳͰٵऩͰ͖ͦ͏Ͱ͢ Ͷʂʯ ʮίϯςϯπΛ૿͢ͳΒɺӦۀͱαϙʔτʹ૬ஊͯ͠ΈͨΒʁ Ϣʔβͷ૭ޱʹͳͬͯΔ͔Βʯ
ͦΕͩʂ(2ճ)
υΩϡϝϯτվળʹ औΓΉ͜ͱʹ
υΩϡϝϯτվળνʔϜ݁ • ݁ͷܦҢ • Ӧۀ෦ॺͷਓʹ૬ஊͨ͠ΒɺʮੋඇΓ͍ͨʂʯͱݴ͏ਓΛ հͯ͘͠Εͨ • Ӧۀ෦ॺͷਓ͕αϙʔτ෦ॺͷਓΛݺΜͰ͘Εͨ • νʔϜฤ
• Ӻ͢ͺ͋ͱwebαʔϏεͷӦۀΛ୲͢Δ෦ॺɹɹɿ1ਓ • Ӻ͢ͺ͋ͱwebαʔϏεͷαϙʔτΛ୲͢Δ෦ॺɿ1ਓ • Ӻ͢ͺ͋ͱwebαʔϏεͷ։ൃΛ୲͢Δ෦ॺɹɹɿ1ਓ • ӡ༻ • ݄1ճͷఆྫMTG • త • Ӻ͢ͺ͋ͱwebαʔϏεͷՁ্
ԿΛվળ͢Δʁ
࠷ͳWebAPIυΩϡϝϯτ
• ι͔ͬΓ • ߋ৽͞Εͳ͍ • ߋ৽ཤྺ͕ͳ͍ • ઐ༻ޠͷઆ໌ͳ͠ • ౷Ұੑ͕ͳ͍
• ٯҾ͖͕ͳ͍ • ཉ͍͠ใ͕ݟ͔ͭΒͳ͍ • ԿΛͬͨΒ͓͔͔ۚΔ͔͔Βͳ͍ • ԿΛ͑Δͷ͔͔Βͳ͍ • ϑϦʔϓϥϯ/ελϯμʔυϓϥϯͷυΩϡϝϯταΠτ͕ࠅࣅ͍ͯͯ͠ ۠ผ͠ʹ͍͘ ࠷ͳWebAPIυΩϡϝϯτ
ඇΤϯδχΞͱҰॹʹ GithubͰཧ • όʔδϣϯཧ͞Ε͍ͯͳ͔ͬͨυΩϡϝϯτͷιʔείʔυΛ GithubཧԼʹ • υΩϡϝϯτվળνʔϜʹGithubͰϓϧϦΫΛ֬ೝͯ͠΄͍͠ͱએݴ • ͢ΜͳΓOK͞ΕɺΞΧϯτΛऔಘͯ͠Β͏ •
ஸೡͳϨΫνϟʔ • ϓϧϦΫͷ֬ೝํ๏ • ίϝϯτͷํ • ઈରʹԡͪ͠Ό͍͚ͳ͍Ϙλϯ (mergeϘλϯ)
ςεταΠτͷ༻ҙ • ඇΤϯδχΞ͕GithubͰϓϧϦΫΛ ֬ೝͯ͠Β͍͘͢͢ΔͨΊ • ιʔείʔυ͚ͩͩͱɺϨΠΞτ͕བྷΉ ϓϧϦΫΛ֬ೝ͢Δ͜ͱ͕Ͱ͖ͳ͍ • AWS S3ʹςεταΠτ༻ͷBucketΛ༻ҙ͠ɺ
࡞ۀϒϥϯνͷ༰Λөͤͨ͞
ࣗಈσϓϩΠ • ϓϧϦΫ͕Ϛʔδ͞ΕΔͨͼʹɺຖճAWS S3ʹ खಈͰϑΝΠϧΛΞοϓϩʔυ͢Δͷ ໘͍҆͘͞͠શ͡Όͳ͍ • Wercker(CIπʔϧ)Λͬͯ σϓϩΠࣗಈԽͷઃఆΛߦ͏ •
࡞ۀ͕அવָʹ
੩తαΠτδΣωϨʔλಋೖ • ͕ੵΈ্͕͍ͬͯͨ • googleΞφϦςΟΫεΞϯέʔτϑΥʔϜΛҰ෦ͷ ϖʔδʹ͔͠औΓೖΕΒΕͳ͍ • ૉͷhtmlΛվม͠ଓ͚Δ͜ͱ݈શͰͳ͍ • υΩϡϝϯτmarkdownͰཧ͍ͨ͠
• middlemanಋೖ • html͔ΒmarkdownͷมखͰߦͬͨ(ল)
վળͷޮՌ
։ൃαϙʔτۀͷܰݮ • νέοτͷਪҠ • 39ظ(վળલ)ͷ߹ܭɿ178 • 40ظ(վળޙ)ͷ߹ܭɿ141 → 20%ݮ
Ϣʔβͷฦ৴͕εϜʔζʹ
Ϣʔβ͔ΒϑΟʔυόοΫ • υΩϡϝϯτ͕Θ͔Γ͍͢͜ͱͰɺϢʔβͷ ։ൃίετ͕ܰݮ • ಋೖࣄྫͰυΩϡϝϯτ͕๙ΊΒΕΔΑ͏ʹ
ͬͨͥʂ
υΩϡϝϯτվળͯ͠Έͯ • Ϣʔβ͔ΒͷϑΟʔυόοΫ͕Ϟνϕʔγϣϯʹ • αϙʔτରԠ࣌ؒΛଞͷ͜ͱʹ͑Δ • औΓΉதͰ͕ࣝ૿͑ͨ
ͦΕҎ֎ʹ • υΩϡϝϯτ͕ྑ͘ͳ͚ͬͨͩͰͳ͘ • νʔϜͷதͰɺࢲҎ֎ʹυΩϡϝϯτͷ ϓϧϦΫΛࣗओతʹग़ͯ͘͠ΕΔ • ։ൃҎ֎ͷਓͱू·Δ͕࣌ؒ૿͑ɺ ใڞ༗ͷͱͳͬͨ
ৼΓฦͬͯΈΔͱ
Կ͔Βͳ͔ͬͨ࣌ • Ͱ͖ͦ͏ͳ͜ͱ͔ΒͬͯΈͨ • ࣾLT • ࣝͷٵऩ • ࣾһͱͷձ͕ੜ·ΕΔ •
υΩϡϝϯτվળʹͭͳ͕ͬͨ • …etc
Thank you!
͓ؼΓͷࡍ Ӻ͢ͺ͋ͱΞϓϦͰ