Upgrade to Pro — share decks privately, control downloads, hide ads and more …

技術を分かりやすく伝える9種類のコンテンツ / Types of content for development documents

技術を分かりやすく伝える9種類のコンテンツ / Types of content for development documents

テクニカルライティングとは、「ある技術について、読者に分かりやすく伝える手法」のことをいいます。開発ドキュメントにおいて、技術を伝えるコンテンツとしては、いわゆるドキュメント形式のもの以外にも、チュートリアルや用語集、プレイグラウンドといった、さまざまな形式があります。このようなコンテンツの種類について、実際の例をもとに学んでいきます。このセッションを通して、技術を伝える表現の幅が広がればうれしいです。

銭神裕宜(@zenizh) / LINE株式会社 Developer Contentチーム テクニカルライター

こちらの資料は以下イベントで発表されました。
https://line.connpass.com/event/261765/

LINE Developers
PRO

October 13, 2022
Tweet

More Decks by LINE Developers

Other Decks in Technology

Transcript

  1. LINE Corporation Developer Content Team Hiroki Zenigami (@zenizh) ٕज़Λ෼͔Γ΍͘͢఻͑Δ9छྨͷίϯςϯπ LINE

    Technical Writing Meetup vol. 17 2022.10.13
  2. ͜Μͳਓʹ͓͢͢Ί • ٕज़৘ใͷ఻͑ํʹ೰ΜͰ͍Δਓ • ࣾ಺޲͚ͷ։ൃυΩϡϝϯτΛΑΓΑ͍ͨ͘͠ਓ • ։ൃυΩϡϝϯταΠτͷӡӦΛ୲౰͍ͯ͠Δਓ 2

  3. ͜Μͳ೰Έ͸ͳ͍Ͱ͔͢ʁ • ॻ͍ٕͨज़৘ใ͕ͳΜͱͳ͘෼͔ΓͮΒ͍ • ։ൃυΩϡϝϯτͷߏ੒Λݟ௚͍͚ͨ͠Ͳɺ 
 Ͳ͏͢Ε͹͍͍͔෼͔Βͳ͍ 3

  4. ೰ΈΛղܾ͢Δʹ͸ • ։ൃυΩϡϝϯτΛॻ͘ʹ͋ͨͬͯɺ 
 ίϯςϯπͷछྨΛ஌͓ͬͯ͘ 4

  5. ࣗݾ঺հ • Hiroki Zenigami (@zenizh)͋ • LINEגࣜձࣾ ςΫχΧϧϥΠλʔ • ݩΤϯδχΞ

    • ڞஶʮݱ৔Ͱ࢖͑ΔRuby on Rails 5ʢϚΠφϏग़൛ʣʯ • 2013೥͔Βٕज़ϒϩάΛӡӦ 5
  6. ࿩ͷྲྀΕ • ୈҰ෦ɿ։ൃυΩϡϝϯταΠτͷࣄྫ • ୈೋ෦ɿίϯςϯπͷछྨ • ୈࡾ෦ɿಋೖʹ͓͚Δߟ͑ํ 6

  7. ୈҰ෦ ։ൃυΩϡϝϯταΠτͷࣄྫ

  8. ᶃ Next.js

  9. Showcase - Next.js https://nextjs.org/showcase

  10. Getting Started - Next.js https://nextjs.org/docs/getting-started

  11. Templates - Next.js https://vercel.com/templates/next.js

  12. ᶄ Nuxt

  13. The Context - Nuxt https://nuxtjs.org/docs/internals-glossary/context/

  14. Explore Nuxt Modules - Nuxt https://modules.nuxtjs.org/

  15. ᶅ Stripe

  16. Prebuilt Checkout page - Stripe https://stripe.com/docs/checkout/quickstart

  17. Stripe Payment Element - Stripe https://stripe.com/docs/payments/payment-element

  18. ᶆ LINE Developers site

  19. Minimizing LIFF browser - LINE Developers https://developers.line.biz/en/docs/li ff /minimizing-li ff

    -browser/
  20. Messaging API reference - LINE Developers https://developers.line.biz/en/reference/messaging-api/#get-pro fi le-playground

  21. FAQ - LINE Developers https://developers.line.biz/en/faq/

  22. ୈೋ෦ ίϯςϯπͷछྨ

  23. ίϯςϯπͷҰཡ 23 1 ٕज़Λઆ໌͢Δίϯςϯπ • νϡʔτϦΞϧ • ϦϑΝϨϯε • υΩϡϝϯτ

    2 આ໌Λิ଍͢Δίϯςϯπ • ༻ޠू • FAQ͋ • ϓϨΠάϥ΢ϯυ 3 ٕज़ʹؔ͢Δ۩ମతͳࣄྫ • γϣʔέʔε • ࣮૷ྫ • ίϛϡχςΟ
  24. ᶃ ٕज़Λઆ໌͢Δίϯςϯπ

  25. • ࣮ફΛ௨ͯ͠ɺجຊతͳ஌ࣝͷ शಘΛΊ͟͢ • ॳڃऀ޲͚ νϡʔτϦΞϧ 25 https://nextjs.org/learn/foundations/about-nextjs

  26. • ٕज़ͷΑΓৄࡉͳ࢓༷ ϦϑΝϨϯε 26 https://docs.github.com/en/rest/actions/artifacts

  27. • ੡඼Λར༻͢Δʹ͋ͨͬͯ஌ͬͯ ͓͘΂͖͜ͱ υΩϡϝϯτ 27 https://www.contentful.com/developers/docs/concepts/apis/

  28. ᶄ આ໌Λิ଍͢Δίϯςϯπ

  29. • ༻ޠʹ͍ͭͯͷઆ໌Λ·ͱΊͨ ΋ͷ • πʔϧνοϓͳͲͰఏࣔ͢Δ ༻ޠू 29 https://stripe.com/docs/payments/quickstart

  30. • ࣭໰ͱͦͷ౴͑Λ·ͱΊͨ΋ͷ FAQ 30 https://support.stripe.com/questions/trouble-signing-in

  31. • ٕज़Λ࣮ࡍʹࢼͤΔػೳ ϓϨΠάϥ΢ϯυ 31 https://daisyui.com/docs/themes/

  32. ᶅ ٕज़ʹؔ͢Δ۩ମతͳࣄྫ

  33. • ٕज़͕࢖ΘΕ͍ͯΔࣄྫ • اը୲౰ऀͳͲɺଞͷ৬छͷਓ ΋૝ఆͨ͠ίϯςϯπ γϣʔέʔε 33 https://nuxtjs.org/showcases/

  34. • ಛఆͷϢʔεέʔεʹؔ͢Δ࣮૷ Λ঺հ͢Δίϯςϯπ ࣮૷ྫ 34 https://vercel.com/templates/next.js/isr-blog-nextjs-wordpress

  35. • ίϛϡχςΟ͕࡞੒ͨ͠ϥΠϒ ϥϦͳͲΛ঺հ͢Δ ίϛϡχςΟ 35 https://developers.line.biz/en/docs/messaging-api/line-bot-sdk/

  36. ୈࡾ෦ ಋೖʹ͓͚Δߟ͑ํ

  37. ಡऀ͸୭ʁͲΜͳ೰ΈΛ΋͍ͬͯΔʁ • ಡऀͷ೰ΈʹԠͨ͡ίϯςϯπΛఏڙ͢Δ • ॳֶऀɿνϡʔτϦΞϧ • ্ڃऀɿϦϑΝϨϯεɺ࣮૷ྫ 37

  38. υΩϡϝϯτͱνϡʔτϦΞϧɺϦϑΝϨϯε • ͜ͷ3ͭͷίϯςϯπ͸ಡऀͱ೰Έ͕େ͖͘ҟͳΔ • 3ͭͷίϯςϯπΛ෼͚ͯఏڙ͢Δ 38

  39. υΩϡϝϯτΛ෼ྨ͠Α͏ 39 1 Getting Started • ݟΔස౓͸গͳ͍͚Ͳɺಛఆ ͷλΠϛϯάͰඞཁͳ৘ใ 2 Basics

    • ٕज़ʹؔ͢Δجຊతͳ͜ͱ • ઈର஌͓͖͍ͬͯͨ͜ͱ 3 Advanced • ൃలతͳ஌ࣝ • ͋ΔϢʔεέʔεʹ͓͍ͯඞ ཁʹͳΔਂ͍஌ࣝ
  40. ·ͱΊ • ίϯςϯπͷछྨΛ9ͭ঺հ͠·ͨ͠ • ಡऀͱ೰ΈΛߟ͑Α͏ • ಡऀͱ೰ΈʹԠͯ͡ॊೈʹઃܭ͠Α͏ 40 Follow @zenizh