運用ドキュメントの構築

http://rsh.csh.sh/operation-document/activity/materials/20120118-ia-operation-doc.pdf

  • 最初にコーディング規約が大事。
  • 全体的な統一感

語彙、構造、リファレンス

構造

  • ツリー構造を意識する
  • 見出しルール

リファレンス

  • メッセージ(やりとり)表記
  • 構造化パターン
  • サンプル類型

手順の構造化

  • workflow の作成
    • 利害関係者間の流れを actdiag で書く (workflow / stakes-holder)
    • チーム間の流れを actdiag で書く (workflow / team-workflow)
    • 担当者内の流れを actdiag で書く (workflow / handler-workflow)
      • 担当者内の流れに従い、手順書を作成する。
  • handler-workflow から process(自動化単位) への分割
    • 処理のモデル化
    • 入出力の対象や処理内容で分割する: 複数のプロセスに分ける