私は、Web サーバーに関するあらゆるドキュメントが詰まったタブ付きの 3 リング バインダーを作成するために、これを MS Word で作成しています。
含めるべき主なカテゴリは何ですか?
当社には 2 台のサーバーがあり、どちらも Windows で、1 台は Web 用、もう 1 台は SQL Server 用です。Web 用のサーバー 1 では、IIS7 と ColdFusion が実行されます。
私はシステム管理者としての訓練を受けていませんが、学んだことだけを知っています。たとえば、サーバーを移行したばかりのとき、ドキュメントがなかったために多くのことを見逃してしまったなど、情報がまったくないよりは、より多くの情報があるほうがいいと思います。
では、徹底した仕事をしたいですか? これを wiki として使っても構いませんが、上司や同僚は wiki とその使い方にあまり詳しくありません。私はグループの中では几帳面なほうで、細部まで気を配り、すべてを文書化したいと考えています。
助言がありますか？
答え1
ある程度、何を含めるかは、誰がドキュメントを作成する対象は管理者ですか? ユーザーですか? プログラマーですか? これらすべてですか? サイトを設計するときと同じように、ユースケースを検討して解決する必要があります。
プログラマーやシステム管理者として私に提供されるドキュメントにとって重要だと考えられるものは次のとおりです。
- バックアップの作成方法
- バックアップを復元する方法
- サイトを最初からセットアップする方法（必要なソフトウェア、インストール プロセス、構成など）
- 依存関係のリスト (CF、SQL Server が必要、x が必要)
- 使用中のAPIのドキュメント
- 元の要件文書、変更文書（存在する場合）
- 管理の作成/使用方法に関する情報
- ユーザーが退職したときにアクセスを変更するプロセス (ユーザー アクセスの取り消し、共有パスワードの変更など)
- ユーザー/クライアント/プロセス固有のカスタマイズ
- 「gotcha」シナリオ
- ユーザー向けの既存のドキュメント
- スケジュールされたタスクとそのスケジュール
- メンテナンスの一環として定期的に実行する必要があるプロセス（インデックスの更新、デフラグなど）
Wiki のような電子ソースを作成する場合は、次のものを用意しておくとよいでしょう。
- オリジナルのコンポジションとモックアップ
- 画像ソース
- フラッシュ .fla ファイル
- 既存のサイトから要件/変更ドキュメントへのリンク
- リリース コードの最新コピー。日付/バージョンなどは、メジャー リリースごとに、または定期的に (毎月など) 更新されます。
答え2
ドキュメント作成には Word ではなく OneNote を使用する
- 複数のユーザーが同時に使用できます
- 必要に応じてPDFにエクスポート
- 右クリックの「OneNote に送信」機能により、ドキュメントの価値が高まりました。
- 編集の追跡
これらは機能のほんの一部です。私たちにとっては、実際には挙げきれないほど多くのメリットがあります。