如果你被公共汽車撞了，你的公司會遇到麻煩嗎？
在工作中，我是過去 10 年中唯一的 IT 人（做所有事情，現在就做類型人）。如果我被公共汽車撞到，他們會完蛋的。我曾多次向管理/總裁類型的人提到它，但他們無視我。對他們來說太糟糕了。
我能做些什麼來減輕他們的痛苦？（或者我什至應該關心？）
（是的，這應該是一個社區 wiki，但是，我沒有看到復選框……也許我沒有足夠的代表。）
記錄一切。
最近 Slashdot 上有一個關於開始文件的文章，這啟發了我寫下我對文件的想法。
我的要點是：
原則#1：它永遠不會完成
文件是一項持續的工作，總是落後於生產中的內容。更改是臨時進行的，事情會隨機移動或中斷或投入使用。文件永遠趕不上。
您必須向支付賬單的人推銷花費時間（因此，金錢）來保持執行文件最新的價值。這些對話經常是這樣的：“記住我不得不花費 $ TIME figuring out how $ 東西壞了？好吧，當我完成時，有一個技術說明詳細說明了 $THING，這樣下一個出現的人就不必把這一切都弄清楚了。”
你必須這樣做，即使你永遠不會完成。
原則 #2：唯一比沒有文件更糟糕的是錯誤的文件
這與其說是原則，不如說是老生常談。文件可以使您誤以為某事處於已知狀態，並且如果出現問題，您可以因此開始修復它。
承認這個問題很重要。
原則#3：你正在為你的繼任者編寫文件
95% 的可能性是您所做的任何事情都將永遠不必再次參考。文件是未來智慧的集合，而不是你的。因此，您必須假設您的聽眾對事物的具體情況知之甚少或一無所知。
並且會有繼任者。我不了解你，但我不打算在這些特定的環境中度過餘生。機會來來去去，當機會來臨時，有時你會離開。但生活在你身後繼續，你越能讓你的繼任者生活得更好。否則，您可能會有一群前客戶，他們悄悄地對您說不恭維的話。我想說的是，在渥太華的 IT 部門到處工作的都是同樣的 50 人，因為你到處都會遇到他們。幫助你的繼任者可能會在未來為你打開大門。
現在在一定程度上，遇到麻煩總是有一定程度的“怪前輩”。那是業務的一部分。我自己做過。但有幾次當我抨擊前一個傢伙是某種白痴時，我才知道他確實有他的行為，並且比我當時更了解正在發生的事情。
原則#4：“為什麼”通常比“如何”更重要
當我們看到一個系統時，我們大多數人開始思考為什麼會這樣？所做的配置選擇幾乎總是有非常具體的原因。在這些情況下，“為什麼”決定了“如何”，您必須確保讀者在檢查您的解決方案的吸煙殘留物時了解正在解決的具體問題。
原則#5：它必須簡單，否則你不會做
這意味著您必須非常了解您的工具以及那些將使用您的工具的人。
保持最新狀態必須很容易。如果你必須做出任何努力，那麼你會找藉口避免在最好的時候去做，也就是在改變之後。
如果你的工具不容易被別人使用，那麼他們就不會使用它。這在團隊環境中尤其嚴重，因為團隊越大，您就越有可能遇到不喜歡您選擇的工具的團隊成員。
就個人而言，我喜歡用於文件的 wiki。然而問題是wiki不會強加你的結構，所以結構必須從外部強加。這總是會在某處導致衝突，因為其他人有更好/不同的想法。
在某些地方，我使用“發布”到 PDF 的 Word 和 Visio 文件，“最新”的 PDF 被認為是權威的。這很好，因為您可以將收藏品交給您的雇主/繼任者。如果日期正確，PDF 可以提供所發生事件的歷史記錄，儘管不容易瀏覽。糟糕的是，我不喜歡 Word 或 Visio，並且被迫對這些工具有一個基本的了解，以便有效地傳達這些想法。
我現在的雇主正在考慮在 Sharepoint 門戶中使用 Word 文件的想法。我們只需要看看我們能走多遠