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

意外と大事! DevRelに使える日本語テクニック

意外と大事! DevRelに使える日本語テクニック

「見た目より中身だよ!」とか「いいもの作れば売れるんだよ!」とか。

それが幻想だというのは、大人となってさまざまな経験を積んできた皆さんならお分かりですね。いかに製品・サービスとユーザーやユーザー候補との距離を縮めるか。これがDevRelやアドボケイトの肝心要の役割ではないですか。

コーディングは学ばないと厳しいけど、日本語は日本で育ってきたら普段気にせずに使うので別に学ばなくても書けます。とはいえ適切に書けているかどうかは別。製品・サービスにドキュメントは必須だし役に立つはずですが、ユーザーは困ったときに公式ドキュメントに頼らず(頼れず?)、Qiitaとかの情報投稿サイトに頼るのはなぜでしょう。

その原因の、たとえば、

- 誤解される文章(まずそれはNG!)
- 分かりにくい文章(だからドキュメント離れが……)
- 冗長な文章(ワーキング メモリーを無駄に使ってしまう)

などについて、具体的な例を挙げながら解説します。

本セッションでは、「今日から使える!」分かりやすい日本語を書くポイントをシェアします。

2023年3月10日・11日@横浜
DevRel/Japan CONFERENCE 2023 にて登壇

https://devrel.tokyo/japan-2023/

wataru yamazaki (DevRel)

March 10, 2023
Tweet

More Decks by wataru yamazaki (DevRel)

Other Decks in Marketing & SEO

Transcript

  1. %FW3FMʹ࢖͑Δ
    ೔ຊޠςΫχοΫ
    ೥݄೔
    ࢁ⃻ ࿱
    XZBNB[BL
    ҙ֎ͱେࣄ

    View Slide

  2. ͸͡Ί·ͯ͠
    ࢁ࡚ ࿱ʢ΍·͖͟ ΘͨΔʣ
    Ϛʔέλʔɻ
    ೔ຊΦϥΫϧʹͯɺ೥Ҏ্ʹ౉Γ੡඼αʔϏε։ൃऀ޲͚ͳͲͷ
    ϚʔέςΟϯάΛ୲౰Ň8ϝʔϧେن໛Πϕϯτ͔ΒŊιʔγϟϧϝ
    σΟΞখن໛ϛʔτΞοϓίϛϡχςΟ΁࣌୅ʹ߹Θͤͯख๏ΛมԽɻ
    ΢ϑϧͰͷ։ൃऀ޲͚੡඼Ϛʔέ୲౰͓Αͼ੡඼ίϛϡχςΟ্ཱͪ͛
    Λܦͯɺݱࡏ͸ηκϯ৘ใγεςϜζʹͯάϩʔόϧ ϚʔέςΟϯά΍
    ίϛϡχςΟϚʔέςΟϯάͳͲΛ୲౰ɻ
    %FW3FM.LUHྺ೥ 58'#*OTUBXZBNB[BL

    View Slide

  3. ͸͡Ί·ͯ͠
    ࢁ࡚ ࿱ʢ΍·͖͟ ΘͨΔʣ
    ϚʔέςΟϯάྺʢ೥ʣ
    %FW3FM.LUHྺ೥
    40/04+BQBO6TFST (SPVQ
    FOFCVMBSίϛϡχςΟφϏήʔλʔ
    58'#*OTUBXZBNB[BL

    View Slide

  4. ޷͖ͳ΋ͷ

    View Slide

  5. ίʔώʔ
    ʢઙઝΓʣ

    View Slide

  6. Ϋϥϑτ
    Ϗʔϧ
    )B[Z*1"

    View Slide

  7. ͜Ε·Ͱͷొஃʜʜ
    %FW3FM+BQBO$0/'&3&/$&ͱͱ΋ʹ
    าΈଓ͚ͯɺૣ೥ɻ
    ύωϧ σΟεΧογϣϯ
    ʮϝσΟΞʯ
    ೥ ೥ ೥

    View Slide

  8. ͳͥɺ%FW3FMͰ
    ೔ຊޠςΫχοΫʁʁ

    View Slide

  9. ೔ຊޠͰจষΛ
    ॻ͘ਓʂ

    View Slide

  10. จষߨ࠲ͱ͔Ͱ
    ֶΜͩ͜ͱ͋Δਓʁ

    View Slide

  11. ࠷ۙ೰ΉΜͰ͢

    View Slide

  12. ࠷ۙ೰ΉΜͰ͢
    p ಉ͡Α͏ͳ೔ຊޠͷमਖ਼͕ଟ͍
    p ෼͔Γʹ͍͘
    p ಺༰͕ྑ͍ͷʹ࢒೦

    View Slide

  13. ͳͥŊ࢒೦ʹͳΔͷͰ͠ΐ͏ʁ

    View Slide

  14. ͦΕ͸Ŋ
    ňؾʹ͠ͳ͍ʼn͔Β
    ňؾʹ͠ͳ͍ʼn

    View Slide


  15. ňؾʹ͢Δʼn

    ϨϕϧΞοϓ
    ňؾʹ͠ͳ͍ʼn
    ňؾʹ͢Δʼn

    View Slide

  16. ňؾʹ͢Δʼn
    ͍͔ͭ͘ͷϙΠϯτΛ
    ԡ͑͞Ε͹͍͍
    ఺Λ໨ࢦ͞
    ͳ͍͍ͯ͘
    ͏ͳΔΑ͏ͳ໊จ
    Ͱͳͯ͘΋0,
    ೔ʑ࣌ؒʹ௥ΘΕͳ͕Β࡞ۀ͍ͯ͠Δ͔Β

    View Slide

  17. ໨ࢦ͢ͱ͜Ζ
    ňίεύͷྑ͍ʼnํ๏
    ࣌ؒˠ
    ˡ
    Ϩ
    ϕ
    ϧ
    ࢒೦κʔϯ
    ໰୊ͳ͠κʔϯ
    ໊จκʔϯ

    View Slide


  18. ňؾʹ͢Δʼn

    ϨϕϧΞοϓ
    ňؾʹ͠ͳ͍ʼn
    ňؾʹ͢Δʼn
    ϨϕϧΞοϓ

    View Slide

  19. ର৅ͷ
    ཧղ౓Ξοϓ
    ಡΜͰ͘Εͨਓ
    ʹྱઅΛอͯΔ
    ୭͔ͷ໾ʹཱͯΔ
    ͷ͸خ͍͠
    ˠಡΈखͱͷڞײίϛϡχέʔγϣϯ
    ͷϝϦοτ
    ϨϕϧΞοϓ

    View Slide

  20. ˠಡΈखͱͷڞײίϛϡχέʔγϣϯ
    ྑ͍%FWFMPQFS3FMBUJPOʹͭͳ͕Δ

    View Slide

  21. ͳͥɺ%FW3FMͰ
    ೔ຊޠςΫχοΫʁʁ

    View Slide

  22. Ͱ͸ɺͲ͏΍ͬͯʁʁ
    ʙؾʹ͢ΔϙΠϯτʙ

    View Slide

  23. ʙؾʹ͢ΔϙΠϯτʙ
    ಡΈ΍͢͞Λ
    ߟྀ͢Δ
    ޡղ͕ͳ͍
    Α͏ʹ͢Δ
    ՄೳͳݶΓ
    ίϯύΫτʹ
    ಡΈखʹ࿑ྗΛ
    ڧ͍Δ͜ͱ͸͠ͳ͍
    ϛείϛϡχέʔγϣϯ
    ͕ى͖ͳ͍Α͏ʹ͢Δ
    ϫʔΩϯάϝϞϦʔΛ
    େྔফඅͤ͞ͳ͍

    View Slide

  24. ۩ମྫ
    ʙ؆୯ϙΠϯτʙ

    View Slide

  25. ಡΈ΍͢͞Λ
    ߟྀ͢Δ
    ޡղ͕ͳ͍
    Α͏ʹ͢Δ
    ՄೳͳݶΓ
    ίϯύΫτʹ

    View Slide

  26. ׽ࣈͱͻΒ͕ͳͷ࢖͍෼͚
    ň։͘ʼnͻΒ͕ͳŊňด͡Δʼn׽ࣈ
    • ׽ࣈ͕ଟ͍ͱɺݻ͍ҹ৅
    • ͦ΋ͦ΋ϧʔϧ͕͋Δ
    ಡΈ΍͢͞Λ
    ߟྀ͢Δ
    ׽ࣈ ͻΒ͘ ϧʔϧ

    View Slide

  27. ׽ࣈͱͻΒ͕ͳͷ࢖͍෼͚ ಡΈ΍͢͞Λ
    ߟྀ͢Δ
    ྫʣ
    • $-*Λ࢖༻͢Δ࣌͸ʙ ˠ $-*Λ࢖༻͢Δͱ͖͸ʙ
    • ༷ʑͳཧ༝͔Βʙ ˠ ͞·͟·ͳཧ༝͔Βʙ
    • ྫ͑͹ɺ.BDͷ৔߹ʙ ˠ ͨͱ͑͹ɺ.BDͷ৔߹ʙ
    • ʙ͢Δࣄ͸ ʙ ˠ ʙ͢Δ͜ͱ͸ʙ
    • 'Λԡͯ͠Լ͍͞ ˠ'Λԡ͍ͯͩ͘͠͞
    • ໰͍߹Θͤ௖͖ʙ ˠ໰͍߹Θ͍͖ͤͨͩʙ

    View Slide

  28. ׽ࣈͱͻΒ͕ͳͷ࢖͍෼͚ ಡΈ΍͢͞Λ
    ߟྀ͢Δ
    ňԼ͍͞ʼnͱň௖͖·͢ʼnͷΑ͏ʹด͡Δϧʔϧɿ
    – ͳʹ͔Λʮ΋Β͏ʯ৔߹
    ྫʣ
    "
    άϨʔϓϑϧʔπΛݸԼ͍͞ɻ
    #
    ͸͍ɻສԁ௖͖·͢ɻ
    "
    ߴ͍ͳɺ͓͍ʂ

    View Slide

  29. ׽ࣈͷ࿈ଓʹؾΛ͚ͭΔ ಡΈ΍͢͞Λ
    ߟྀ͢Δ
    ׽ࣈ͕จࣈҎ্ ଓ͘ͱɺňΠΧϝγΠʼnͷͰଓ͔ͳ͍Α͏ʹ
    ޻෉͢Δɻ
    ྫʣ
    • ॳظಋೖඅ༻ ˠ ॳظಋೖͷඅ༻ʢPSॳظಋೖίετʣ
    • ׬શఀࢭظؒ ˠ ׬શʹఀࢭ͢Δظؒ

    View Slide

  30. ΧλΧφͷ࿈ଓʹؾΛ͚ͭΔ ಡΈ΍͢͞Λ
    ߟྀ͢Δ
    ΧλΧφ͕࿈ଓ͗͢͠ΔͱŊͲ͜Ͱ੾͍͍͔ͬͯෆ໌ྎʹͳΓɺ
    ಡΈʹ͔ͬͨ͘ΓɺޡղΛট͍ͨΓ͢ΔͷͰ޻෉͢Δɻ
    ྫʣ
    • σδλϧτϥϯεϑΥʔϝʔγϣϯγεςϜ ˠ
    σδλϧ τϥϯεϑΥʔϝʔγϣϯ γεςϜ PS
    σδλϧɾτϥϯεϑΥʔϝʔγϣϯɾγεςϜ
    • υϯΩϗʔς ˠυϯɾΩϗʔς υϯΩɾϗʔς

    View Slide

  31. දه༳ΕʹؾΛ͚ͭΔ ಡΈ΍͢͞Λ
    ߟྀ͢Δ
    ಉ͜͡ͱΛࢦ͢ͷ͔ɺҧ͏͜ͱΛࢦ͢ͷ͔͕෼͔Βͳ͘ɺ
    ޡղΛট͍ͨΓ͢ΔͷͰ޻෉͢Δɻ
    ྫʣ
    • Ϣʔβʔ ˠϢʔβ ࢖༻ऀ
    • ಋೖϚχϡΞϧ ˠΠϯετʔϧ ϚχϡΞϧ

    View Slide

  32. ಡΈ΍͢͞Λ
    ߟྀ͢Δ
    ޡղ͕ͳ͍
    Α͏ʹ͢Δ
    ՄೳͳݶΓ
    ίϯύΫτʹ

    View Slide

  33. ಡΈ΍͢͞Λ
    ߟྀ͢Δ
    ޡղ͕ͳ͍
    Α͏ʹ͢Δ
    ՄೳͳݶΓ
    ίϯύΫτʹ

    View Slide

  34. ฒͼॱʹؾΛ͚ͭΔ
    ಡΈʹ͍͚ͩ͘Ͱͳ͘ɺ৔߹ʹΑͬͯ͸ޡղΛট͘ͷͰɺޠ
    ॱΛ޻෉͢Δɻ
    ྫʣ
    • ඞཁ৚݅ͱͯ͠/PEF3&%Λ࢖͏ʹ͸·ͣ/PEFKTΛΠϯε
    τʔϧ͠·͢ɻ
    → /PEF3&%Λ࢖͏ʹ͸ɺඞཁ৚݅ͱͯ͠ ·ͣ/PEFKTΛΠϯε
    τʔϧ͠·͢ɻ
    ޡղ͕ͳ͍
    Α͏ʹ͢Δ
    ಡ఺ Ŋ
    ͷස౓ŊҐஔʹ΋஫ҙ

    View Slide

  35. ಡΈ΍͢͞Λ
    ߟྀ͢Δ
    ޡղ͕ͳ͍
    Α͏ʹ͢Δ
    ՄೳͳݶΓ
    ίϯύΫτʹ

    View Slide

  36. ޡղ͕ͳ͍
    Α͏ʹ͢Δ
    ՄೳͳݶΓ
    ίϯύΫτʹ
    ಡΈ΍͢͞Λ
    ߟྀ͢Δ

    View Slide

  37. ϫʔΩϯάϝϞϦʔΛҙࣝ͢Δ ՄೳͳݶΓ
    ίϯύΫτʹ
    ςΩετ จࣈΛೝࣝ ಄ͷதͰ੠ʹग़͢ ཧղ͢Δ

    View Slide

  38. ϫʔΩϯάϝϞϦʔΛҙࣝ͢Δ
    ňҙ͕ࣝΩʔϓ͍ͯ͠ΒΕΔͷ͸ɺ
    ͭͷେ͖ͳʰ৘ใͷ͔ͨ·ΓʱͰɺ
    ͦͷ࣌ؒ͸ඵҎԼఔ౓ͳͷͩɻʼn
    ʰ৺Λͭͳ͛Δʱ
    ΞϯυϦϡʔɾχϡʔόʔάɺϚʔΫɾϩόʔτɾ΢ΥϧυϚϯஶ
    ՄೳͳݶΓ
    ίϯύΫτʹ

    View Slide

  39. ňߦ͏ʼnېࢭ ՄೳͳݶΓ
    ίϯύΫτʹ
    ճΓ͘Ͳ͍ɻจࣈ਺૿ՃͷݪҼɻ
    ྫʣ
    • ඞͣςετΛߦ͍·͢ɻˠඞͣςετ͠·͢ɻ
    • "#$͕ωοτϫʔΫͷ؂ࢹΛߦ͍·͢ɻˠ
    "#$͕ωοτϫʔΫΛ؂ࢹ͠·͢ɻ

    View Slide

  40. ҙຯͷॏෳʹ஫ҙ ՄೳͳݶΓ
    ίϯύΫτʹ
    ňന͍നഅʼnň಄௧͕௧͍ʼnΛؾ෇͔ͣʹ΍Δ৔߹΋ɻ
    จࣈ਺૿ՃͷݪҼˍஏ͔͍ͣ͠ɻʢͻΒ͕ͳͩͱؾ෇͖ʹ͍͘ʣ
    ྫʣ
    • #͸ྫྷͨ͘ྫྷ΍͍ͯͩ͘͠͞Ňˠ#͸ྫྷ΍͍ͯͩ͘͠͞ɻ
    • 0બख͸೔ຊʹདྷ೔தͰ͢Ň ˠ0બख͸དྷ೔தͰ͢ɻ
    • ඞͣςετ͕ඞཁͰ͢Ňˠςετ͕ඞཁͰ͢ɻ
    • "#$͸ඞͣϚετͳඞਢ৚݅Ͱ͢Ňˠ"#$͸ඞਢ৚݅Ͱ͢ɻ

    View Slide

  41. ա౓ͳܟޠʹ஫ҙ ՄೳͳݶΓ
    ίϯύΫτʹ
    ͓٬༷΁ͷϨλʔͰͳ͍ݶΓŊܟޠ͸࠷௿ݶʹɻ
    จࣈ਺૿Ճˍ·͕͍ͪͷ΋ͱɻ
    ྫʣ
    • ͝࢖༻ͷલʹ͸࣮֬ʹ৚݅Λຬͨ͢͜ͱΛ֬͝ೝ͍ͩ͘͞
    ·͢Α͏͓ئ͍͍ͨ͠·͢Ňˠ
    ͝࢖༻ͷલʹ৚݅Λຬͨ͢͜ͱ֬ೝ͍ͯͩ͘͠͞ɻ
    ͋ͱʜʜɺ

    View Slide

  42. ա౓ͳܟޠʹ஫ҙ ՄೳͳݶΓ
    ίϯύΫτʹ
    ةͳ͍͔Βۙͮ͘ͳʂ
    ň͍͖ͤͯͨͩ͞·͢ʼnˠ ૬खͷڐՄΛಘΔ͜ͱɻͪ͜Βʹ
    Ըܙ͕͋Δ͜ͱʹରͯ͠࢖͏
    ྫʣ
    • ͜Ε͔Βൃද͍͖ͤͯͨͩ͞·͢Ňˠ͜Ε͔Βൃද͍ͨ͠·͢ɻ
    0,
    ͪ͜Β͔Β͝࿈བྷ͍͖ͤͯͨͩ͞·͢ ΑΖ͍͠Ͱ͔͢ʁ

    View Slide

  43. ա౓ͳܟޠʹ஫ҙ ՄೳͳݶΓ
    ίϯύΫτʹ
    ň͍͖ͤͯͨͩ͞·͢ʼn
    ʮ૬ख΋͘͠͸ୈࡾऀͷڐՄΛಘ͍ͯΔ͔ʯ
    ʮͦΕʹΑΓࣗ෼͕ԸܙΛड͚Δ͔ʯͱ͍͏
    ͭͷ৚݅Λຬͨ͢৔߹ʹ࢖༻͢Δ͜ͱ͕ద੾
    ʢʰܟޠͷࢦ਑ʱฏ੒೥݄೔ จԽ৹ٞձ౴ਃʣ
    IUUQTXXXCVOLBHPKQTFJTBLVCVOLBTIJOHJLBJLPLVHPIPLPLVQEGLFJHP@UPTJOQEG

    View Slide

  44. ޡղ͕ͳ͍
    Α͏ʹ͢Δ
    ՄೳͳݶΓ
    ίϯύΫτʹ
    ಡΈ΍͢͞Λ
    ߟྀ͢Δ

    View Slide

  45. ಡΈ΍͢͞Λ
    ߟྀ͢Δ
    ޡղ͕ͳ͍
    Α͏ʹ͢Δ
    ՄೳͳݶΓ
    ίϯύΫτʹ

    View Slide

  46. ຊ౰͸Ŋ·ͩ·ͩ͋Γ·͢
    Ұྫʣ
    p ߏ଄Խɿ
    ৑௕ͳจষΛ؆ܿʹՕ৚ॻ͖ʹ
    p ॏΈ෇͚ɿ
    μΠφϛοΫʹେ͖͞ɺ৭ͳͲΛม͑Δ
    p ୯७Խɿ
    γϯϓϧ͔Βৄࡉ΁૬खͷڵຯʹԠͯ͡มԽ

    View Slide

  47. ·ͱΊ

    View Slide

  48. ʙؾʹ͢ΔϙΠϯτʙ
    ಡΈ΍͢͞Λ
    ߟྀ͢Δ
    ޡղ͕ͳ͍
    Α͏ʹ͢Δ
    ՄೳͳݶΓ
    ίϯύΫτʹ
    ಡΈखʹ࿑ྗΛ
    ڧ͍Δ͜ͱ͸͠ͳ͍
    ϛείϛϡχέʔγϣϯ
    ͕ى͖ͳ͍Α͏ʹ͢Δ
    ϫʔΩϯάϝϞϦʔΛ
    େྔফඅͤ͞ͳ͍

    View Slide

  49. ͓·͚ɿ

    View Slide

  50. $IBU(15ʹ΋ฉ͍ͯΈ·ͨ͠
    ҎԼʹɺߨԋςʔϚʮ೔ຊޠͷٕज़จষΛ࡞੒͢ΔࡍʹؾΛ෇͚ΔϙΠϯτͱɺ೔ຊޠΛϨϕ
    ϧΞοϓ͢Δ؆୯ͳςΫχοΫʯʹ͓͍ͯɺ࿩͢΂͖ϙΠϯτΛͭʹ·ͱΊ·ͨ͠ɻ
    ೔ຊޠͷจ๏ɾදݱͷಛ௃
    • ओޠɾड़ޠɾ໨తޠͷॱং͕ҟͳΔ͜ͱʹΑΔจষߏ଄ͷಛ௃
    • จࣈ਺͕গͳͯ͘ࡁΉলུදݱͷ࢖͍ํ
    • ༷ʑͳܟޠͷ࢖͍෼͚ͱͦͷద੾ͳ࢖͍ํ
    ೔ຊޠʹ͓͚Δద੾ͳઐ໳༻ޠͷ࢖͍ํ
    • ٕज़෼໺ʹ͓͍ͯҰൠతʹ࢖ΘΕΔઐ໳༻ޠͷ೺Ѳ
    • ೔ຊޠͰಠࣗʹ࡞ΒΕͨઐ໳༻ޠͷཧղ
    • ઐ໳༻ޠͷχϡΞϯεʹ͍ͭͯͷೝࣝ
    ೔ຊޠͷදݱͷ໌֬Խͱద੾ͳදݱํ๏
    • ಺༰Λ୺తʹ఻͑ΔͨΊͷγϯϓϧͳදݱํ๏
    • ׽ࣈͷ࢖͍ํʹΑΔಡΈ΍͢͞ͷ޲্
    • ద੾ͳ۟ಡ఺ͷ࢖͍ํʹΑΔಡΈ΍͢͞ͷ޲্
    ͜ΕΒͭͷϙΠϯτ͸ɺ೔ຊޠͷٕज़จষ࡞੒ʹ͓͍ͯॏཁͳཁૉΛΧόʔ͓ͯ͠Γɺௌऺ
    ʹͱ࣮ͬͯફతͳՁ஋ͷ͋Δ಺༰ͱͳΔͱߟ͑ΒΕ·͢ɻ

    View Slide

  51. ࢀߟʹͳΔ·ͱΊهࣄ
    IUUQTRJJUBDPNBSJBLJJUFNTFGFBFFCCF

    View Slide

  52. ͍͍͍ͨ͜ͱʂ
    ॻ͖खɺಡΈखɺ
    ΈΜͳϋοϐʔʹͳΓ·͠ΐ͏ʂ
    ϙΠϯτΛ஌Γɺ΄Μͷগ͠ͷ഑ྀͰಡΈ
    ΍͘͢ͳΓ·͢
    ·ͣ͸ಡΈ௚͢ͱ͜Ζ͔Β

    View Slide

  53. զʑͷཱྀ͸ ͸͡·ͬͨ͹͔Γͩ

    View Slide

  54. ࢁ࡚ ࿱ͷ
    ࣍ճ࡞ʹ͝ظ଴͍ͩ͘͞

    View Slide

  55. %FW3FMʹ࢖͑Δ
    ೔ຊޠςΫχοΫ
    ೥݄೔
    ࢁ⃻ ࿱
    XZBNB[BL
    ҙ֎ͱେࣄ

    View Slide

  56. ͋Γ͕ͱ͏͍͟͝·ͨ͠ʂ

    View Slide