技術文檔工程師和程序員的關系,有點像記者和消息源——你得不斷去打擾對方,問一些可能讓人不舒服的問題。只是我們的目的不是寫新聞,而是把產品講清楚。
這些年我合作過的程序員不少,他們對文檔的態度千差萬別。有人讓你如沐春風,有人讓你懷疑人生。我大概歸納了5種典型類型,以下描述基于真實經歷,性別用"他"只是方便敘述,實際上每種類型男女都有。
![]()
類型一:金毛尋回犬型
這是技術文檔工程師的最愛。如果他是條狗,絕對是金毛——溫順、配合、真心投入項目。你問他問題不用擔心被翻白眼,他會認真看你的修改建議,積極參與討論,下次交稿明顯比上次好。我曾經和同事搶過誰負責對接這位"金毛男孩"的文檔,最后差點打起來。
最佳合作對象,沒有之一。
類型二:"人人都會寫"型
他覺得寫文檔沒什么技術含量。"前置條件放文檔末尾?這是設計如此。""概念不清楚?我覺得夠清楚了。""再加細節?太長了,現在就已經夠長了。"他總說"我知道怎么寫,我自己來",卻不明白技術文檔不只是把字碼上去,還要考慮信息結構、簡潔度和讀者需求。結果通常是:滿篇術語、解釋模糊、信息缺失、結構混亂——用戶看得比報錯還難受。
最打擊工作積極性的類型。
類型三:"我什么都不知道"型
每家公司都有。你去找他詢問他負責維護的項目,他一臉茫然:"我不知道。"換種問法,還是:"我不知道。"你分不清他是真不懂,還是裝不懂好逃避寫文檔。還有個變種:其實不懂,但假裝懂,給出一個聽起來對、細想全錯的答案。
(原文此處截斷,未提供后續兩種類型的完整描述)
特別聲明:以上內容(如有圖片或視頻亦包括在內)為自媒體平臺“網易號”用戶上傳并發布,本平臺僅提供信息存儲服務。
Notice: The content above (including the pictures and videos if any) is uploaded and posted by a user of NetEase Hao, which is a social media platform and only provides information storage services.