TL：博士？好吧...這裡：
除了僱用或外包給技術作家之外，技術作家在其行業中是否有可以藉鑑的基本標準/慣例/實踐，以便創建適當的 IT 文件並隨著時間的推移維護該文件？
在為內部 IT 使用和員工外部使用編寫各種文件時，很明顯，我們的員工在文件方面都有自己的風格。
根據我們的品質文件和受控文檔，IT 使用了各種 SOP、WI 範本以及用於 IT 品質文件的各種表格。這些文件雖然不一定對 IT 內部的日常營運有用，但確實可以幫助員工和公司解決 IT 人力資源問題、合規性等問題，並且通常寫得很好、定義良好，並且至少遵循品質部門的模板和文件標準（如版本控制、ECN 等）
但我們實際的IT文檔編寫仍然缺乏真正的約定/標準。 有些人會使用 ScreenSteps 等第 3 方工具，有些人則簡單地使用 Word 並建立一個簡單的大綱，例如：
- 打開
app- 點擊“開始全球熱核戰爭”
- …
- 利潤
內部 IT 文件實際上更糟，基於員工或顧問當時認為足以喚起他們自己的記憶的任何內容，或基於他們選擇的編輯器（vi、word、excel、powerpoint、napkin、內部wiki）。當員工離職或休假時，甚至需要爭先恐後地找出基本資訊時，問題就會出現。 有時，只有文件日期才能指示資料是否仍然相關。
雖然簡單的大綱、實際的螢幕截圖，甚至完整的高清影片都很好，但我們的員工中沒有真正的 IT 技術作家，我們不禁認為我們在這方面有所欠缺。
我們可以為我們的文件製定自己的標準以及批准的範本嗎？是的，但是為什麼要重新發明輪子呢？如果技術作家的「行會」中已經存在這樣的標準和慣例，我們最好遵循這些慣例，以便我們的文件清晰、簡潔和專業。
為了避免被告知」到谷歌上查詢」，我確實查看了顯示一些格式實踐的網站，而這個 SF Q：IT 文件平台幫助尋找平台和軟體來處理寫作，它沒有討論行業內是否真正存在標準。
那麼，除了僱用或外包給技術作家之外，技術作家在其行業中是否有可以藉鑑的基本標準/慣例/實踐，以便創建適當的 IT 文件並隨著時間的推移維護該文件？
答案1
寫作是一門學科。
我已經做了很多，我掌握了未經訓練的人所能掌握的盡可能多的基礎知識，而文件並不是我工作的首要部分。時間已經向我展示了我寫的哪些文件會真正被閱讀，以及哪些內容會出現在永恆的書架上 TL;DR。事實上，這是編寫任何內容的首要規則：
了解你的聽眾。
內部 IT 文件的受眾是我們自己。系統管理員呢？當我們獲取文檔，尤其是內部文檔時，我們正在尋找：
- 可定位
- 簡短的
- 說到重點
- 帶我到我要去的地方
關於系統背景的五段解釋將被忽略，而有利於它下面的清單，因為我們很匆忙，我們只需要完成它。如果那裡有警告如果您不按順序執行某些步驟，它將刪除您的所有備份位於跳過的文字區塊中，也許它應該有一些引人注目的格式，或者也可以在清單中包含該位元。
流程文件
此類文件都是關於描述做某事的方法。對於未經訓練的人來說，這是最容易製作的，因為大多數情況下它只是寫下一系列要遵循的步驟。根據我的經驗，好的流程文件具有以下特徵：
- 包含一個清單。
- 此清單與運行該清單的時間和原因的簡短摘要位於同一頁面上。
- 檢查表下方或連結頁面上有一份較長的文檔，描述了檢查表背後的理論以及可能遇到的變化。
您希望有一個可遵循的清單，並且至少有第一級故障排除步驟已經在頁面上（或單擊即可）（如果需要的話）。
如果您曾經查看過 Microsoft 知識庫文章，那麼這是一種熟悉的格式：摘要、修復、詳細資訊、受影響的系統。這是有原因的。
故障排除指南
這比流程文件更棘手，因為您必須將決策樹編碼到文件中。一個簡單的清單可能還不夠，但是一個分支清單（使用到其他清單的連結）是相當可行的。與流程文件相同的規則適用於此類文件：
- 保持簡短，不要讓讀者被細節淹沒。
- 明確決策點是什麼以及後續行動的方向。
- 將深入的技術背景知識儲存到架構文件中。
故障排除指南可以是一個大型的「選擇你自己的冒險」故事，也可以是一個包含系統所有問題以及修復方法的大型專案清單。
架構文檔
這是最難製作的類型，因為它被設計為參考材料，只有那些想要了解他們剛剛走進的這個複雜事物的新人才會參考。
架構文檔是原因文檔。這就是為什麼使用這個系統而不是那個系統，它們如何與另一個系統連接以及是什麼使該連接以它的方式運作。這是您在了解生產配置後應立即編寫的文檔，並在發生變更時進行更新。
格式方面，我必須聽從專家的意見。
好的文件不僅僅是模板和格式，統一的外觀很好並且確實提高了可讀性，它還需要一些其他的東西。
定期更新
養成檢查已有文件的習慣，以確保它仍然有效。 1.17 版本的清單可能不適用於 1.26 版本，是時候更新了。死記硬背的清單需要不斷更新，因為即使是最小的 UI 變更也會使整個事情變得糟糕。
投入10分鐘一週檢查文件並確定需要清理的內容可以帶來驚人的效果。
架構文件需要由了解系統的人定期審查。正如我所提到的，這些是很少使用的文檔，但當您確實需要它們時非常有用。您不需要描述 3 年前遷移到 Windows 時校園列印服務叢集如何與 NetWare 連接在一起的文件。
可發現的
這是最難做到的，因為它在很大程度上取決於在哪裡您正在儲存您的文件。
對於任何透過 ServerFault 提出問題的人，我們會告訴他們什麼？
你已經嘗試過什麼？
緊隨其後的是
Google 上的熱門搜尋可以解決您的問題。也許你應該嘗試一下。
我們搜尋文檔，而不是去書架。文件儲存庫需要像 Google 一樣可搜尋，否則我們就直接使用 Google。
中央餐巾儲存庫對於文件來說是一個糟糕的地方，至少如果它沒有線上索引（而且也不會）。一個簡單的 wiki 更好，因為其中大多數至少包括基本的文字搜尋。更好的系統是除了全文之外還允許搜尋標籤的系統，以便更好地將搜尋集中到目標區域。
如果您正在使用支援標籤的文檔儲存庫，標準化您的標籤。有時只需查看 ServerFault 標記清單即可了解原因。使用者不必記住這八種排列虛擬機只是為了找到他們正在尋找的東西。這將需要偶爾進行重新標記工作。