Contenu connexe
Similaire à 2015-10-31 クラウドネイティヴ時代の運用を考える 〜 ドキュメント駆動運用へ (20)
2015-10-31 クラウドネイティヴ時代の運用を考える 〜 ドキュメント駆動運用へ
- 20. 1. 利用価値 (その誕生から増幅へ)
‣ 反復利用されてはじめて価値が生まれる
‣ 使いたいときに使える。 反復利用が可能である。!
‣ 可用性 (Available)!
‣ 更新を継続することで価値(信頼)が高まる。 !
‣ 間違いが最小限(かつ最新)である。!
‣ 信頼性 (Reliability)!
‣ (部品)再利用により、ドキュメント数が増幅する!
‣ 利用機会の増大!
‣ 保守性 (Serviceability)
Operation Lab
運用設計ラボ
3. ドキュメントを作るなら価値を考えよう
- 21. 1. 利用価値 (価値の計測)
Operation Lab
運用設計ラボ
‣ 一般的に「ドキュメント」と言われるものは非常に多種に渡り、その
価値も多様である。
‣ 運用ドキュメントのように「使われてナンボ」と考えた場合、以下の
ようなベンチマークでその価値を評価できる。
読者の範囲を固定した場合、参照回数、利用期間の2つが
ドキュメント価値の重要な要素となる。
• 読者の範囲
◦水平方向: 社会的範囲 (特定現場 ∼ 不特定多数)
◦垂直方向: 社会的地位 (専門層/経営層 ∼ 一般層)
• 参照回数
• 利用期間(寿命)
3. ドキュメントを作るなら価値を考えよう
- 22. 1. 利用価値 (価値を低減させるもの)
Operation Lab
運用設計ラボ
• 時間の経過とともにドキュメントは経年劣化(陳腐化)していく。
• 信頼低下や陳腐化したドキュメントは利用されなくなり、利用価値を失っていく。
• 可用性低下による利用価値低減
• 使いたいときにドキュメントを利用できない。
• 信頼性低下による利用価値低減
• ドキュメントが信頼できない。
• 再利用性(保守性)低下による利用価値低減
• ドキュメントの維持保守ができない。(提供機会の増大どころではない。)
3. ドキュメントを作るなら価値を考えよう
- 25. 2. 提供価値 (ドキュメントの費用対効果)
‣ 反復利用の多さで工数説明のしやすさが変わる
• 反復利用の多いドキュメントは工数説明がしやすい!
• 反復利用の少ないドキュメントは工数説明がしにくい!
‣ 陳腐化の早さで掛けるべき工数が変わる!
• 陳腐化の早いドキュメントに工数を掛けるのは費用対効果が見あわない!
• 陳腐化の遅いドキュメントでも保守しなければ陳腐化(経年劣化)が進む!
‣ 再利用性の高さで陳腐化の早さが変わる!
• 再利用性の高いドキュメントは陳腐化を回避しやすい!
• 再利用性の低いドキュメントは陳腐化を回避しにくい (手間がかかる)
Operation Lab
運用設計ラボ
3. ドキュメントを作るなら価値を考えよう
- 26. 2. 提供価値 (運用ドキュメントの資産性・費用性)
Operation Lab
運用設計ラボ
反復利用、再利用性の高さと、陳腐化の早さに着目して、その運用
ドキュメントの価値属性(資産性、費用性)を評価することができる
と考えられる。
資産性ドキュメント
費用性ドキュメント
• 反復利用・部品再利用性の高いドキュメント!
• 変更差分の継続更新により陳腐化回避を実現しているドキュメント
• 反復利用、部品再利用性の低いドキュメント!
• 差分更新の効果が低く、作成直後をピークに以後陳腐化していく
ドキュメント
3. ドキュメントを作るなら価値を考えよう
- 28. 参考: ドキュメントテーマによる価値 (仮説)
Operation Lab
運用設計ラボ
activity活動
変化
状
態
• 反復・再利用性の高いドキュメント(資産性ドキュメント)。!
• 「変化」「活動」の起点・終点となる最も重要なドキュメント!
• 何らかの形で売却できる場合「収益性」があると言える。
• 反復作成されるが再利用はしにくい。(費用性ドキュメント)!
• 「運用の費用対効果」を説明するためのドキュメントとなるた
め「収益性」があると考えることもできる。!
• 「活動」の蓄積が変化を生む。!
• [留意]「変化させない事」が重要とされる業務もある。
• 反復作成されるが再利用はしにくい。(費用性ドキュメント)!
• コストが直接配賦されれば「収益性」があるが、共通配賦され
る場合は、作成自体が「運用コスト」と評価される。
ドキュメントテーマ
3. ドキュメントを作るなら価値を考えよう
- 30. 資産性・費用性 (一般的な例)
Operation Lab
運用設計ラボ
資産性ドキュメント 費用性ドキュメント
‣要求仕様書
‣システム/企画提案書
‣説明書/マニュアル
‣設計仕様書
‣技術論文
‣状態分析レポート (定期)
‣調査レポート (定期)
‣手順書 (マスター/テンプレート)
‣構成図
‣運用設計書
‣作業カタログ
‣リポジトリ
‣作業報告書 (都度)
‣日報/週報/月報 (都度)
‣電子メール/FAX (都度)
‣注文書 (都度)
‣依頼状 (都度)
‣案内状 (都度)
‣質問書 (都度)
‣回答書 (都度)
‣状態分析レポート (スポット)
‣調査レポート (スポット)
費用性ドキュメントのマスターテンプレートや、
検索可能な状態での共有データなどは資産性を持つ。
コストセンターと言われがちな運用現場の!
産み出す唯一の有形資産、とも言える。
工数をかけるべき
工数をかけても!
無駄かも
3. ドキュメントを作るなら価値を考えよう
- 35. ドキュメントの歴史 (紀元前∼19世紀)
Operation Lab
運用設計ラボ
手書きドキュメントの誕生 (粘土板)5300年前
(紀元前3300年)
1800年前
(2世紀)
手書きドキュメントの量産化 (紙)
1300年前
(7世紀)
定型ドキュメントの出力自動化 (木版印刷)
500年前
(15世紀)
定型ドキュメントの量産化 (活版印刷)
200年前
(18世紀末)
定型ドキュメントの大量生産化 (平版印刷)
150年前
(19世紀後半) 非定型ドキュメントの出力自動化 (タイプライタ)
約5300年にわたる「ドキュメント出力」の歴史
4. ドキュメンテーション技術の進展
- 47. 1. 分散バージョン管理システムを使う
• Git: プログラムの仕様ドキュメント向き
• Mercurial: 一般的なドキュメント向け
Operation Lab
運用設計ラボ
(主観です)
• コミットログをきっちり運用できるならば(世間的には)Git。
• 版数管理とドキュメント保全が主眼ならMercurialがオススメ。
6. クラウド時代のドキュメンテーション手法
- 48. 2. 構造化記法を使う (今後の要件)
Operation Lab
運用設計ラボ
• バージョン管理と相性が良いテキストドキュメント
• 記法が日常のメモと違和感がない
• 1つのソースコードで複数形式で出力 (PDF/HTML)
• 外部ドキュメントをインクルードできる (非同期更新)
6. クラウド時代のドキュメンテーション手法
- 49. 3. 分散化と構造化と非同期更新を意識する
• 分散化: サブリポジトリの活用
• ソースリポジトリ全体はツリー構造
• メインタイプのドキュメントリポジトリ (ツリートップ)
• サブタイプのドキュメントリポジトリ (サブツリー)
• 非同期更新: 外部ドキュメントのinclude多用
• 構造化: ここがドキュメント作成のキモ
Operation Lab
運用設計ラボ
6. クラウド時代のドキュメンテーション手法
- 54. 構造化記法を使う例
Operation Lab
運用設計ラボ
• オープンソースのドキュメンテーションビルダ
• 元々はPythonによるPythonドキュメントのための実装
• Sphinx1.0以降は、Pythonに特化した機能が分離されて汎用化
• BSDライセンス
• マークアップ言語としてreSTructured Textを利用
• 基本書式は普通のテキストメモに見える。
• テキストファイルなのでバージョン管理が簡単。
• ドキュメント作成に嬉しい多様な機能
• ワンソースマルチアウトプット (html / PDF / text / manなど)
• 独自拡張可能なディレクティブ、ロール、テーマ
7. クラウド時代のドキュメンテーションデモ