在工程領域做技術文件撰寫員可不容易。我們與工程師密切合作,但我們本身並非工程師。我們的工作不是編寫程式碼,而是交付一份描述清晰、目標受眾易於理解的產品文件。這就要求我們四處奔走,用各種問題打擾工程師,這些問題往往令人尷尬,讓他們無法專注於自己最想做的事情——編寫程式碼。

在我的職業生涯中,我遇到過很多對待文件態度迥異的工程師。你有沒有想過,從技術文件撰寫者的角度來看,工程師是什麼樣的?劇透一下:形形色色。我把他們分成五大類,下面每類都用一張圖來說明。

註:為了簡潔起見,我在本文中通篇使用“他”,但這些類型是性別中立的——我遇到過各種性別的人都具備這些特質。

  1. 好孩子

一張金毛幼犬微笑的表情包,配文是“當你的技術文件撰寫員問‘誰是乖狗狗?’而你知道答案是你自己”

那是我們最愛的傢伙!如果他是隻狗,那他一定是隻金毛尋回犬。他是個完美的合作夥伴——總是體貼周到、樂於助人,並且全心投入專案。你不用擔心問他問題,因為他不會評斷你,反而會把你的回饋當作寶貴的資源,幫忙改善文件。他會認真閱讀你的評論,積極參與頭腦風暴,並將你的回饋銘記於心,這樣下次他發布的文件就會更加完善。我甚至還記得,為了和我們這位「金毛」一起修改文件,我和我的技術文件同事還爭論過。

絕對是最棒的工程師!

  1. 比佛先生

一張名為「改變我的想法」的表情包,圖中一名男子坐在戶外桌旁,桌上舉著一塊牌子,上面寫著「我的版本更好」。

「人人都會寫文件,這沒什麼大不了的,」這位「完美先生」心想。他要不是無視或拒絕任何審閱意見,並且總是堅信自己的文件完美無缺,無需任何改進。文件末尾的前提條件? 「這就是預期的設計。」有人建議把概念解釋得更清楚? 「我看不出有什麼問題,已經夠清楚了。」有人建議增加更多細節? 「我不想讓它太長,已經夠長了。」他總是說:「我知道怎麼寫文件,我自己來寫。」他根本不明白,編寫技術文件不僅僅是把文字堆砌在紙上,更重要的是組織訊息,使其清晰簡潔,並考慮受眾的需求。結果呢?一份充斥著術語、解釋含糊不清、資訊缺失、結構混亂的文件,對使用者來說,與其說是幫助,不如說是令人沮喪。

可能是最打擊工作積極性的同事。

  1. 瓊恩‧雪諾

一張《權力的遊戲》中瓊恩·雪諾一臉困惑的表情包,配文是“當他們問你問題,而你卻一無所知時”

每家公司都認識這種人。你去找他問一個關於他負責維護的專案的問題,他一開口就茫然地看著你,說:「我不知道。」你又問了一遍,或許換了個問法,但他的回答永遠都是:「我不知道。」你開始懷疑他是不是真的什麼都不知道,還是只是裝作什麼都不知道,免得你讓他寫文件。

還有另一種瓊恩雪諾,他其實什麼都不懂,卻裝作什麼都懂。他自信滿滿地給出一個聽起來似乎正確的答案,但仔細想想卻漏洞百出。你讓他進一步解釋,他卻開始胡言亂語,說些跟最初的問題毫不相干的事情。這種瓊恩·雪諾更加危險,因為他會誤導你,讓你白白浪費時間去追尋一些根本不存在的東西。

  1. 極簡主義

一張嘲諷海綿寶寶的表情包,上面寫著“我們不需要文件”,大小寫交替出現。

極簡主義者認為文件是多餘的,程式碼本身就足夠了。你帶著一些關於他剛發布的新功能的問題去找他,希望能更新文件。他看著你,就像看著外星人一樣。 「我們不需要文件,程式碼本身就夠清楚了。」他說。如果你反駁呢? “如果有人看不懂程式碼,他們就不應該使用這個功能。”

有趣的是,六個月後你讓他解釋自己的程式碼,他會像瓊恩·雪諾一樣,一臉茫然地盯著螢幕。但那是以後的問題——現在,程式碼顯然很清晰,寫下來純粹是浪費時間。

這種人還有一種比較委婉的:他們會承認自己不會寫文件,或是自己沒時間。這倒也說得通——技術文件撰寫人員的存在正是為了這個!但更多時候,這只是個藉口。他們認為文件不重要,反正也沒人看,所以何必費勁呢?

  1. 機器人

一張表情包,內容是人形機器人眼神空洞,配文是“你真的想讓我生成所有文件嗎?”

你打開差異文件,看到一大堆無窮無盡的文件。你滾動瀏覽,花了很長時間才看到最後。你決定試一試,開始閱讀內容,但很快意識到,即使它是用英文寫的,也完全不符合人類的閱讀習慣。所有內容都是自動生成的,讀起來就像Lorem ipsum 文字——這就是你從中得到的全部資訊。你決定聯繫作者並提出一些問題。作為回复,你收到的是一個直接從 ChatGPT 複製貼上的自動回复:

當然可以-我可以更新這部分內容,讓文件完整全面且自成系統。接下來需要我處理這部分嗎?

你會問自己:“這個世界上還有其他人嗎?還是只有我和這個機器人?”

結論

是時候認真反思自己了。你是哪種類型的工程師?希望是乖乖仔?還是你覺得自己有點像完美先生或極簡主義者?又或者你是這裡沒提到的其他類型?請在留言區告訴我,也歡迎分享你自己的表情包! 😁


原文出處:https://dev.to/klaudiagrz/5-types-of-engineers-i-met-as-a-technical-writer-1gak


精選技術文章翻譯,幫助開發者持續吸收新知。

共有 0 則留言


精選技術文章翻譯,幫助開發者持續吸收新知。
🏆 本月排行榜
🥇
站長阿川
📝16   💬9   ❤️1
481
🥈
alicec
📝1   ❤️2
62
🥉
我愛JS
💬1  
4
#5
Gigi
2
評分標準:發文×10 + 留言×3 + 獲讚×5 + 點讚×1 + 瀏覽數÷10
本數據每小時更新一次
📢 贊助商廣告 · 我要刊登