コンピュータの設定メモをつくるときに記載すべきこと

メモ

設定メモを用意する目的

コンピューターやソフトウェアのインストールメモや設定メモを何のために用意するかといえば「何かトラブルが発生し、頭がうまく働かないのだけど、環境を復旧しなければならない」というときに、用意されたインストールメモや設定メモを使って、環境を復旧できるようにするため。なので、やり方を調べたりする必要があるインストールメモ、設定メモは自分にとって使い勝手が悪い。

インストールメモや設定メモをWebページで公開する理由は、

  1. どこからでも閲覧できた方が便利であるため。
    • ローカルマシンにおいておくと、そのマシンが壊れたときに使えない
    • 物理的なノートだと、そのノートを持っていないときに使えない
  2. 同じことで悩んでいる人にもしかしたら役に立つかもしれないため。
    • 同じことが書いてあるページが既にあったとしても、冗長化の観点から複数あっても別に害はない
    • 自分が誰かの書いたインストールメモや設定メモで救われているのだから、多少なりとも恩返しした方がコミュニティー全体にとって有益

記載すべきこと

  • 計算機・ソフトウェア環境（バージョン情報など）
  • 復帰方法（ちゃんと動く状態に戻す方法）
  • 参考にしたWebページのURLや本のISBN番号
    • そのWebページや本が見られなくなったときように必要なところは引用しておく
  • 設定内容
    • 設定内容の変更前と変更後を併記しておくと良い
    • コピペで設定内容を変更できるようにしておくと良い（文字コードに注意）
  • 設定の反映方法
    • 反映させる手順をちゃんと記載しておくこと

重要なのは「何かトラブルが発生し、頭がうまく働かないのだけど、環境を復旧しなければならない」ときに使えるものであること。意味は理解できなくても、そこに書いてあるとおりにやればうまくいくのが理想。

関連