我的任務是建立和管理一個全新的實驗室環境，其中包含許多扮演不同角色的機器。有一個 VM 主機、多個 Web 伺服器、多個資料庫伺服器等。
有非常具體的需求和流程需要記錄為該實驗室環境的一部分，例如，我們不希望打開自動 Windows 更新，並且我們想要捕獲許多想法來向多個不同的各方解釋（主管、經理、開發人員、IT 經理、QA 人員）。
因此，當我進行設定時，我真的想將這些對話記錄在某種正式文件中。我打算繼續建立一個 Word .doc，用幾個離散的部分組織每個伺服器角色：
- 執行摘要
- 維護需求
- 已安裝軟體清單
- 可用硬體
- 硬體預設值
我想知道的是，在為這些機器建立文件時是否可以遵循更好的模板。我希望我最終創建的任何東西都足以讓其他人在需要時重建機器。
答案1
一個好的文件系統最重要的是：
- 易於更新（或者人們不會更新它，這比無用更糟糕）
- 易於存取 - 從任何位置、從多個設備。
- 組織良好 - 人們可以輕鬆找到所需的信息，並且相同信息的重複最少。
我嘗試過word文件。他們全3分都失敗了。 Word 文件很難更新，最終會導致人們擁有不同的副本，等等。
我發現最適合我使用的系統是 wiki。 DokuWiki 非常適合我的目的。我可以從任何地方輕鬆訪問和更新它。
我的 wiki 中列出了描述整個網路設定的頁面，這些頁面連結到每個伺服器、叢集和應用程式的頁面。這樣，有關特定項目的所有詳細資訊都保存在單獨的頁面上，並且可以從相關的每個位置連結到- 當某些內容發生變化時，我只需在一頁上進行更改，並且可以輕鬆找到我正在查找的資訊為了。
它還允許您指定名稱空間模板，因此當我創建新的伺服器頁面時，它會預先填充表格以輸入 IP 位址、硬體配置等。文檔中缺少的內容。
如果你真的想變得更奇特，你可以編寫插件來獲取配置文件之類的東西，解析它們，並以易於閱讀的格式顯示它們。例如，我編寫了一個名為 PatchPanel 的插件，它採用網頁配線架的文字描述並繪製其圖片，並帶有每個連接埠所在位置的標籤。
http://blog.emsley.ca/2014/04/documentation.html有一個更完整的關於我如何設置它的文章（免責聲明：鏈接到我的博客，但完全與主題相關）。