文件載入狀態
github最近的一項調查中，超過90％的受訪者表示，開源專案的主要問題之一是文件不完整或令人困惑。
我們該如何解決？
github使用者認為文件質量差是#opensource專案的主要問題之一。 我們該如何解決？答案來自不同程度的干預。-alex sanchez（@_alxsanchez） 2023年6月12日
首先也是最明顯的是聘請專業人員來照顧它。 紅帽是一家擁有穩定作家的開源公司， npmjs正在招聘他們的第一位全職作家。 可以肯定地說，有很多作家在從事受資助的開源專案。 這個解決方案很棒，作為技術作家，我都贊成它，但是它既昂貴又困難。
另一方面，最低程度的干預卻忽略了這個問題。 許多小型開源專案都使用這種方法，因為它們沒有時間，精力，金錢或專業知識來做任何事情。 有些人至少嘗試為文件請求請求提供標籤。
大多數專案屬於中間空間，那裡沒有足夠的錢來聘請技術作家，但他們的動機是幫助使用者使用該產品。 這些專案可以做什麼？
首先，通過降低准入門檻，使貢獻更加容易。 這是您可以花很少錢或沒有錢就可以嘗試的一些方法。
關於誘使編碼人員成為貢獻者的文章和會議討論有數十篇，關於**貢獻者需求的一切正確的觀點也適用於非**貢獻者。 但是，與您可能永遠不會啟用的**相反，在您知道人們會閱讀的文件中存在一種特別的焦慮。 如果您不是核心專案團隊的一員，您是否真的足夠了解文件？
雇用作家或從現有專案中借用樣式指南以建立文件模板。 這是可填寫的表單，供貢獻者用來建立有意義的主題或描述。 例如：
_______命令告訴系統__________。 ______命令進行以下切換：這是乙個簡短的模板，但是使人們可以省去思考應該包括哪些內容的思想負擔，這實際上降低了障礙，並使他們在編寫**時更容易記錄文件，或者事後編寫文件。 通過這種方式標準化命令還可以使您的專案更加實用，因為使用者可以每次掃瞄它們以查詢可**的資訊。相關命令是_____，_______和________。
有很多漂亮，功能強大的技術寫作工具。 您不應該使用其中任何乙個。 您應該使用盡可能小的和簡單的內容來撰寫和索取文件。 理想情況下，應該是人們可以使用文字編輯器新增的內容，並且應該是自編譯的，這樣在投稿之後和發布之前不會出現故障。 不要將您的資訊放入專有的wiki中：將其放入html或markdown或其他熟悉的標準中。 以後將其轉換為更專業的文件將更加容易。
文件請求應與功能請求具有相同的路徑和權重。 您需要有一種方法讓人們告訴您他們失敗的原因並尋求幫助。 如果您配置了乙個聊天機械人，請確保它正在收集文件請求。 如果您配置了分析功能，則可以檢視人們正在搜尋什麼而找不到。 新增您可以想到的盡可能多的請求路徑，然後可以整理它們並進行簡單的頻率分析，以確定您的使用者最受挫的地方並進行修復。
任何具有足夠年齡的專案都具有除專案本身以外的文件。 人們在stack overflow上互相提問，在youtube上搜尋答案，並在特定於行業的郵件列表上互相詢問。 無論您的使用者在**互相幫助，您都應該閱讀該有用的文件，並在獲得許可的情況下將其拉回到專案中。 圖書館郵件列表上的某個人可能永遠不會想到使用您的編目軟體來提供文件，但是他們已經為圖書館員們編寫了它，這是非常有用的資訊。
使文件變得更容易意味著更多的人將為您建立文件。 這是如此明顯，但是很少有專案致力於降低障礙。
人們在避免痛苦或尋求獎勵時會改變自己的行為。 我們不希望專案痛苦，因此我們可以努力使獎勵成為行為改變的更可能原因。 以下是一些方法：
如果您認為文件，使用者體驗和可訪問性不如**重要，那麼它將出現在您的專案中。 確保您沒有將專案分為「有價值的程式設計師」和「其他人，其中一些人編寫文件」。 如果您分發貼紙或t恤或向硬幣挑戰硬幣，則也要為非**貢獻而分發它們。 在一段時間內，這會對您的社群造成極大的打擊，以至於您會看到很多新的，激動人心的貢獻者。
如果您的專案型別具有從使用者到請求者，從貢獻者
到核心的進度，請確保存在用於非**貢獻的等效路徑。 如果您想讓某人自願為您編寫一流的文件，則需要證明您重視他們的時間和專業知識。
編寫**並不比編寫文件難，只是一種不同的技能。 但是，正如github調查顯示的那樣，做得不好的人並不多。 這是因為一般而言，無論是通過文件還是通過介面，開源專案都沒有將可用性作為優先事項。
使用上面概述的步驟來更改文件不良或丟失的問題既容易，又非常困難。 這將是困難的，因為它要求我們作為一種運動來開始關心與我們不同的人的經歷，而這並不是開源傳統上對我們的獎勵。 開玩笑，老習慣和社群困擾的文化使我們許多人都在試圖改變。 但是改變是困難的，並且即使他們確實設法安裝了作業系統，世界各地的新使用者也已經在如何發音他們剛剛讀過的作業系統的名稱方面得到了糾正。
考慮鼓勵非**的貢獻，這是使您不太喜歡舉手投奔商用軟體的使用者的方式，因為開源軟體實在令人沮喪，無法使用。 我知道我會這樣想。
翻譯自:文件載入狀態
技術團隊如何維護文件
今天和大家說乙個技術團隊的老問題 乙個長期持續迭代的專案，已經翻過很多次了，但是技術文件還是最初的樣子，後來的技術人員依靠文件已經無法正確了解專案最初的樣子了。或者是，技術文件寫了很多，但是根本沒人看，不同人寫的文件不夠統一和規範。在討論解決方案之前，我們首先將技術文件做乙個分類 1.對外展示的技術...
我們應該如何書寫README及文件
乙份好的文件可以減少很多溝通上的問題，這在團隊開發中至關重要。能夠寫出好文件的人，我相信在團隊中應該會更加受歡迎。那麼乙份好文件應該有哪些要素呢？要素齊備 總有乙個內容是你想要的。簡明扼要 能夠一句話說出你想表達的，說明你才對你的專案真正了解。當然有些東西沒法精簡。ok 現在我們有了乙個基本概念了，...
如何檢視mysql技術文件 資料庫
你的位置 技術文件 資料庫 1 統計乙個資料庫中每有表的記錄總數 可以通過執行下面的語句得到結果 select o.name,i.rows from sysobjects o,sysindexes i where o.id i.id and o.xtype u and i.indid 2 order...