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

読者のことを考えて書いてみよう / Write with your reader in mind

読者のことを考えて書いてみよう / Write with your reader in mind

ドキュメントを書く機会がある!だけど、ちゃんと書いているつもりなのにいまいち伝わりにくいドキュメントになってしまう、という経験はありませんか。読者により伝わりやすいドキュメントを書くには、読者のことを考えることが大切です。このセッションではドキュメントを書く際に意識しておくとよいポイントをご紹介します。

岡島 美咲/ @mokajima85z / LINE株式会社 Developer Contentチーム テクニカルライター

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

LINE Developers

May 12, 2022
Tweet

More Decks by LINE Developers

Other Decks in Technology

Transcript

  1. 7 ࠓ೔࿩͢಺༰  ಉ͡ҙຯʹ͸ಉ͡ݴ༿Λ࢖͓͏  ࢦࣔޠʹ஫ҙ͠Α͏  ҰจΛ୹͘͠Α͏  ৑௕ͳදݱΛ࡟Ζ͏

     ηΫγϣϯͰ۠੾Ζ͏  ʮࢲ޲͚͡Όͳ͍ʯΛχϡʔελΠτϧͰ൑அͰ͖ΔΑ͏ʹ͠Α͏  χϡʔελΠτϧ͸खஈͰ͸ͳ͘ར఺Λॻ͜͏
  2. 8 ࠓ೔࿩͢಺༰  ಉ͡ҙຯʹ͸ಉ͡ݴ༿Λ࢖͓͏  ࢦࣔޠʹ஫ҙ͠Α͏  ҰจΛ୹͘͠Α͏  ৑௕ͳදݱΛ࡟Ζ͏

     ηΫγϣϯͰ۠੾Ζ͏  ʮࢲ޲͚͡Όͳ͍ʯΛχϡʔελΠτϧͰ൑அͰ͖ΔΑ͏ʹ͠Α͏  χϡʔελΠτϧ͸खஈͰ͸ͳ͘ར఺Λॻ͜͏
  3. 12 ࠓ೔࿩͢಺༰  ಉ͡ҙຯʹ͸ಉ͡ݴ༿Λ࢖͓͏  ࢦࣔޠʹ஫ҙ͠Α͏  ҰจΛ୹͘͠Α͏  ৑௕ͳදݱΛ࡟Ζ͏

     ηΫγϣϯͰ۠੾Ζ͏  ʮࢲ޲͚͡Όͳ͍ʯΛχϡʔελΠτϧͰ൑அͰ͖ΔΑ͏ʹ͠Α͏  χϡʔελΠτϧ͸खஈͰ͸ͳ͘ར఺Λॻ͜͏
  4. 24 ࠓ೔࿩͢಺༰  ಉ͡ҙຯʹ͸ಉ͡ݴ༿Λ࢖͓͏  ࢦࣔޠʹ஫ҙ͠Α͏  ҰจΛ୹͘͠Α͏  ৑௕ͳදݱΛ࡟Ζ͏

     ηΫγϣϯͰ۠੾Ζ͏  ʮࢲ޲͚͡Όͳ͍ʯΛχϡʔελΠτϧͰ൑அͰ͖ΔΑ͏ʹ͠Α͏  χϡʔελΠτϧ͸खஈͰ͸ͳ͘ར఺Λॻ͜͏
  5. 35 ࠓ೔࿩͢಺༰  ಉ͡ҙຯʹ͸ಉ͡ݴ༿Λ࢖͓͏  ࢦࣔޠʹ஫ҙ͠Α͏  ҰจΛ୹͘͠Α͏  ৑௕ͳදݱΛ࡟Ζ͏

     ηΫγϣϯͰ۠੾Ζ͏  ʮࢲ޲͚͡Όͳ͍ʯΛχϡʔελΠτϧͰ൑அͰ͖ΔΑ͏ʹ͠Α͏  χϡʔελΠτϧ͸खஈͰ͸ͳ͘ར఺Λॻ͜͏
  6. 40 ࠓ೔࿩͢಺༰  ಉ͡ҙຯʹ͸ಉ͡ݴ༿Λ࢖͓͏  ࢦࣔޠʹ஫ҙ͠Α͏  ҰจΛ୹͘͠Α͏  ৑௕ͳදݱΛ࡟Ζ͏

     ηΫγϣϯͰ۠੾Ζ͏  ʮࢲ޲͚͡Όͳ͍ʯΛχϡʔελΠτϧͰ൑அͰ͖ΔΑ͏ʹ͠Α͏  χϡʔελΠτϧ͸खஈͰ͸ͳ͘ར఺Λॻ͜͏
  7. 44

  8. 45

  9. 46

  10. 47

  11. 48

  12. 50

  13. 52 ࠓ೔࿩͢಺༰  ಉ͡ҙຯʹ͸ಉ͡ݴ༿Λ࢖͓͏  ࢦࣔޠʹ஫ҙ͠Α͏  ҰจΛ୹͘͠Α͏  ৑௕ͳදݱΛ࡟Ζ͏

     ηΫγϣϯͰ۠੾Ζ͏  ʮࢲ޲͚͡Όͳ͍ʯΛχϡʔελΠτϧͰ൑அͰ͖ΔΑ͏ʹ͠Α͏  χϡʔελΠτϧ͸खஈͰ͸ͳ͘ར఺Λॻ͜͏
  14. 59 ࠓ೔࿩ͨ͠಺༰  ಉ͡ҙຯʹ͸ಉ͡ݴ༿Λ࢖͓͏  ࢦࣔޠʹ஫ҙ͠Α͏  ҰจΛ୹͘͠Α͏  ৑௕ͳදݱΛ࡟Ζ͏

     ηΫγϣϯͰ۠੾Ζ͏  ʮࢲ޲͚͡Όͳ͍ʯΛχϡʔελΠτϧͰ൑அͰ͖ΔΑ͏ʹ͠Α͏  χϡʔελΠτϧ͸खஈͰ͸ͳ͘ར఺Λॻ͜͏