2012-01-18 EIC Communication Society Technical Committee on Internet Architecture See also http://rsh.csh.sh/operation-document/ (Operation Document Model)

1. 運用ドキュメントの分類と構造化
Classification and structure of operation document
波田野 裕一
（運用研究会 / 日本UNIXユーザ会)
2012-01-18 EIC Communication Society Technical Committee on Internet Architecture

2. インターネット運用の現状
• インターネットの急速な普及および発展により、イン
ターネットを含むIT情報基盤は社会基盤(インフラ)とし
ての性格を色濃く帯びてきている。
• その一方でシステム運用およびサービス運用の現場に
おいては、要員に対する恒常的な高負荷、属人的な運
用、トラブルの多発などにより、事業継続性の面から
もコストの面からもリスクを内在させ、効率面での課
題を抱えつつも、現場の個々人の過大な努力により日々
の運用を維持しているのが現状である。

3. システム運用現場の諸問題
1. 高負荷
2. 属人的
3. 見えぬ費用対効果
Uncontrolable!
2009年

4. 運用現場の問題点解消のために
1. 高負荷
2. 属人的
3. 見えぬ費用対効果
運用現場の問題点
ブラックボックス化
低付加価値化
業務が複雑化
1. 業務の複雑化を許さない仕組み
作り
2. 業務のブラックボックス化を許
さない仕組み作り
3. 業務価値の陳腐化を許さない仕
組み作り
運用設計の目的運用方法論の目的
‣ サービスの安定
社会基盤に相応しい安定運用。
‣ 業務負荷の平準化
うまく業務が回る運用現場。
‣ 運用に対する評価の適正化
適正な利潤を生む現場と、適切に評価される要員。
1.「運用」への期待の明確化
3. 期待に対する消費リソースの測定化
2.「運用設計」の確立
常にシンプル
常に見える
常に価値を生む
2010年

5. ✓ 運用ドキュメントと運用業務は表裏一体の関係にある。!
✓ ツールやスキルに対する的確な要求は、客観的なドキュメントがあってはじめて
実現可能となる。!
✓ ドキュメントのない業務は、存在しないことに近く、客観評価されない。!
✓ 事業の継続性は、ドキュメントがあってこそ確保可能となる。
運用ドキュメントの位置付け
ドキュメントのない作業は、客観的には
「業務が存在しない」に等しい
(Internet Week 2009 「運用方法論」より)
「運用は忙しそうにしているけど、何やっているのかわからない」と言われてしまう。

6. 運用研究会 (2010年1月現在)
研究会メンバー
伊賀野 康生 (Verizon Business)!
谷津 航 (KDDI ネットワークオペレーションセンター)!
豊野 剛 (インターネットマルチフィード)!
中西 晶 (明治大学 経営学部 教授)!
波田野 裕一 (日本UNIXユーザ会 会長) [研究会主査]!
水越 一郎 (NTT東日本 ブロードバンドサービス部 サービス開発担当部長)!
村益 寛紀 (Telecom ISAC Japan ACCESS-WG主査，ソフトバンクBB)!
協力団体!
•財団法人日本データ通信協会 テレコム・アイザック推進会議 ACCESS-WG!
•日本UNIXユーザ会 (jus)

7. 今、運用ドキュメントが熱い
‣ 2010年11月 手順書友の会 発足 (JANOG系)!
‣ 2010年12月 jus勉強会!
‣ ドキュメントを作りたくなる魔法のツール Sphinx!
‣ 2011年6月 odstudy 発足 (インフラエンジニア系)

8. 道具もそろってきた
‣手軽な分散バージョン管理システム"
‣ Mercurial"
‣ドキュメントのための構造化言語"
‣ 構造化記法 reST + ドキュメントプロセッサ Sphinx"
‣ blockdiag"
‣管理媒体"
‣ バグトラッキングシステム Redmine + リポジトリ連携

9. Internet Week 2011

10. 発表の概要 (修正)
本論では、!
!
1. 記述対象による運用ドキュメントの分類、!
2. 分類を意識したドキュメントの構造化!
!
を検討し、運用ドキュメントの作成維持工数の抑制および業務利便性向上の効果について定性的に考察する。
本論では、運用ドキュメントの作成維持工数の抑制および業務利便性向上のための!
!
1. 記述対象による運用ドキュメントの分類、!
2. 分類を意識したドキュメントの構造化!
!
について考察する。
24時間365時間稼動を求められる現在の運用現場において、ドキュメント不足による属人化やスキルの偏在に
よるトラブルの多発および特定メンバーの異動や退職による事業継続性リスクが課題となっている。

11. 分類と構造化の目的
‣アンドキュメンテッド運用からの脱却"
‣ 属人的(ブラックボックス/高負荷)運用からの脱却"
‣ クラウドに われない、運用の生き残り"
‣ 工学的視点に立つ高度な運用へ"
‣100%手書き/属人的なドキュメント作成からの脱却"
‣ ITサービスの提供者がちゃんとITする(自動化)時代へ"
‣ 適切な自動化には構造化が、適切な構造化には類型化(分類)が必
要"
‣ 工学的視点に立つ高度なドキュメントロジックへ

12. ‣ドキュメントの資産性/費用性"
‣時間軸に対するテーマ位置による分類"
‣ドキュメント構造化の基本要素
分類と構造化の議論

13. 1. 運用ドキュメントとは

14. 運用ドキュメントとは
「運用業務に関連して、!
自分や他者に共有する目的で、!
書かれる文書」のこと

15. 運用ドキュメントの必要性
脱属人化のために必要
客観化のために必要
整理のために必要
「自分達のやっていることを知る&改善するために」
「自分達のやっていることの説明&(自己・他者)評価のために」
「自分達のやっていることの安定化&永続化のために」

16. 運用ドキュメントの悩み
!
✓ 作られない/保守されない"
‣ 書かない!
!
✓ どこにあるかわからない"
‣ 読まない!
!
✓ 誰が管理しているかわからない"
‣ 管理できない!

17. Why
Worth
What
Who
Whom
Which
Where
When
How Much
なぜ書く?
書く価値?
何を書く?
誰視点で書く?
誰宛に書く?
どれから書く?
どこに書く?
いつ書く?
書く工数は?
記述のHow 管理のHow3つの根幹
ドキュメントを書かない理由 8W2H

18. Why
Worth
What
Who
Whom
Which
Where
When
How Much
なぜ書く?
書く価値?
何を書く?
誰視点で書く?
誰宛に書く?
どれから書く?
どこに書く?
いつ書く?
書く工数は?
記述のHow 管理のHow3つの根幹
なぜ書くのか?
ドキュメントを書かない理由

19. 必要性が増していくドキュメント
• 業務の複雑化、変化の激化"
• 口伝で伝えるには限界を迎えている。(トラブル多発リスク)!
• グローバリゼーション & 均質社会からの変化"
• 空気を読むこと前提での業務は難しくなりつつある。(コミュニケーションの変質)!
• 強み(ノウハウ)の無い現場はクラウド/オフショアに食われていく。"
• 客観的なノウハウはドキュメントの上に積み上がっていく。
「今現在は困っていないから」とは、言うものの....
ドキュメントが無い事によるリスクが、かつてないほどに高まっている。
現場や自分達を守る・育てるために書く

20. Why
Worth
What
なぜ書く?
書く価値?
何を書く?
3つの根幹
ドキュメントを書かない理由
書くことの"
価値がわからない
何を書く?
ドキュメントの分類
スコープ が決まる

21. 2. 運用ドキュメントの価値
Worth 書くことの価値がわからない

22. 運用ドキュメント 2つ価値
1. 利用者から見た利用価値 (使ってナンボ)"
提供者から見た提供価値 (費用対効果)

23. 1. 利用価値
その価値は第一義的には「いかに使われたか」
(利用価値)で評価できる
一般的に「ドキュメント」と言われるものは非常に多種に渡り、その価値は多様
運用ドキュメントは「共有する目的」で書かれる文書

24. 2. 提供価値
定性的/定量的な費用対効果で評価し、注力すべき
ドキュメントにリソース集中
ドキュメントを提供する側では、そのドキュメントの作成維持に無限のリソース
を使用することはできない
ドキュメントの提供に関わる費用対効果が問われる

25. 2. 提供価値 (運用ドキュメントの資産性・費用性)
反復利用、再利用性の高さと、陳腐化の早さに着目して、その運用
ドキュメントの価値属性(資産性、費用性)を評価することができる
と考えられる。
資産性ドキュメント
費用性ドキュメント
• 反復利用・部品再利用性の高いドキュメント!
• 変更差分の継続更新により陳腐化回避を実現しているドキュメント
• 反復利用、部品再利用性の低いドキュメント!
• 差分更新の効果が低く、作成直後をピークに以後陳腐化していく
ドキュメント

26. 3. 記述対象による運用ドキュメントの分類
What 何を書くのかわからない

27. 1. 使う人の範囲"
‣ 自分、特定の現場、不特定多数"
2. 対象時間の範囲"
‣ 過去、現在、未来、普遍"
3. ドキュメントテーマ"
‣ 3類型 (状態 / 変化 / 活動)
運用ドキュメントに何を書くのか?
脱属人化
客観化
整理
記録
スコープ 目的
= 価値

28. ドキュメントテーマの3類型
時間軸 activity活動
状
態
変化後
変化
変化前
SCA分析 (仮称)
‣Status(状態)
‣Change(変化)
‣Activity (活動)

29. ドキュメントテーマの3類型
時間軸 activity活動
状
態
変化前 変化後
変化
主観: Define (定義) "
状態分析 / 設計 / 要求"
客観: Status (状態)"
スナップショット
主観: Activity (作業)"
オペレーション / リリース "
客観: Event (事象)"
ログ / インシデント
主観: Change (変更差分)"
変更分析 / 効果測定"
客観: Difference (変化)"
差分解析 / トレンド解析
主観: ヒト
客観: システム

30. 参考: ドキュメントテーマによる価値 (仮説)
activity活動
変化
状
態
• 反復・再利用性の高いドキュメント(資産性ドキュメント)。!
• 「変化」「活動」の起点・終点となる最も重要なドキュメント"
• 何らかの形で売却できる場合「収益性」があると言える。
• 反復作成されるが再利用はしにくい。(費用性ドキュメント)!
• 「運用の費用対効果」を説明するためのドキュメントとなるた
め「収益性」があると考えることもできる。!
• 「活動」の蓄積が変化を生む。"
• [留意]「変化させない事」が重要とされる業務もある。
• 反復作成されるが再利用はしにくい。(費用性ドキュメント)!
• コストが直接配賦されれば「収益性」があるが、共通配賦され
る場合は、作成自体が「運用コスト」と評価される。
ドキュメントテーマ

31. 5. 分類を意識したドキュメントの構造化

32. 構造化とは
「ばらばらになっているものを、一定の基準に従い論理
立てて整理すること」

33. ドキュメント構造化の要素
文章ブロック単位での意味付け (見出し)
単位情報の責務の明確化 (オブジェクト化)
!
読み手が認識しやすい位置への文章ブロックの格納 (目次)
情報をツリー構造で表現 (構造化)
!
文章ブロック間の関係付け (クロスリファレンス)
情報内ネットワーク構造の構築 (ネットワーク化)

34. ドキュメント構造化の効果
書き手が書きやすい
逆説的だが、対象を構造化しなければ書けないため、
構造化して捉えなおしたものは書きやすい
読み手が読みやすい
構造化されたドキュメントは全体を把握しやすく、拾
い読みもできる
半自動化が可能になる
人とシステムでドキュメントツリーの各部分の作成を分
担できる

35. 6. まとめ

36. まとめ
‣ ITサービスの提供者がちゃんとITする(自動化)時代へ"
‣ 自動化には構造化が、構造化には類型化(分類)が必要"
‣ 工学的視点に立つ高度なドキュメントロジックへ
‣アンドキュメンテッド運用からの脱却"
‣手書き/属人的なドキュメントからの脱却

37. ‣ドキュメントの資産性/費用性"
‣時間軸に対するテーマ位置による分類"
‣ドキュメント構造化の基本要素
分類と構造化の議論 (再掲)

38. ドキュメントテーマの3類型 (再掲)
時間軸 activity活動
状
態
変化前 変化後
変化
主観: Define (定義) "
状態分析 / 設計 / 要求"
客観: Status (状態)"
スナップショット
主観: Activity (作業)"
オペレーション / リリース "
客観: Event (事象)"
ログ / インシデント
主観: Change (変更差分)"
変更分析 / 効果測定"
客観: Difference (変化)"
差分解析 / トレンド解析
主観: ヒト
客観: システム

39. 今後
!
構造化や自動化について工学の!
知見を伺いつつ!
構造化の実践(reST)を進めたい