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

よりよいドキュメントに早く近づけるための意思決定のポイント / Decision-making points to make documentation better more quickly

よりよいドキュメントに早く近づけるための意思決定のポイント / Decision-making points to make documentation better more quickly

ドキュメントを執筆、改善するタスクがたくさんある!だけど、どのタスクから着手すべきかわからず、困ったり、手当たり次第に着手したりした経験はありませんか。このセッションでは、よりよいドキュメントに早く近づけるための意思決定のポイントをご紹介します。

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

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

LINE Developers
PRO

February 16, 2023
Tweet

More Decks by LINE Developers

Other Decks in Technology

Transcript

  1. ΑΓΑ͍υΩϡϝϯτʹૣ͚ۙͮ͘ΔͨΊͷ
    ҙࢥܾఆͷϙΠϯτ
    %FWFMPQFS$POUFOUνʔϜɹԬౡඒ࡙

    View Slide

  2. ࣗݾ঺հ

    View Slide


  3. w ೥݄ೖࣾ
    w લ৬͸ϑϩϯτΤϯυΤϯδχΞ
    w ʰ4PGUXBSF%FTJHO೥݄߸΋͏ා͘ͳ͍
    3FBDUͭͷนͱͦͷӽ͑ํʱ
    Ԭౡඒ࡙
    %FWFMPQFS$POUFOUνʔϜ
    ςΫχΧϧϥΠλʔ

    View Slide

  4. ࠓ೔࿩͢಺༰

    View Slide

  5. υΩϡϝϯτͷࣥචɺվળɺͯ͠·͔͢ʁ

    View Slide

  6. ʮϓϩμΫτ"ͷ৽ػೳͷχϡʔεͱυΩϡϝϯτΛॻ͍ͯʜʯ
    ʮϓϩμΫτ#ͷυΩϡϝϯτͷ಺༰ؒҧͬͯΔɺ௚͞ͳ͖Όʂʯ
    ʮϓϩμΫτ$ͷ͜ͷϖʔδɺ೔ຊޠ݁ߏΘ͔Γʹ͍͘ͳʜʯ
    ʮϓϩμΫτ%ͷ͜ͷػೳɺυΩϡϝϯτʹॻ͔Ε͍ͯͳ͍ʜʁʯ
    ʮ͑ʁϓϩμΫτ&Ͱো֐͕ൃੜͨ͠ʂʁʯ

    View Slide

  7. ຖ೔΍Δ͜ͱɺͨ͘͞Μͳ͍Ͱ͠ΐ͏͔ʁ

    View Slide


  8. ༏ઌ౓" w ۓٸͷλεΫ
    ༏ઌ౓#
    w ظݶ͕ܾ·͍ͬͯΔλεΫ
    w υΩϡϝϯτͷޡΓΛमਖ਼͢ΔλεΫ
    ༏ઌ౓$ w υΩϡϝϯτΛվળ͢ΔλεΫ
    υΩϡϝϯτΛࣥචɺվળ͢ΔλεΫͷ༏ઌ౓

    View Slide

  9. ༏ઌ౓"ɿۓٸͷλεΫ


    w ϓϩμΫτͷো֐ରԠ
    w υΩϡϝϯτͷෆ۩߹ରԠ
    IUUQTEFWFMPQFSTMJOFCJ[KBOFXTUBHTPVUBHFSFQPSU

    View Slide

  10. ༏ઌ౓#ɿظݶ͕ܾ·͍ͬͯΔλεΫɺޡΓΛमਖ਼͢ΔλεΫ


    ظݶ͕ܾ·͍ͬͯΔλεΫ
    w ৽ػೳͷχϡʔε΍υΩϡϝϯτͷࣥච
    w ϝϯςφϯεͷࣄલࠂ஌ͷࣥච
    ޡΓΛमਖ਼͢ΔλεΫ
    w ࢓༷ͱυΩϡϝϯτͷࠩҟͷमਖ਼
    IUUQTEFWFMPQFSTMJOFCJ[KBOFXT

    View Slide

  11. ༏ઌ౓$ɿυΩϡϝϯτΛվળ͢ΔλεΫ


    w આ໌ͷ໌ྎԽ
    w αϯϓϧίʔυͷϑΥʔϚοτ
    w ը૾ͷ௥Ճ
    w ϖʔδ΍ηΫγϣϯͷ௥Ճ
    w ෆཁͳઆ໌ͷ࡟আ

    View Slide


  12. ༏ઌ౓" w ۓٸͷλεΫ
    ༏ઌ౓#
    w ظݶ͕ܾ·͍ͬͯΔλεΫ
    w υΩϡϝϯτͷޡΓΛमਖ਼͢ΔλεΫ
    ༏ઌ౓$ w υΩϡϝϯτΛվળ͢ΔλεΫ
    υΩϡϝϯτΛࣥචɺվળ͢ΔλεΫͷ༏ઌ౓

    View Slide


  13. ༏ઌ౓" w ۓٸͷλεΫ
    ༏ઌ౓#
    w ظݶ͕ܾ·͍ͬͯΔλεΫ
    w υΩϡϝϯτͷޡΓΛमਖ਼͢ΔλεΫ
    ༏ઌ౓$ w υΩϡϝϯτΛվળ͢ΔλεΫ
    υΩϡϝϯτΛࣥචɺվળ͢ΔλεΫͷ༏ઌ౓

    View Slide



  14. 🤔λεΫͷ࡞੒ॱʁ
    λεΫͷॴཁ࣌ؒॱʁ
    ख౰ͨΓ࣍ୈʁ

    View Slide



  15. 🤔λεΫͷ࡞੒ॱʁ
    λεΫͷॴཁ࣌ؒॱʁ
    ख౰ͨΓ࣍ୈʁ



    View Slide

  16. υΩϡϝϯτͬͯ୭ͷͨΊͷ΋ͷ͚ͩͬʁ

    View Slide

  17. 📖
    ಡऀ

    View Slide

  18. ಡऀ͕ԿΛඞཁͱ͍ͯͨ͠Γɺ
    Կʹࠔ͍ͬͯͨΓ͢Δͷ͔Λ஌Γɺ
    ͦΕʹԠ͑Α͏

    View Slide

  19. $POUFOUT

    ΑΓΑ͍υΩϡϝϯτʹૣ͚ۙͮ͘ΔͨΊͷҙࢥܾఆͷϙΠϯτ
    ΞΫηεղੳσʔλΛ׆༻͠Α͏
    ಡऀͷ੠Λ׆༻͠Α͏
    ·ͱΊ




    View Slide

  20. 📖
    ࣾ಺֎Λ໰Θͣɺࣗ਎ͷ໨తͷͨΊʹɺ
    υΩϡϝϯτΛར༻͢Δ͢΂ͯͷਓ

    ͜ͷηογϣϯʹ͓͚Δಡऀͱ͸ʁ

    View Slide

  21. $POUFOUT

    ΑΓΑ͍υΩϡϝϯτʹૣ͚ۙͮ͘ΔͨΊͷҙࢥܾఆͷϙΠϯτ
    ΞΫηεղੳσʔλΛ׆༻͠Α͏
    ಡऀͷ੠Λ׆༻͠Α͏
    ·ͱΊ




    View Slide

  22. ΞΫηεղੳσʔλΛ׆༻͠Α͏

    View Slide

  23. ΞΫηεղੳσʔλΛ׆༻͠Α͏

    View Slide



  24. Ͳͷϖʔδ͕Α͘ݟΒΕ͍ͯΔ͔Λ֬ೝ͢Δ
    Ͳͷϖʔδͷ଺ࡏ͕࣌ؒ௕͍͔Λ֬ೝ͢Δ
    ಡऀͷӾཡσόΠεΛ֬ೝ͢Δ
    ྲྀೖ࣌ͷݕࡧΩʔϫʔυΛ֬ೝ͢Δ
    ΞΫηεղੳσʔλΛ׆༻͠Α͏

    View Slide



  25. Ͳͷϖʔδ͕Α͘ݟΒΕ͍ͯΔ͔Λ֬ೝ͢Δ
    Ͳͷϖʔδͷ଺ࡏ͕࣌ؒ௕͍͔Λ֬ೝ͢Δ
    ಡऀͷӾཡσόΠεΛ֬ೝ͢Δ
    ྲྀೖ࣌ͷݕࡧΩʔϫʔυΛ֬ೝ͢Δ
    ΞΫηεղੳσʔλΛ׆༻͠Α͏

    View Slide

  26. Ͳͷϖʔδ͕Α͘ݟΒΕ͍ͯΔ͔Λ֬ೝ͢Δ

    ϨϙʔτɿΤϯήʔδϝϯτʼϖʔδͱεΫϦʔϯ

    View Slide

  27. Ͳͷϖʔδ͕Α͘ݟΒΕ͍ͯΔ͔Λ֬ೝ͢Δ

    IUUQTEFWFMPQFSTMJOFCJ[KB

    View Slide



  28. Ͳͷϖʔδ͕Α͘ݟΒΕ͍ͯΔ͔Λ֬ೝ͢Δ
    Ͳͷϖʔδͷ଺ࡏ͕࣌ؒ௕͍͔Λ֬ೝ͢Δ
    ಡऀͷӾཡσόΠεΛ֬ೝ͢Δ
    ྲྀೖ࣌ͷݕࡧΩʔϫʔυΛ֬ೝ͢Δ
    ΞΫηεղੳσʔλΛ׆༻͠Α͏

    View Slide

  29. Ͳͷϖʔδͷ଺ࡏ͕࣌ؒ௕͍͔Λ֬ೝ͢Δ

    ϨϙʔτɿΤϯήʔδϝϯτʼϖʔδͱεΫϦʔϯ

    View Slide



  30. Ͳͷϖʔδ͕Α͘ݟΒΕ͍ͯΔ͔Λ֬ೝ͢Δ
    Ͳͷϖʔδͷ଺ࡏ͕࣌ؒ௕͍͔Λ֬ೝ͢Δ
    ಡऀͷӾཡσόΠεΛ֬ೝ͢Δ
    ྲྀೖ࣌ͷݕࡧΩʔϫʔυΛ֬ೝ͢Δ
    ΞΫηεղੳσʔλΛ׆༻͠Α͏

    View Slide

  31. ʮಡऀ͸1$ͰݟΔͩΖ͏͔Βɺ
    ϞόΠϧରԠ͸͋Δఔ౓Ͱ͖͍ͯΕ͹͍͍΍ʯ

    View Slide

  32. ಡऀͷӾཡσόΠεΛ֬ೝ͢Δ

    ϨϙʔτɿςΫϊϩδʔʼϢʔβʔͷ؀ڥͷৄࡉ

    View Slide



  33. Ͳͷϖʔδ͕Α͘ݟΒΕ͍ͯΔ͔Λ֬ೝ͢Δ
    Ͳͷϖʔδͷ଺ࡏ͕࣌ؒ௕͍͔Λ֬ೝ͢Δ
    ಡऀͷӾཡσόΠεΛ֬ೝ͢Δ
    ྲྀೖ࣌ͷݕࡧΩʔϫʔυΛ֬ೝ͢Δ
    ΞΫηεղੳσʔλΛ׆༻͠Α͏

    View Slide

  34. ྲྀೖ࣌ͷݕࡧΩʔϫʔυΛ֬ೝ͢Δ

    Ϩϙʔτɿ4FBSDI$POTPMFʼΫΤϦ

    View Slide



  35. Ͳͷϖʔδ͕Α͘ݟΒΕ͍ͯΔ͔Λ֬ೝ͢Δ
    Ͳͷϖʔδͷ଺ࡏ͕࣌ؒ௕͍͔Λ֬ೝ͢Δ
    ಡऀͷӾཡσόΠεΛ֬ೝ͢Δ
    ྲྀೖ࣌ͷݕࡧΩʔϫʔυΛ֬ೝ͢Δ
    ΞΫηεղੳσʔλΛ׆༻͠Α͏

    View Slide

  36. $POUFOUT

    ΑΓΑ͍υΩϡϝϯτʹૣ͚ۙͮ͘ΔͨΊͷҙࢥܾఆͷϙΠϯτ
    ΞΫηεղੳσʔλΛ׆༻͠Α͏
    ಡऀͷ੠Λ׆༻͠Α͏
    ·ͱΊ




    View Slide



  37. ಡऀ͔ΒͷϑΟʔυόοΫΛूΊΔ
    αϙʔτ୲౰ऀͱ࿈ܞ͢Δ
    4/4ͷ౤ߘΛಡΉ
    ࣗ෼ͨͪͰಡΜͰΈΔ
    ಡऀͷ੠Λ׆༻͠Α͏

    View Slide



  38. ಡऀ͔ΒͷϑΟʔυόοΫΛूΊΔ
    αϙʔτ୲౰ऀͱ࿈ܞ͢Δ
    4/4ͷ౤ߘΛಡΉ
    ࣗ෼ͨͪͰಡΜͰΈΔ
    ಡऀͷ੠Λ׆༻͠Α͏

    View Slide

  39. ಡऀ͔ΒͷϑΟʔυόοΫΛूΊΔ

    IUUQTEFWFMPQFSTMJOFCJ[KBSFGFSFODFNFTTBHJOHBQJ

    View Slide

  40. ಡऀ͔ΒͷϑΟʔυόοΫΛूΊΔ

    View Slide

  41. ಡऀ͔ΒͷϑΟʔυόοΫΛूΊΔ

    View Slide



  42. ಡऀ͔ΒͷϑΟʔυόοΫΛूΊΔ
    αϙʔτ୲౰ऀͱ࿈ܞ͢Δ
    4/4ͷ౤ߘΛಡΉ
    ࣗ෼ͨͪͰಡΜͰΈΔ
    ಡऀͷ੠Λ׆༻͠Α͏

    View Slide

  43. αϙʔτ୲౰ऀͱ࿈ܞ͢Δ

    View Slide



  44. ಡऀ͔ΒͷϑΟʔυόοΫΛूΊΔ
    αϙʔτ୲౰ऀͱ࿈ܞ͢Δ
    4/4ͷ౤ߘΛಡΉ
    ࣗ෼ͨͪͰಡΜͰΈΔ
    ಡऀͷ੠Λ׆༻͠Α͏

    View Slide

  45. 4/4ͷ౤ߘΛಡΉ

    View Slide



  46. ಡऀ͔ΒͷϑΟʔυόοΫΛूΊΔ
    αϙʔτ୲౰ऀͱ࿈ܞ͢Δ
    4/4ͷ౤ߘΛಡΉ
    ࣗ෼ͨͪͰಡΜͰΈΔ
    ಡऀͷ੠Λ׆༻͠Α͏

    View Slide



  47. ಡऀ͔ΒͷϑΟʔυόοΫΛूΊΔ
    αϙʔτ୲౰ऀͱ࿈ܞ͢Δ
    4/4ͷ౤ߘΛಡΉ
    ࣗ෼ͨͪͰಡΜͰΈΔ
    ಡऀͷ੠Λ׆༻͠Α͏

    View Slide

  48. ·ͱΊ

    View Slide

  49. $POUFOUT

    ΑΓΑ͍υΩϡϝϯτʹૣ͚ۙͮ͘ΔͨΊͷҙࢥܾఆͷϙΠϯτ
    ΞΫηεղੳσʔλΛ׆༻͠Α͏
    ಡऀͷ੠Λ׆༻͠Α͏
    ·ͱΊ




    View Slide

  50. ಡऀ͕ԿΛඞཁͱ͍ͯͨ͠Γɺ
    Կʹࠔ͍ͬͯͨΓ͢Δͷ͔Λ஌Γɺ
    ͦΕʹԠ͑Α͏

    View Slide

  51. $POUFOUT

    ΑΓΑ͍υΩϡϝϯτʹૣ͚ۙͮ͘ΔͨΊͷҙࢥܾఆͷϙΠϯτ
    ΞΫηεղੳσʔλΛ׆༻͠Α͏
    ಡऀͷ੠Λ׆༻͠Α͏
    ·ͱΊ




    View Slide

  52. 5)"/,:06

    View Slide