読者です 読者をやめる 読者になる 読者になる

インフラ系手順書(構築・設定変更)作成時の心得。

  1. 誰にでも作業できるように書く。

  2. 前提条件などがあれば記載しておく。
    前提ソフトウェアや起動しておく必要があるサービスなど。

  3. ミスの起こりにくいような書き方を心掛ける。

  4. 一文を簡潔にする。
    基本、一つの手順で一行。(Linuxの場合)

    例:
    ①以下のコマンドを実行する。
     # df

    Windowsの場合は、スクリーンショットがあるとわかりやすい。

  5. 左側に手順、右側にチェックリストを設ける。(同じ行中)
    作業者の名前を書く欄でもよい。

  6. コメントなどで設計書とリンクできるようにする。