テクニカルライティングの学び方

例えば開発ドキュメントを書くときなど、エンジニアとしてテクニカルライティングを求められることがあると思います。このスキルは業務だけではなかなか身につかず、私も苦労した経験があります。 私は昨年エンジニアからテクニカルライターに転向しました。これまでの経験をもとに、エンジニアの方に向けてテクニカルライティングの学び方を紹介します。テクニカルライターとしてのキャリアに興味がある方にも役立つ話ができればと思っています。

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

※この資料は以下イベントで発表した内容です
https://line.connpass.com/event/240461/

Transcript

1. ςΫχΧϧϥΠςΟϯάͷֶͼํ LINEגࣜձࣾ Developer ContentνʔϜ ςΫχΧϧϥΠλʔ મਆ ༟ٓ / Hiroki Zenigami 2022.3.10
2. Agenda •ςΫχΧϧϥΠςΟϯάͱ͸Կ͔ •ඞཁͳεΩϧͱ͸ •จষ࡞੒ͷجૅ •จষ࡞੒ྗͷ਎ʹ͚ͭํ 2
3. Target ର৅ͱͳΔํ ։ൃυΩϡϝϯτΛॻ͍͍ͯΔΤϯδχΞͷํ ςΫχΧϧϥΠλʔʹͳΓͨͯͷํ 3
4. Bene fi t ࿩Λฉ͘ϝϦοτ ΑΓΑ͍։ൃυΩϡϝϯτΛॻ͚ΔΑ͏ʹͳΔ ΤϯδχΞˠςΫχΧϧϥΠλʔͷΩϟϦΞͷࢀߟʹͳΔ 4
5. Pro fi le ࣗݾ঺հ ςΫχΧϧϥΠλʔ •LINEגࣜձࣾ •ݩΤϯδχΞ&ϓϩμΫτϚωʔδϟ •ڞஶʮݱ৔Ͱ࢖͑ΔRuby on Rails 5ʯ •ٕज़ϒϩά applis.io ӡӦ •εϓϥτΡʔϯ XP2,500 Hiroki Zenigami (@zenizh) 5
6. Agenda •ςΫχΧϧϥΠςΟϯάͱ͸Կ͔ •ඞཁͳεΩϧͱ͸ •จষ࡞੒ͷجૅ •จষ࡞੒ྗͷ਎ʹ͚ͭํ 6
7. ςΫχΧϧϥΠςΟϯά ٕज़తͳ + ॻ͘͜ͱ Photo by Thought Catalog on Unsplash
8. ͋Δ੡඼ʹ͍ͭͯɺ ಡऀʹΘ͔Γ΍͘͢఻͑Δ͜ͱ ≠ จষΛॻ͘ςΫχοΫશൠ Photo by Thought Catalog on Unsplash ྫɿిࢠϨϯδ
9. Photo by Thought Catalog on Unsplash Example ςΫχΧϧϥΠςΟϯάͷྫ Ոిͷऔѻઆ໌ॻ ։ൃυΩϡϝϯτ ٕज़ϒϩά
10. ྫɿిࢠϨϯδͷऔѻઆ໌ॻ ౦ࣳ ੴ༼υʔϜ ER-RD3000 ※ ൃදऀͷࣗ୐ʹͯࡱӨ 10
11. औѻઆ໌ॻͷॻ͖ํ ྫ Α͘ͳ͍ ͋Δ੡඼ʹ͍ͭͯॻ͘ ϚΠΫϩ೾Λ৯඼ͳͲʹরࣹͯ͠ɺۃ ੑΛ΋ͭਫ෼ࢠʹ௚઀ΤωϧΪʔΛ༩ ͑ɺ෼ࢠΛৼಈɾճసͤ͞Δ͜ͱͰԹ ౓Λ্͛Δɻ Α͍ ͋Δ੡඼ʹ͍ͭͯɺ ಡऀʹΘ͔Γ΍͘͢఻͑Δ ৯඼ΛೖΕͯʮ͋ͨͨΊʯΩʔΛԡ͢ ͚ͩɺ؆୯ʹ৯඼Λ͋ͨͨΊ·͢ɻ Ҿ༻ݩ Α͘ͳ͍ྫɿhttps://ja.wikipedia.org/wiki/ిࢠϨϯδ Α͍ྫɿ౦ࣳ ER-RD3000 औѻઆ໌ॻ
12. Agenda •ςΫχΧϧϥΠςΟϯάͱ͸Կ͔ •ඞཁͳεΩϧͱ͸ •จষ࡞੒ͷجૅ •จষ࡞੒ྗͷ਎ʹ͚ͭํ 12
13. ͋Δ੡඼ʹ͍ͭͯɺ ಡऀʹΘ͔Γ΍͘͢఻͑Δ͜ͱ = ςΫχΧϧϥΠςΟϯά Photo by Thought Catalog on Unsplash
14. ςΫχΧϧϥΠςΟϯάʹඞཁͳεΩϧ ͋Δ੡඼ʹ͍ͭͯɺΘ͔Γ΍͘͢఻͑Δʹ͸ จষ࡞੒ Θ͔Γ΍͘͢఻͑Δ จষྗ ٕज़ ੡඼΍पลٕज़ ʹର͢Δ஌ࣝ ίϛϡχέʔγϣϯ ཁ๬ʙެ։·Ͱͷ ΍ΓͱΓ 14
15. Agenda •ςΫχΧϧϥΠςΟϯάͱ͸Կ͔ •ඞཁͳεΩϧͱ͸ •จষ࡞੒ͷجૅ •จষ࡞੒ྗͷ਎ʹ͚ͭํ 15
16. จষ࡞੒ͷجૅ ᶃΛத৺ʹ࿩͠·͢ ᶃ
    اըฤ
    จষΛॻ͖࢝ΊΔલʹ
    ܾΊΔ͜ͱ ᶄ
    ٕज़ฤ
    จষͷॻ͘ͱ͖ʹ
    ؾΛ͚ͭΔ͜ͱ 16
17. ᶃ اըฤ จষΛॻ͖࢝ΊΔલʹܾΊΔ͜ͱ 1. ಡऀ͸୭͔ 2. ಡऀͷ೰Έ͸Կ͔ 3. ೰ΈΛղܾ͢Δ৚݅͸Կ͔ 4. Ͳ͏΍ͬͯ೰ΈΛղܾ͢Δ͔ 5. จষΛಡΉϝϦοτ 17
18. https://developers.line.biz/ja/news/2022/02/16/li ff -playground/ 18
19. ᶃ اըฤ จষΛॻ͖࢝ΊΔલʹܾΊΔ͜ͱ 1. ಡऀ͸୭͔ 2. ಡऀͷ೰Έ͸Կ͔ 3. ೰ΈΛղܾ͢Δ৚݅͸Կ͔ 4. Ͳ͏΍ͬͯ೰ΈΛղܾ͢Δ͔ 5. จষΛಡΉϝϦοτ LIFFΞϓϦ։ൃʹڵຯ͕͋Δਓɻ͋·Γৄ͘͠ͳ͍ਓ LIFFΞϓϦͷͭ͘Γ͔͕ͨΘ͔Βͳ͍ LIFFϓϨΠάϥ΢ϯυͷೝ஌ɻԿ͕Ͱ͖Δͷ͔ɺͲ͏΍ͬͯ࢝ΊΔͷ͔ LIFFϓϨΠάϥ΢ϯυͱ͸Կ͔ˠԿ͕Ͱ͖Δͷ͔ˠ࢝Ί͔ͨ LIFFͷػೳΛ΢Σϒ্ͰࢼͤΔΞϓϦ͕͋Δ͜ͱ͕Θ͔Δ 19
20. https://developers.line.biz/ja/news/2022/02/16/li ff -playground/ 5. จষΛಡΉϝϦοτ • ಡऀʹΘ͔Γ΍͍͢͜ͱ͹Ͱ • ೰ΈΛղܾ͢ΔͨΊͷߏ੒Ͱ Կ͔ Կ͕Ͱ͖Δͷ͔ ࢝Ί͔ͨ 20
21. Example ࣮ࡍʹاըͨ͠ͱ͖ͷྫ 21
22. ᶄ ٕज़ฤ จষͷॻ͘ͱ͖ʹؾΛ͚ͭΔ͜ͱ ͻͱͭͷจΛ୹͘͢Δ ݁࿦Λઌʹॻ͘ ࠶ݱੑΛ΋ͨͤΔ લఏ৚݅ΛͦΖ͑Δ ಡऀʹ͋ΘͤͨදݱΛ༻͍Δ ඞཁʹԠͯ͡ௐ΂Δ 22
23. Agenda •ςΫχΧϧϥΠςΟϯάͱ͸Կ͔ •ඞཁͳεΩϧͱ͸ •จষ࡞੒ͷجૅ •จষ࡞੒ྗͷ਎ʹ͚ͭํ 23
24. ςΫχΧϧϥΠςΟϯάͷ਎ʹ͚ͭํ ※ ܦݧΛݩʹͨ͠ݸਓతͳߟ͑ ˚ ͋·ΓΑ͘ͳ͍ ํ๏࿦ΛֶΜ্ͩͰॻ͘ ↓ ͏·࣮͘ફͰ͖ͳ͍ ˕ Α͍ ॻ্͍ͨͰํ๏࿦ΛֶͿ ↓ ਎ʹͭ͘ 24
25. ςΫχΧϧϥΠςΟϯάͷ਎ʹ͚ͭํ ʮํ๏࿦ΛֶͿʯΛελʔτʹ͠ͳ͍ ॻ͘ ;Γ͔͑Δ ํ๏࿦ΛֶͿ ܭըΛཱͯΔ ܁Γฦ͢ = ਎ʹͭ͘ 25
26. Photo by Thought Catalog on Unsplash ٕज़ϒϩά ݸਓग़൛ Twitter Ͳ͜Ͱ਎ʹ͚ͭΔ͔ ܁Γฦ͠ॻͨ͘Ίͷ৔ॴ
27. https://zenn.dev/about ٕज़ϒϩάͷ͍͍ͱ͜Ζ •ແྉͰ࢝ΊΒΕΔ •ۀ຿ϑϩʔΛମݧͰ͖Δ •ࣗ෼ͷͨΊʹͳΔ •ଞͷ୭͔ͷ໾ʹཱͯΔ •స৬ʹ໾ཱͭ 27
28. ͋Δ੡඼ʹ͍ͭͯɺಡऀʹΘ͔Γ΍͘͢఻͑Δ͜ͱ ٕज़ྗɾจষ࡞੒ྗɾίϛϡχέʔγϣϯྗ͕ॏཁ จষΛॻ͖࢝ΊΔલʹاը͢Δ ·ֶͣͿͷͰ͸ͳ͘ɺ܁Γฦ͠ॻ͘͜ͱʹΑͬͯ਎ʹ͚ͭΔ 28
29. Thank you