「運用マニュアル（システム）」を作成してみる

この記事は、「[架空プロジェクトを通してシステム開発とドキュメント作成を体験してみる（2022 Late）](https://qiita.com/minimumskills/items/aedf6a93658db3f74747)」の記事の一部です。

## 運用マニュアル（システム）の概要

運用マニュアル（業務）では、システムを利用して行う業務の手順を記載しています（かなり簡易です。すみません）。

|項目|内容|
|-|-|
|作成目的|運用（システム）の手順の說明|
|記述すべき内容|各種業務の実施手順|
|作成タイミング|運用テストの実施まで|
|対象者|運用担当者（技術者）|
|ファイル形式|パワーポイント, Excel, Word|
|備考||

>一般的にはどうなのか？が気になる人は後半にある「一般的には（参考）」に先に目を通してもらったほうがいいかもしれません。

### サンプルダウンロード

サンプルのダウンロードは[こちら](https://docs.google.com/uc?export=download&id=1XymEkqJqSk6IeKHox-omXJvPvgS6uH7j)から。

## 作成してみる

では、作成していきましょう。


### 作成方針・ポイント

作成のポイントは特にありませんが、実際に運用を担当するメンバーの業務経験やITリテラシ等を考慮した内容にすべきと思います。代表的な業務を１例にサンプルマニュアルを作成し、事前にレビューを受けるなどが理想です。

>既にマニュアル的なものがある場合はその形式に準拠する方がユーザーフレンドリーかもしれません。

### 記述内容（アウトライン）

今回は下記のような項目を記述してみました。

* 運用業務一覧
* Webサイト稼働監視（概要）[業務例１]
* 補足：Webサイト監視設定
* 障害時対応 [業務例２]
* 補足：ダウン通知受け取り時の対応
* 補足：改ざん通知受け取り時の対応
* 補足：メンテナンス中コンテンツへの切替

>概要、補足情報を業務分用意します。

### 記述例（サンプルから抜粋）

では、サンプルの主要なページについて少し解説したいと思います。

>本当にサンプルで書いてるだけで、実業務ではもっとしっかり書くべきです。

#### 表紙

特に補足することはありません。

![000001.jpg](https://drive.google.com/uc?export=view&id=1UWE7Vg1V9krgL3y0dTGUlMx0LYTb-pSY)

#### 目次

こんな感じ。

![000010.jpg](https://drive.google.com/uc?export=view&id=1oxLlAv8BbDJSHiulQszbW9AuE1Vewbzt)


#### 運用業務一覧

まずは当該資料で說明の対象となる業務の一覧を提示しています。

![000020.jpg](https://drive.google.com/uc?export=view&id=1MXFYwmmyjhizhdbzP1KbpdTpfd2Pruhf)

#### Webサイト稼働監視（概要）

そして、各業務の概要を說明。

![000030.jpg](https://drive.google.com/uc?export=view&id=1fooeWidv2uYVFCvy0x6kcPzBI4fTgO8A)

#### 補足：Webサイト監視設定

補足資料としてWeb監視の内容・変更方法などを記載しています。

![000040.jpg](https://drive.google.com/uc?export=view&id=1eqn_2hU-1F0WXuk5so56fPHnwth2ryHB)

#### 障害時対応 

障害発生時の対応の概要について記述。

![000050.jpg](https://drive.google.com/uc?export=view&id=1alB2sdNHhGSk4jFQE1VD1WFskeZPP0wb)

#### 補足：ダウン通知受け取り時の対応

ダウンの可能性がある場合の対応フロー。

![000060.jpg](https://drive.google.com/uc?export=view&id=1ZZnGQxrlr0MDPgY2fsYf2gf4r44SyhuV)

#### 補足：改ざん通知受け取り時の対応

改ざんの可能性がある場合の対応フロー。

![000070.jpg](https://drive.google.com/uc?export=view&id=1XVNR-Abh1D803tFIPjRin-2shAFE_Kxt)

#### 補足：メンテナンス中コンテンツへの切替

メンテナンス画面への切替（Webサーバが動作してる場合）。

![000080.jpg](https://drive.google.com/uc?export=view&id=1X2QxfWWu4OtHT5jrphilTVOtAQDkn9Pd)

#### システム稼働率報告（概要）

週次となっているシステム稼働率報告の手順。

![000090.jpg](https://drive.google.com/uc?export=view&id=17ItapYwziS1D6G89uMY9thPo5Ph5sx4D)

#### 補足：稼働率の計算と報告

計算方法やSlackへの投稿フォーマット等を補足。

![000100.jpg](https://drive.google.com/uc?export=view&id=1IpG1iKjC3wElGQBZIHbB977OZiQWtIPX)

#### セキュリティーチェック（概要）

年次のセキュリティーチェック方法（方針）を記載。

![000110.jpg](https://drive.google.com/uc?export=view&id=1fExML5z3SJaEEFjJwtdj7HinQpsZ5Fcf)

#### システムアップデート（概要）

システムアップデートの方法（方針）を記載。

![000120.jpg](https://drive.google.com/uc?export=view&id=1uLA-MfiVoy8OOWm9Aq84K7-XcOaWeWy8)

#### システム改修レベルと必要な手続き

アップデートの内容による対応を記述。

![000130.jpg](https://drive.google.com/uc?export=view&id=10mWXBtJZjFIOq5P3fCpYRwueTn8ilMiZ)

## 一般的には（参考）

### 実践ガイドブックでは？

実践ガイドブックには運用マニュアルに関するテンプレートは共有されていませんが、業務マニュアルについては「業務マニュアル サンプル」とか「業務マニュアル　テンプレート」とかで検索すればサンプルが沢山見つかると思います。


## 参考

* [デジタル庁 デジタル社会推進標準ガイドライン](https://www.digital.go.jp/resources/standard_guidelines/)
* [DS-120 デジタル・ガバメント推進標準ガイドライン実践ガイドブック　各種テンプレート](https://www.digital.go.jp/assets/contents/node/basic_page/field_ref_resources/e2a06143-ed29-4f1d-9c31-0f06fca67afc/ec6f6641/20220422_resources_standard_guidelines_guideline_09.zip)