0
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

IT運用会社に勤めていた私が作ったオペレーションマニュアル作成プロンプト

Posted at

はじめに

私は、以前ITシステムの運用会社で働いていました。そこでの知見をもとに、手順書作成に役立つプロンプトを作成しました。 このプロンプトが世界中のオペレーション品質の向上に貢献できたなら、これほど嬉しいことはありません

 
この手順書プロンプトの強みは、次のとおりです:

  • 1つの文章に複数の指示を書かず、明瞭で分かりやすい構成にしていること
  • 実行手順と確認手順を左右で分け、品質と再現性の向上に寄与していること
  • 取り返しのつかない操作の前に、必ず注意喚起を促していること
  • そして何より、見やすさと使いやすさを両立した優れたデザインであること

明日からの皆さまのお仕事が、もっと安全にもっと楽しく進みますように。お祈りしております

作成例

プロンプト文

以下を生成AIに貼り付けて、インプットを追加してください。

あなたは経験豊富なIT運用専門家として、ユーザーから提供されるインプット情報をもとに「誰でも正確に実行できる」最高品質のHTML版運用手順書を作成してください。この手順書は、属人化を排除し、ヒューマンエラーを最小化することを目的とします。
文章は語感とリズムを重視しポジティブで読みやすい自然で滑らかなビジネス文章にしてください。

## 基本方針

「誰が実行しても同じ結果が得られる手順書」を最終ゴールとし、新人でも迷わず実行できる明確性と、経験者でも効率的に作業できる実用性を両立させてください。以下の原則を必ず守ってください。

### 1行1指示の原則
- 各ステップは1行につき1つの指示のみを記載する
- 複数の操作を1つの文に含めない
- 「〇〇して△△する」ではなく「〇〇する」「△△する」と分ける

### 実行と確認の完全分離
- すべての操作ステップに対応する確認ステップを設ける
- 実行ステップは□マークで開始
- 確認ステップも□マークで開始
- 期待される結果を明確に記載
- 後戻りできない手順の手前に注意喚起をする(手順の表の途中で黄色背景黒文字、セル統合で注意喚起する)

### 具体的で数値化された指示
- 「しばらく待つ」→「30秒間待機する」
- 「負荷が下がる」→「CPU使用率が50%以下になる」
- 「エラーがない」→「エラーログが0件である」

### 属人化の完全排除
- 固有名詞ではなく役割で記載(「田中さん」→「データベース管理者」)
- 専門用語は必ず説明を併記
- 暗黙知や経験則に依存しない記述

## 手順書の構成

### 表紙セクション

#### 表紙
- 魅力的なタイトルとヒーローセクション
- unsplash.comからテーマに沿った背景画像を使用
- 作業概要を簡潔に記載

#### 基本情報
表形式で以下を記載(左端に番号を付与):

| # | 項目 | 内容 |
|---|----------|--------------------------|
| 1 | 手順書タイトル | {作業内容が一目で分かるタイトル} |
| 2 | バージョン | {V1.0等} |
| 3 | 作成日 | {YYYY/MM/DD} |
| 4 | 作成者・部署 | {氏名・部署} |
| 5 | 承認者 | {責任者名} |
| 6 | 適用期間 | {有効期間} |

#### 改訂履歴
表形式で記載:

| # | 版数 | 更新日 | 更新者 | 更新内容 |
|---|------|--------|--------|----------|
| 1 | 1.0 | 2024/01/15 | 作成者名 | 初版作成 |

### 1. 前提・準備セクション

#### 1.1. 目的と背景
- なぜこの作業が必要なのかを400~1000文字で明確に記述
- ですます調で自然な文章にする
- 作業の背景と達成したい目標を記載

#### 1.2. 作業フローチャート
- HTML図でフローチャートを記載 改行せず 箱▶箱▶箱▶ くらいの簡易なものにする
- 意味のある色遣いを使用(実行:青、確認:緑、エラー:赤等)
- 左から右の流れを意識

#### 1.3. 前提条件

##### 対象範囲
以下の例を参考に表形式で記載(左端に番号):

| # | 項目 | 内容 |
|---|------|------|
| 1 | 対象システム | {システム名} |
| 2 | 対象環境 | {本番/検証/開発} |
| 3 | 対象サーバー | {サーバー名またはIP} |
| 4 | 影響を受けるサービス | {サービス名} |
| 5 | 標準所要時間 | {X時間Y分} |
| 6 | サービス停止時間 | {X分(停止する場合)} |
| 7 | 利用者への影響 | {影響の内容} |
| 8 | 実施可能時間帯 | {平日深夜等} |

##### 必要な権限・環境
以下の例を参考に表形式で記載(左端に番号):

| # | 項目 | 内容 | チェック欄 |
|---|------|------|----------|
| 1 | システム管理者権限 | {システム名}の管理者権限 | □ |
| 2 | サーバー接続権限 | {サーバー名}への接続権限 | □ |
| 3 | ツール利用権限 | {ツール名}の利用権限 | □ |
| 4 | ネットワーク接続 | VPN接続(リモート作業の場合) | □ |

##### 事前準備項目
以下の例を参考に表形式で記載(左端に番号):
※エラーが発生した場合は第3章のエスカレーション一覧を参照すること

| # | 項目 | 詳細内容 | チェック欄 |
|---|------|----------|----------|
| 1 | バックアップ取得 | 対象:{バックアップ対象}<br>取得先:{保存場所}<br>確認方法:{確認手順} | □ |
| 2 | 事前通知完了 | 通知先:{部署・担当者}<br>通知内容:{作業内容・時間・影響} | □ |
| 3 | ツール・アカウント準備 | ツール:{ツール名とバージョン}<br>アカウント:{利用アカウント} | □ |

##### 注意事項とリスク
以下の例を参考に表形式で記載(左端に番号):

| # | 分類 | 内容 | チェック欄 |
|---|------|------|----------|
| 1 | 重要な注意点 | {重要な注意点1} | □ |
| 2 | 重要な注意点 | {重要な注意点2} | □ |
| 3 | リスク | {想定されるリスク} | □ |
| 4 | 対策 | {リスク軽減策} | □ |
| 5 | ロールバック条件 | {条件1} | □ |
| 6 | ロールバック条件 | {条件2} | □ |

### 2. オペレーション手順
{以下の例を参考にインプットを理解して読みやすい手順書を作ること}

#### 2.1. {作業項目名1}手順

**目的:** {この作業で達成する内容}  
**所要時間:** 約{X分}

| # | 大項目 | 小項目 | 実施手順 | 確認手順 | 備考(既知エラーや分岐の指示) | チェック欄 |
|---|--------|--------|----------|----------|--------------------------------|----------|
| 1 | システム状態確認 | ログイン | 対象システムにログインする | 正常にログインできることを確認<br>期待値:ダッシュボードが表示される | ログインできない場合は3.エスカレーション先に連絡 | □ |
| 2 | システム状態確認 | サービス状態確認 | 以下のコマンドを実行:<br>`systemctl status {サービス名}` | サービスが稼働していることを確認<br>期待値:Active: active (running) | 停止している場合は手順5に進む | □ |
| 3 | 設定確認 | 設定ファイル確認 | 設定ファイルを開く:<br>`cat /etc/{設定ファイル名}` | 設定値が正しいことを確認<br>期待値:{具体的な設定内容} | 設定が異なる場合は手順10に進む | □ |

#### 2.{X}. {作業項目名X}手順

**目的:** {この作業で達成する内容}  
**所要時間:** 約{X分}

各作業項目ごとに上記と同じ表形式で記載してください。以下の要素を含めること:
- 大項目:作業の分類(システム確認、設定変更、動作確認等)
- 小項目:具体的な作業内容
- 実施手順:具体的なコマンドや操作手順(実行はどのような手段でどのように実行するかを明記する。確認操作であっても、どのように確認するかを具体的に書く)
- 確認手順:実施手順の正当性を示す確認手順(具体的な説明とともにxxであること。という記載にする。確認が複数あれば、1)2)と、改行を入れて分かりやすくする。必要に応じてxxのエラーが発生していないこと。という否定系の確認も加える)
- 備考:エラー時の対応や条件分岐の指示

#### 2.{最終}. 作業完了チェックリスト

以下例のすべての項目をチェックしてから作業完了とすること:

| # | 確認項目 | 確認手順 | 備考 | チェック欄 |
|---|----------|----------|------|----------|
| 1 | サービス正常稼働 | `systemctl status {サービス名}`を実行 | Active: active (running)が表示されること | □ |
| 2 | アプリケーション応答 | `curl http://localhost:8080/health`を実行 | HTTP 200 OKが返されること | □ |
| 3 | データベース接続 | `mysql -u admin -p -e "SELECT 1;"`を実行 | 1が返されること | □ |
| 4 | エラーログ確認 | `/var/log/application.log`を確認 | 最新30分以内にERRORレベルログが0件 | □ |
| 5 | CPU使用率確認 | `top`コマンドで確認 | 80%以下であること | □ |
| 6 | メモリ使用率確認 | `free -h`コマンドで確認 | 使用率90%以下であること | □ |
| 7 | ディスク使用率確認 | `df -h`コマンドで確認 | 使用率85%以下であること | □ |

### 3. エスカレーション先

#### 3.1. エスカレーション判断基準

以下の例を参考に表形式で記載:

| # | レベル | 条件 | 対応時間 |
|---|--------|------|----------|
| 1 | レベル1(チームリーダー) | 手順書に記載のない想定外エラーが発生 | 即座 |
| 2 | レベル1(チームリーダー) | 作業開始から30分経過しても完了できない | 30分以内 |
| 3 | レベル1(チームリーダー) | システムパフォーマンスに異常を検出 | 即座 |
| 4 | レベル2(管理職) | サービス全体の停止が発生 | 即座 |
| 5 | レベル2(管理職) | データ損失の可能性がある | 即座 |
| 6 | レベル2(管理職) | セキュリティインシデントの疑い | 即座 |

#### 3.2. 連絡先一覧

| # | 役割 | 氏名 | メールアドレス | 電話番号 | 連絡順序 |
|---|------|------|----------------|----------|----------|
| 1 | 作業責任者 | {氏名} | {メールアドレス} | 内線{番号}、携帯{番号} | 第1連絡先 |
| 2 | システム管理者 | {氏名} | {メールアドレス} | 内線{番号}、携帯{番号} | 第2連絡先 |
| 3 | データベース管理者 | {氏名} | {メールアドレス} | 内線{番号}、携帯{番号} | 第3連絡先 |
| 4 | 課長 | {氏名} | {メールアドレス} | 内線{番号}、携帯{番号} | 管理職連絡先 |
| 5 | 運用センター | - | {メールアドレス} | {24時間対応電話番号} | 緊急時24時間対応 |

## HTMLデザイン要件

### 基本レイアウト
- 左固定サイドバー目次(250px幅)
- メインコンテンツ(目次と重ならないよう配置)
- 各章・節へのページ内ジャンプリンク

### デザイン仕様
- フォント:Yu Gothic UI
- カラーテーマ:青・紺ベースの落ち着いたデザイン
- 背景:白系
- 表の列見出し:全体:紺色背景・白文字 2章のメイン手順書本体:濃緑背景・白文字
- 各章に枠線とページ番号

### 色分けルール
- 確認項目:緑
- アクション:青
- 問題点・注意:赤

### 視覚的要素
- 各章冒頭に小ヒーローエリア(CSS/SVG使用)
- 表紙と各章のヒーローセクションにunsplash.comの背景画像
- 重要点は太字・下線・マーカーで強調
- 章タイトルに効果的な区切り線
- 各種表の列幅を自動調整し無駄なスペースをなくすこと

## 文章品質基準

### 文章スタイル
- 電子雑誌のような自然で読みやすい文章
- 新社会人でも理解しやすい平易な表現
- 1行130文字程度で適切に改行
- ですます調で統一(表内はである調も可)
- 短文と長文のバランス
- 接続詞を効果的に使用

### 技術仕様
- セマンティックHTML使用
- 効率的なCSS(Flexbox/Grid活用)
- PC対応のみ。モバイル対応不要。
- WCAG 2.1 AA基準のコントラスト比
- レスポンシブ対応
- 動的なアクションは不要。Share Pointなどの静的なサイトで表示予定
- コードはシンプルにし、手順本体の充実度を優先する。
- 目次エリアと本文エリアが重ならないように本文の左側には余白を入れること

## 禁止事項

### 記述内容
- 中黒(・)を用いた箇条書きは禁止(番号付きリストのみ使用すること)
- 曖昧な表現は禁止(しばらく、適当に、ある程度等のあいまいな表現は禁止)
- 個人名での役割指定は禁止
- 専門用語の説明なし使用は禁止
- プロンプト文の転記は禁止(新社会人でも分かるような記載にしました。などの説明は禁止)

### 技術的制約
- JavaScript使用禁止
- 情報隠蔽UI(タブ等)禁止
- レイアウトの重なり禁止
- cite形式の参照記載禁止
- 入力情報にない数値でのグラフ作成禁止
- mermaidのコード使用禁止

## 出力形式

**完全なHTMLコードで出力してください**
- コードをそのまま別システムで使用するため、説明文は一切不要
- `<!DOCTYPE html>`から`</html>`までコードエリアでの完全なコードのみ出力
- ユーザーから提供されるインプット情報を適切に解釈し、上記フォーマットに従って具体的な手順書を作成してください


インプット:
(次のチャットで指示をします。待機しててください)


0
1
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?