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

なぜSphinxで手順書を作るのか /20180425-sphinx-documentation

opelab
April 25, 2018

なぜSphinxで手順書を作るのか /20180425-sphinx-documentation

ssmjp 201804での発表資料です。

詳細: https://www.opslab.jp/publish/20180425-ssmjp-sphinx.html

(運用設計ラボ合同会社 波田野裕一)

opelab

April 25, 2018
Tweet

More Decks by opelab

Other Decks in Technology

Transcript

  1. ʮӡ༻ࣗಈԽʯͷܦݧଇ 6 ੒ޭͨࣗ͠ಈԽ • ࣗಈԽͷޮՌʹ͍ͭͯɺCFGPSFBGUFS͕໌֬ͳ΋ͷ • ܧଓతʹϝϯςφϯεͰ͖ΔΑ͏ʹૄ݁߹ʹ࡞੒ͨ͠΋ͷ • ໨తΛ໌֬ʹ͠ɺτοϓμ΢ϯࣜʹ࡞੒ͨ͠΋ͷɻ •

    खॱॻʹԊͬͯ࡞੒ͨ͠΋ͷ • खۙͳͱ͜Ζ͔ΒϘτϜΞοϓࣜʹ࡞੒ͨ͠΋ͷɻ • ʮࣗಈԽʯΛ໨తʹͨ͠΋ͷɻ ਅͷ໨త͕໎૸ͨ͠  • ʮເͷπʔϧʯΛ໨ࢦͨ͠΋ͷɻ ࣦഊͨࣗ͠ಈԽ ৘ใॲཧֶձυΩϡϝϯτίϛϡχέʔγϣϯݚڀୈճݚڀձൃදࢿྉ͔Β Operation Lab ӡ༻ઃܭϥϘ
  2. Operation Lab ӡ༻ઃܭϥϘ • खॱॻϕʔεͷࣗಈԽ͸ଞਓͰ΋ཧղ͠΍͍͢ • ࡞ۀखॱΛྲྀΕ࡞ۀԽ͠ɺద੾ʹ੔ཧɾ෼ׂ͢Δ͜ͱͰΘ͔Γ΍͘͢ͳΔɻ • खॱॻϕʔεͷࣗಈԽ͸ϞϊϦγοΫԽΛආ͚΍͍͢ •

    ͭͷ͜ͱΛ্खʹͰ͖ΔখཻͷखॱॻΛ࡞੒͠ɺखॱ ࢓༷ ʹैͬͯࣗಈॲཧΛ࣮૷ ͢Δ͜ͱͰɺϞϊϦγοΫ େ͖ͳҰմ ԽΛආ͚Δ͜ͱ͕༰қͰ͋Δɻ • खॱॻϕʔεͷࣗಈԽ͸8FC"1*ͱ૬ੑ͕ྑ͍ • ैདྷ͸ॲཧσʔλΛϝϞϦ౉͢͠Δ͜ͱ͕ओྲྀͰɺϑΝΠϧ౉͠͸ʮ֨޷ѱ͍ʯͱ͞ Ε͖ͯͨɻ • 8FC"1*΁ͷ৘ใ఻ୡ͸ϑΝΠϧ౉͠ 1045 ʹͳΔͨΊɺΉ͠ΖϑΝΠϧ౉͠ͷํ͕ ॊೈʹ8FC"1*࿈ܞͰ͖ΔΑ͏ʹͳ͖ͬͯͨɻ • ࡞ۀؒʹ͓͚Δσʔλड͚౉͠ΛϑΝΠϧ౉͢͠Δ͜ͱͰɺ8FC"1*࿈ܞʹΑΔࣗಈ ԽΛࢹ໺ʹೖΕͨखॱΛ࣮ݱ͢Δ͜ͱ͕Ͱ͖Δɻ ৘ใॲཧֶձυΩϡϝϯτίϛϡχέʔγϣϯݚڀୈճݚڀձൃදࢿྉ͔Β खॱΛߏ଄Խ͔ͯ͠ΒࣗಈԽ͢Δ
  3. Operation Lab ӡ༻ઃܭϥϘ खॱΛ$-*Խ͔ͯ͠ΒࣗಈԽ͢Δ • $-*ϕʔεͷࣗಈԽ͸ଞਓͰ΋ཧղ͠΍͍͢ • ࡞ۀखॱΛྲྀΕ࡞ۀԽ͠ɺద੾ʹ੔ཧɾ෼ׂ͢Δ͜ͱͰΘ͔Γ΍͘͢ͳΔɻ • $-*ϕʔεͷࣗಈԽ͸ϞϊϦγοΫԽΛආ͚΍͍͢

    • ͭͷ͜ͱΛ্खʹͰ͖ΔখཻͷεΫϦϓτΛ࡞੒͠ɺखॱ ࢓༷ ʹैͬͯϑϩʔॲཧ Λ࣮૷͢Δ͜ͱͰɺϞϊϦγοΫ େ͖ͳҰմ ԽΛආ͚Δ͜ͱ͕༰қͰ͋Δɻ • $-*ϕʔεͷࣗಈԽ͸8FC"1*ͱ૬ੑ͕ྑ͍ • ैདྷ͸ॲཧσʔλΛϝϞϦ౉͢͠Δ͜ͱ͕ओྲྀͰɺϑΝΠϧ౉͠͸ʮ֨޷ѱ͍ʯͱ͞ Ε͖ͯͨɻ • 8FC"1*΁ͷ৘ใ఻ୡ͸ϑΝΠϧ౉͠ 1045 ʹͳΔͨΊɺΉ͠ΖϑΝΠϧ౉͠ͷํ ͕ॊೈʹ8FC"1*࿈ܞͰ͖ΔΑ͏ʹͳ͖ͬͯͨɻ • ࡞ۀؒʹ͓͚Δσʔλड͚౉͠ΛϑΝΠϧ౉͢͠Δ͜ͱͰɺ8FC"1*࿈ܞʹΑΔࣗಈ ԽΛࢹ໺ʹೖΕͨखॱΛ࣮ݱ͢Δ͜ͱ͕Ͱ͖Δɻ
  4. Operation Lab ӡ༻ઃܭϥϘ ͳͥɺ9.-ʹ͔ͨ͠  ೥ࠒ 13 Doc ΠϯΫϧʔυ ΠϯΫϧʔυΛલఏͱ͢Δ࣌୅΁

    ࠶ར༻Λલఏ ݸผࣄ৘Λهड़ when where who what how υΩϡϝϯτࢿ࢈Λ࠶ར༻͢Δ why ਓ͕ຖճهड़͢Δ ౰࣌͸ϚογϡΞοϓͷᴈ໌ظ
  5. Operation Lab ӡ༻ઃܭϥϘ ͳͥΠϯΫϧʔυ 14 Doc ΠϯΫϧʔυ खॻ͖Λલఏͱ͠ͳ͍࣌୅΁ ࠶ར༻Λલఏ ݸผࣄ৘Λهड़

    when where who what how υΩϡϝϯτࢿ࢈Λ࠶ར༻͢Δ why ਓ͕ຖճهड़͢Δ γΣϧεΫϦϓτͰ (൒)ࣗಈੜ੒
  6. ΠϯΫϧʔυΛ׆༻͢ΔυΩϡϝϯςʔγϣϯ • $47σʔλΛΠϯΫϧʔυͯ͠ςʔϒϧදࣔ • ιʔείʔυΛΠϯΫϧʔυͯ͠ϋΠϥΠτදࣔ • ιʔείʔυͷಛఆൣғΛΠϯΫϧʔυͯ͠දࣔ • ஔ׵ͷఆٛͱద༻৔ॴͷهड़ΛΠϯΫϧʔυ •

    υΩϡϝϯτͷύʔπΛΠϯΫϧʔυ SF45SVDUVSFE5FYUܗࣜ Operation Lab ӡ༻ઃܭϥϘ Ұ౓ॻ͍ͨυΩϡϝϯτͷ࠶ར༻΍γεςϜͷग़ྗ Λ׆͔ͨ͠൒ࣗಈυΩϡϝϯςʔγϣϯ ଟ࠼ͳΠϯΫϧʔυػೳ
  7. Operation Lab ӡ༻ઃܭϥϘ ࣄྫ+"846($-*ઐ໳ࢧ෦ 22 ENV FLOW RESULT API ίϚϯυ

    γφϦΦ ϋϯζΦϯखॱ γΣϧεΫϦϓτͰੜ੒ + ΧελϜ ਓ͕هड़ ΠϯΫϧʔυ ࡞Γஔ͖ͨ͠େྔͷυΩϡϝϯτϞδϡʔϧΛ ΠϯΫϧʔυͯ͠ɺ৽نυΩϡϝϯτΛ࡞੒ ཁૉਤ  ճ։࠵த໿ճ෼ 4QIJOYͷ׆༻ྫ ࢖͍ࣺͯखॱ
  8. Operation Lab ӡ༻ઃܭϥϘ ࠷ۙ+"846($-*ઐ໳ࢧ෦ 23 γΣϧεΫϦϓτͰ શ໘తʹࣗಈੜ੒Խ Doc ΠϯΫϧʔυ ࠶ར༻Λલఏ

    ݸผࣄ৘Λهड़ when where who what how υΩϡϝϯτࢿ࢈Λ࠶ར༻͢Δ why ਓ͕ຖճهड़͢Δ
  9. Operation Lab ӡ༻ઃܭϥϘ ·ͱΊखॱॻͷ࡞Γํ 27 when where who what how

    υΩϡϝϯτࢿ࢈Λ࠶ར༻͢Δ why ਓ͕ຖճهड़͢Δ Doc ΠϯΫϧʔυ ΠϯΫϧʔυΛલఏͱ͢Δ࣌୅΁ ࠶ར༻Λલఏ ݸผࣄ৘Λهड़ Ұ౓ॻ͍ͨυΩϡϝϯτͷ࠶ར༻΍γεςϜͷग़ྗ Λ׆͔ͨ͠൒ࣗಈυΩϡϝϯςʔγϣϯ
  10. Operation Lab ӡ༻ઃܭϥϘ େࣄͳ͜ͱ͸ʮۀ຿ͷߏ଄Խʯ ʮ໰୊ΛࠜੑͰղܾ͢Δͷ͸അࣛͰ͢ɻ ໰୊ΛΤϯδχΞϦϯάͰղܾ͢Δͷ͕ ΤϯδχΞͷ࢓ࣄͰ͢ʯ !ZPTIJPSJ ߏ଄Խ ͜͜Ͱ͸ʮΤϯδχΞϦϯά

    ޻ֶ ͷ࣮ફʯʹ͍ۙҙຯͰ࢖͍·͢ɻ ޻ֶͰ͸ԿΒ͔ͷߏ଄෺ɾߏ଄ମΛ࡞Δ͜ͱ͕ෆՄආͳͨΊͰ͢ɻ http://d.hatena.ne.jp/Yoshiori/20120217/1329491437