システム運用マニュアルの作成の考え方 ※構成および内容

普段の仕事から。とあるシステム運用のコスト削減&手順書の作り替えに携わりましたので、そこで得た知見をまとめておきたいと思います。

目次
■必要とされるドキュメントの構成
■誰のためのドキュメントか
■それぞれのドキュメントの位置づけ(目的と内容)
■それぞれのドキュメントを作成するのに貫く思想

 

必要とされるドキュメントの構成

1)業務フロー
2)作業フロー
3)詳細手順

誰のためのドキュメントか

前提として、

1)2)は管理者が見る。
2)3)は作業者が見る。

それぞれのドキュメントの位置づけ(目的と内容)

1)業務フロー

目的:
管理者が全体像を知ることができるものであること。

内容:

独立した意味のまとまりのフローとすること。
顧客との調整は絶対に独立させること。

2)作業フロー

目的:
・コスト削減プロジェクト時に、コスト構造を分析できる
ものであること。

内容:

・1)の独立したまとまりを分解したもの。
・粒度は、どこにコストが集中しているかを突き止めれるレベル。
・InputとOutputの全体像を定義すること。
・作業手順はここでは書かないこと。

3)詳細手順

目的:
・作業者がこのドキュメントでもって作業を完結できるものであること。

内容:

・作作業途中で、1)2)を参照する必要がない詳細手順であること。
・ベテランの判断が入る余地なく、すべての作業の手順・判断基準が明確であること。
・手順が経験と勘に拠る部分がある場合、その部分は明確に切り出しておくこと。

それぞれのドキュメントを作成にするにあたって貫く思想

次の三つである。

・見た目が分かりやすいか
・変更が入ったときのメンテナンス効率がよいか
・それぞれの位置づけのドキュメントにおいて漏れがないか

※補足

1)は、2)を俯瞰し、
2)は、3)を俯瞰する。

1)は、管理者のみが分かればよい。

3)は、作業者のみが分かればよい。

2)は、1)2)の橋渡しである。

管理者と作業者の両方が分かるないようにしなければならない。

特に2)をどのようなものにするかは、管理者と担当者のディスカッションが必須と考える。

おすすめの記事