花時間創建技術文件的人經常聽到這句話。用四個簡單的字來總結你一生的工作總是一件好事。
事實上,沒有一個頭腦正常的人會坐在舒適的椅子上,喝著自己喜歡的飲料,從頭到尾閱讀技術手冊,或者瀏覽公司服務器機架的描述來取樂。沒有人閱讀文件——除非他們需要。
但是,正如您將從本文中了解到的那樣,在許多情況下,網頁文件在您的組織中將變得至關重要。了解您應該開始記錄什麼以及您將從這些資源中獲得什麼價值。
什麼是網頁文檔?
網路文件是硬體、軟體、伺服器、目錄結構、使用 阿曼号码 者設定檔、資料以及它們如何協同工作的技術記錄。
網路文件應包含任何有助於管理員和 IT 專業人員保持網路順利啟動和運作的資訊。這些資訊可以採用您想要的任何格式(儘管您會看到我們建議使用圖表和其他視覺效果來快速參考並改善與非技術員工的溝通)。
最重要的是這些資訊易於獲取並且可以被所有需要參考的人理解。使用網路圖軟體可以幫助視覺化網路目前和未來的狀態,並允許您根據行業標準建立網路圖。
為什麼需要網頁文檔?
考慮以下場景:
在前 IT 負責人離開公司去追求其他興趣之後,您在一家偉大的公司找到了一份好工作,擔任 IT 負責人。當您開始工作時,您會與您的經理會面,他會告訴您對該職位的期望。您的前任已經完成了訂購新伺服器和軟體來運行網路的大部分基礎工作。您需要迅速採取行動來完成訂單並實施網路變更。
回到辦公室後,您尋找可以幫助您了解網路目前設定的文件。然而,您很快就會發現除了隨處可見的一些註釋之外,沒有太多文件。沒有 IT 計劃,也沒有任何描述目前資源和架構的內容。您找不到任何可以證明對新硬體和軟體的請求是合理的。
你需要三個多月的時間來製定計劃並弄清楚一切應該去哪裡。如果您的前任花時間製作網路基礎設施文檔,您的工作會容易多少?
網路文件很重要,原因如下:
正確的文件可以幫助您避免耗時的研究來解決重複出現的問題。
當一切就位並且每個人都遵循相同的流程和程序時,整個網路的一致性有助於減少問題和錯誤。
當知識淵博的員工離開公司時,您不會丟失重要資訊。
此文件可協助您更快入職新員工。
當出現問題時,您可以更快地排除網路故障。
除了提供詳細的文件之外,您還應該嘗試使其成為一種實踐,以確保不只一位員工掌握所有知識。這樣,當您知識淵博的員工離開時,您就會得到雙重保護,因為您有一組可靠的文件作為備份。
需要更有說服力嗎?了解視覺化文件如何幫助您更好地理解和傳達您的雲端架構。
了解更多
你該記錄什麼?
應在工作時建立適當的文件。不要等到一切就緒才開始記錄您所做的事情。記錄當下比試圖記住你後來做了什麼要容易得多。讓記錄成為一種習慣,並使其成為您流程的一部分。不要因為缺乏網頁文件而冒可能出現尷尬局面的風險。
但是,您應該記錄什麼?
網路文件的目標應該是確保您的公司保留創建網路以及如何維護和升級網路的所有知識。
您應該尋求 IT 團隊、整個組織各部門的其他網路管理員以及經理的意見,以確定您應該記錄哪些內容。以下只是您應該記錄的資訊類型的幾個範例,以幫助您的網路保持良好的工作狀態(此外,您還可以找到幫助您開始編寫自己的文件的範本)。