
我正在 MS Word 中創建這個,創建一個帶有選項卡的 3 環活頁夾,其中包含有關我們的 Web 伺服器的所有內容的文檔。
我應該包括哪些主要類別?
我們有2台伺服器,都是Windows,1台用於Web,1台用於SQL Server,Web 1運行iis7和coldfusion。
我沒有接受過系統管理員培訓,只是我學到的東西。例如,我寧願有更多信息,也不願沒有信息,例如當我們剛剛遷移伺服器時,我們錯過了很多東西,因為沒有文件。
所以我想把工作做得徹底嗎?我不介意將其作為 wiki,但我的老闆和同事不太熟悉 wiki 以及如何使用它們。我傾向於成為我們團隊中的肛門者,想要點出所有的“i”並將所有內容記錄下來。
有什麼建議麼?
答案1
在某種程度上,您包含的內容在很大程度上取決於世界衛生組織你正在記錄。您正在為管理員提供文件嗎?對於用戶?對於程式設計師來說?上述所有的?就像設計網站時一樣,您需要查看用例並解決它們。
我認為對於作為程式設計師和/或系統管理員提供給我的文件至關重要的事情:
- 如何建立備份
- 如何恢復備份
- 如何從頭開始設定網站(所需軟體、安裝流程、設定等)
- 依賴項清單(需要 CF、SQL Server、x 需要)
- 正在使用的任何 API 的文檔
- 原始需求文件、變更文件(如果存在)
- 有關如何建立/使用管理的信息
- 使用者離開時更改存取權限的過程(撤銷使用者存取權限、變更共用密碼等)
- 任何用戶/客戶端/流程特定的定制
- 任何“陷阱”場景
- 使用者的任何現有文檔
- 計劃任務及其時間表
- 作為維護的一部分需要定期運行的進程(索引更新、碎片整理等)
如果您正在建立電子資源,例如維基百科,那麼最好擁有以下內容:
- 原始組合和模型
- 圖片來源
- 閃存 .fla 文件
- 從現有網站到需求/變更文件的鏈接
- 發布程式碼的目前副本,包含日期/版本/等。隨著每個主要版本的發布或定期更新(例如每月)。
答案2
使用 OneNote 取代 Word 來儲存文檔
- 多個用戶可以同時使用
- 如果需要,可匯出為 pdf
- 右鍵「傳送到onenote」功能增加了我們文件的價值。
- 追蹤編輯
這些只是其中一些功能。對我們來說,其實有太多的好處無法一一列舉。