津村彰氏の「意外と大切なドキュメンテーション！(1/2)ドキュメンテーションってなに？」

###
インフラエンジニアの津村です。
今回は、「ドキュメンテーションとは何か」「ドキュメントの読み方」について、お知らせしたいと思います。

よく、「ドキュメント読んで」といった指示は、現場で見かけますし、ある程度慣れてきたら「ドキュメントを書く」というタスクもよくあります。

しかし、「ドキュメントの書き方」って、意外と誰も教えてくれませんよね。
私も、何回も現場でレビューをされて身につけました。

まず、最初に「ドキュメンテーションって何だろう？」って事を、お伝えしますね。
未来のエンジニアにシステムを託すための「本」

「ドキュメンテーション」と言うと難しく感じますが、要には「取り扱い説明書」「仕様書」です。
これらを纏めて、現場では「ドキュメンテーション」と読んでいます。

例えば、データセンターにインフラを新規設計する場合、だいたい以下のようなドキュメントを用意します。

・仕様書
・設計書
・パラメータシート（各機器の設定を纏めた表）
・構築手順書
・テスト手順書
・テスト結果
・運用手順書

（この続きは以下をご覧ください）
リンク