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

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

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

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

Transcript

1. ΑΓΑ͍υΩϡϝϯτʹૣ͚ۙͮ͘ΔͨΊͷ
   ҙࢥܾఆͷϙΠϯτ %FWFMPQFS
   $POUFOUνʔϜɹԬౡඒ࡙ 
2. ࣗݾ঺հ 
3.  w ೥݄ೖࣾ
   w લ৬͸ϑϩϯτΤϯυΤϯδχΞ
   w ʰ4PGUXBSF
   %FTJHO
   ೥݄߸
   ΋͏ා͘ͳ͍ 3FBDU
   ͭͷนͱͦͷӽ͑ํʱ Ԭౡඒ࡙ %FWFMPQFS
   $POUFOUνʔϜ
   ςΫχΧϧϥΠλʔ
4. ࠓ೔࿩͢಺༰ 
5. υΩϡϝϯτͷࣥචɺվળɺͯ͠·͔͢ʁ 
6. ʮϓϩμΫτ"ͷ৽ػೳͷχϡʔεͱυΩϡϝϯτΛॻ͍ͯʜʯ
   ʮϓϩμΫτ#ͷυΩϡϝϯτͷ಺༰ؒҧͬͯΔɺ௚͞ͳ͖Όʂʯ
   ʮϓϩμΫτ$ͷ͜ͷϖʔδɺ೔ຊޠ݁ߏΘ͔Γʹ͍͘ͳʜʯ
   ʮϓϩμΫτ%ͷ͜ͷػೳɺυΩϡϝϯτʹॻ͔Ε͍ͯͳ͍ʜʁʯ
   ʮ͑ʁϓϩμΫτ&Ͱো֐͕ൃੜͨ͠ʂʁʯ 
7. ຖ೔΍Δ͜ͱɺͨ͘͞Μͳ͍Ͱ͠ΐ͏͔ʁ 
8.  ༏ઌ౓" w ۓٸͷλεΫ ༏ઌ౓# w ظݶ͕ܾ·͍ͬͯΔλεΫ
   w υΩϡϝϯτͷޡΓΛमਖ਼͢ΔλεΫ ༏ઌ౓$ w υΩϡϝϯτΛվળ͢ΔλεΫ υΩϡϝϯτΛࣥචɺվળ͢ΔλεΫͷ༏ઌ౓
9. ༏ઌ౓"ɿۓٸͷλεΫ   w ϓϩμΫτͷো֐ରԠ
   w υΩϡϝϯτͷෆ۩߹ରԠ IUUQTEFWFMPQFSTMJOFCJ[KBOFXTUBHTPVUBHFSFQPSU
10. ༏ઌ౓#ɿظݶ͕ܾ·͍ͬͯΔλεΫɺޡΓΛमਖ਼͢ΔλεΫ   ظݶ͕ܾ·͍ͬͯΔλεΫ
    w ৽ػೳͷχϡʔε΍υΩϡϝϯτͷࣥච
    w ϝϯςφϯεͷࣄલࠂ஌ͷࣥච
    ޡΓΛमਖ਼͢ΔλεΫ
    w ࢓༷ͱυΩϡϝϯτͷࠩҟͷमਖ਼ IUUQTEFWFMPQFSTMJOFCJ[KBOFXT
11. ༏ઌ౓$ɿυΩϡϝϯτΛվળ͢ΔλεΫ   w આ໌ͷ໌ྎԽ
    w αϯϓϧίʔυͷϑΥʔϚοτ
    w ը૾ͷ௥Ճ
    w ϖʔδ΍ηΫγϣϯͷ௥Ճ
    w ෆཁͳઆ໌ͷ࡟আ
12.  ༏ઌ౓" w ۓٸͷλεΫ ༏ઌ౓# w ظݶ͕ܾ·͍ͬͯΔλεΫ
    w υΩϡϝϯτͷޡΓΛमਖ਼͢ΔλεΫ ༏ઌ౓$ w υΩϡϝϯτΛվળ͢ΔλεΫ υΩϡϝϯτΛࣥචɺվળ͢ΔλεΫͷ༏ઌ౓
13.  ༏ઌ౓" w ۓٸͷλεΫ ༏ઌ౓# w ظݶ͕ܾ·͍ͬͯΔλεΫ
    w υΩϡϝϯτͷޡΓΛमਖ਼͢ΔλεΫ ༏ઌ౓$ w υΩϡϝϯτΛվળ͢ΔλεΫ υΩϡϝϯτΛࣥචɺվળ͢ΔλεΫͷ༏ઌ౓
14.   🤔λεΫͷ࡞੒ॱʁ λεΫͷॴཁ࣌ؒॱʁ ख౰ͨΓ࣍ୈʁ
15.   🤔λεΫͷ࡞੒ॱʁ λεΫͷॴཁ࣌ؒॱʁ ख౰ͨΓ࣍ୈʁ ❌ ❌ ❌
16. υΩϡϝϯτͬͯ୭ͷͨΊͷ΋ͷ͚ͩͬʁ 
17. 📖 ಡऀ 
18. ಡऀ͕ԿΛඞཁͱ͍ͯͨ͠Γɺ
    Կʹࠔ͍ͬͯͨΓ͢Δͷ͔Λ஌Γɺ
    ͦΕʹԠ͑Α͏ 
19. $POUFOUT  ΑΓΑ͍υΩϡϝϯτʹૣ͚ۙͮ͘ΔͨΊͷҙࢥܾఆͷϙΠϯτ
    ΞΫηεղੳσʔλΛ׆༻͠Α͏
    ಡऀͷ੠Λ׆༻͠Α͏
    ·ͱΊ 
    
    
    
    
20. 📖 ࣾ಺֎Λ໰Θͣɺࣗ਎ͷ໨తͷͨΊʹɺ
    υΩϡϝϯτΛར༻͢Δ͢΂ͯͷਓ  ͜ͷηογϣϯʹ͓͚Δಡऀͱ͸ʁ
21. $POUFOUT  ΑΓΑ͍υΩϡϝϯτʹૣ͚ۙͮ͘ΔͨΊͷҙࢥܾఆͷϙΠϯτ
    ΞΫηεղੳσʔλΛ׆༻͠Α͏
    ಡऀͷ੠Λ׆༻͠Α͏
    ·ͱΊ 
    
    
    
    
22. ΞΫηεղੳσʔλΛ׆༻͠Α͏ 
23. ΞΫηεղੳσʔλΛ׆༻͠Α͏ 
24.    Ͳͷϖʔδ͕Α͘ݟΒΕ͍ͯΔ͔Λ֬ೝ͢Δ
    Ͳͷϖʔδͷ଺ࡏ͕࣌ؒ௕͍͔Λ֬ೝ͢Δ
    ಡऀͷӾཡσόΠεΛ֬ೝ͢Δ
    ྲྀೖ࣌ͷݕࡧΩʔϫʔυΛ֬ೝ͢Δ ΞΫηεղੳσʔλΛ׆༻͠Α͏
25.    Ͳͷϖʔδ͕Α͘ݟΒΕ͍ͯΔ͔Λ֬ೝ͢Δ
    Ͳͷϖʔδͷ଺ࡏ͕࣌ؒ௕͍͔Λ֬ೝ͢Δ
    ಡऀͷӾཡσόΠεΛ֬ೝ͢Δ
    ྲྀೖ࣌ͷݕࡧΩʔϫʔυΛ֬ೝ͢Δ ΞΫηεղੳσʔλΛ׆༻͠Α͏
26. 
    Ͳͷϖʔδ͕Α͘ݟΒΕ͍ͯΔ͔Λ֬ೝ͢Δ  ϨϙʔτɿΤϯήʔδϝϯτʼϖʔδͱεΫϦʔϯ
27. 
    Ͳͷϖʔδ͕Α͘ݟΒΕ͍ͯΔ͔Λ֬ೝ͢Δ  IUUQTEFWFMPQFSTMJOFCJ[KB
28.    Ͳͷϖʔδ͕Α͘ݟΒΕ͍ͯΔ͔Λ֬ೝ͢Δ
    Ͳͷϖʔδͷ଺ࡏ͕࣌ؒ௕͍͔Λ֬ೝ͢Δ
    ಡऀͷӾཡσόΠεΛ֬ೝ͢Δ
    ྲྀೖ࣌ͷݕࡧΩʔϫʔυΛ֬ೝ͢Δ ΞΫηεղੳσʔλΛ׆༻͠Α͏
29. 
    Ͳͷϖʔδͷ଺ࡏ͕࣌ؒ௕͍͔Λ֬ೝ͢Δ  ϨϙʔτɿΤϯήʔδϝϯτʼϖʔδͱεΫϦʔϯ
30.    Ͳͷϖʔδ͕Α͘ݟΒΕ͍ͯΔ͔Λ֬ೝ͢Δ
    Ͳͷϖʔδͷ଺ࡏ͕࣌ؒ௕͍͔Λ֬ೝ͢Δ
    ಡऀͷӾཡσόΠεΛ֬ೝ͢Δ
    ྲྀೖ࣌ͷݕࡧΩʔϫʔυΛ֬ೝ͢Δ ΞΫηεղੳσʔλΛ׆༻͠Α͏
31. ʮಡऀ͸1$ͰݟΔͩΖ͏͔Βɺ
    ϞόΠϧରԠ͸͋Δఔ౓Ͱ͖͍ͯΕ͹͍͍΍ʯ 
32. 
    ಡऀͷӾཡσόΠεΛ֬ೝ͢Δ  ϨϙʔτɿςΫϊϩδʔʼϢʔβʔͷ؀ڥͷৄࡉ
33.    Ͳͷϖʔδ͕Α͘ݟΒΕ͍ͯΔ͔Λ֬ೝ͢Δ
    Ͳͷϖʔδͷ଺ࡏ͕࣌ؒ௕͍͔Λ֬ೝ͢Δ
    ಡऀͷӾཡσόΠεΛ֬ೝ͢Δ
    ྲྀೖ࣌ͷݕࡧΩʔϫʔυΛ֬ೝ͢Δ ΞΫηεղੳσʔλΛ׆༻͠Α͏
34. 
    ྲྀೖ࣌ͷݕࡧΩʔϫʔυΛ֬ೝ͢Δ  Ϩϙʔτɿ4FBSDI
    $POTPMFʼΫΤϦ
35.    Ͳͷϖʔδ͕Α͘ݟΒΕ͍ͯΔ͔Λ֬ೝ͢Δ
    Ͳͷϖʔδͷ଺ࡏ͕࣌ؒ௕͍͔Λ֬ೝ͢Δ
    ಡऀͷӾཡσόΠεΛ֬ೝ͢Δ
    ྲྀೖ࣌ͷݕࡧΩʔϫʔυΛ֬ೝ͢Δ ΞΫηεղੳσʔλΛ׆༻͠Α͏
36. $POUFOUT  ΑΓΑ͍υΩϡϝϯτʹૣ͚ۙͮ͘ΔͨΊͷҙࢥܾఆͷϙΠϯτ
    ΞΫηεղੳσʔλΛ׆༻͠Α͏
    ಡऀͷ੠Λ׆༻͠Α͏
    ·ͱΊ 
    
    
    
    
37.    ಡऀ͔ΒͷϑΟʔυόοΫΛूΊΔ
    αϙʔτ୲౰ऀͱ࿈ܞ͢Δ
    4/4ͷ౤ߘΛಡΉ
    ࣗ෼ͨͪͰಡΜͰΈΔ ಡऀͷ੠Λ׆༻͠Α͏
38.    ಡऀ͔ΒͷϑΟʔυόοΫΛूΊΔ
    αϙʔτ୲౰ऀͱ࿈ܞ͢Δ
    4/4ͷ౤ߘΛಡΉ
    ࣗ෼ͨͪͰಡΜͰΈΔ ಡऀͷ੠Λ׆༻͠Α͏
39. 
    ಡऀ͔ΒͷϑΟʔυόοΫΛूΊΔ  IUUQTEFWFMPQFSTMJOFCJ[KBSFGFSFODFNFTTBHJOHBQJ
40. 
    ಡऀ͔ΒͷϑΟʔυόοΫΛूΊΔ 
41. 
    ಡऀ͔ΒͷϑΟʔυόοΫΛूΊΔ 
42.    ಡऀ͔ΒͷϑΟʔυόοΫΛूΊΔ
    αϙʔτ୲౰ऀͱ࿈ܞ͢Δ
    4/4ͷ౤ߘΛಡΉ
    ࣗ෼ͨͪͰಡΜͰΈΔ ಡऀͷ੠Λ׆༻͠Α͏
43. 
    αϙʔτ୲౰ऀͱ࿈ܞ͢Δ 
44.    ಡऀ͔ΒͷϑΟʔυόοΫΛूΊΔ
    αϙʔτ୲౰ऀͱ࿈ܞ͢Δ
    4/4ͷ౤ߘΛಡΉ
    ࣗ෼ͨͪͰಡΜͰΈΔ ಡऀͷ੠Λ׆༻͠Α͏
45. 
    4/4ͷ౤ߘΛಡΉ 
46.    ಡऀ͔ΒͷϑΟʔυόοΫΛूΊΔ
    αϙʔτ୲౰ऀͱ࿈ܞ͢Δ
    4/4ͷ౤ߘΛಡΉ
    ࣗ෼ͨͪͰಡΜͰΈΔ ಡऀͷ੠Λ׆༻͠Α͏
47.    ಡऀ͔ΒͷϑΟʔυόοΫΛूΊΔ
    αϙʔτ୲౰ऀͱ࿈ܞ͢Δ
    4/4ͷ౤ߘΛಡΉ
    ࣗ෼ͨͪͰಡΜͰΈΔ ಡऀͷ੠Λ׆༻͠Α͏
48. ·ͱΊ 
49. $POUFOUT  ΑΓΑ͍υΩϡϝϯτʹૣ͚ۙͮ͘ΔͨΊͷҙࢥܾఆͷϙΠϯτ
    ΞΫηεղੳσʔλΛ׆༻͠Α͏
    ಡऀͷ੠Λ׆༻͠Α͏
    ·ͱΊ 
    
    
    
    
50. ಡऀ͕ԿΛඞཁͱ͍ͯͨ͠Γɺ
    Կʹࠔ͍ͬͯͨΓ͢Δͷ͔Λ஌Γɺ
    ͦΕʹԠ͑Α͏ 
51. $POUFOUT  ΑΓΑ͍υΩϡϝϯτʹૣ͚ۙͮ͘ΔͨΊͷҙࢥܾఆͷϙΠϯτ
    ΞΫηεղੳσʔλΛ׆༻͠Α͏
    ಡऀͷ੠Λ׆༻͠Α͏
    ·ͱΊ 
    
    
    
    
52. 5)"/,
    :06