技術文件寫作是什麼 為什麼配對寫作有助於改善文件

2021-10-08 04:42:15 字數 1376 閱讀 7977

技術文件寫作是什麼

至少在red hat文件團隊中,專業作家幾乎總是單獨處理文件。 但是,您是否嘗試過將寫作作為一對的一部分? 在本文中,我將解釋配對編寫的一些好處。

結對寫作是指兩個作者在同一房間,同一文字上實時工作。 這種方法提高了文件質量,加快了寫作速度,並允許作者相互學習。 結對寫法的概念是從結對程式設計中借用的。

進行配對寫作時,您和您的同事一起處理文字,提出建議並根據需要提出問題。 同時,您正在觀察彼此的工作。 例如,在乙個人寫作的同時,另一位作家觀察了諸如結構或上下文之類的細節。 通常,圍繞文件的討論會變成分享經驗和觀點,以及就一般寫作進行集思廣益。

我和我的同事aneta steflova在red hat enterprise linux系統管理文件和red hat identity management文件上完成了超過50個小時的配對編寫工作。 我發現與單獨寫作相比,成對寫作:

兩位作家寫一篇文字? 聽起來一半生產率,對嗎? 錯誤。 (通常)

結對寫作可以幫助您更快地工作,因為兩個人可以解決更大的問題,這意味著在此過程中被阻止的頻率降低。 例如,有一次我們編寫了用於身份管理的緊急api文件。 我至少知道web api的基礎知識,rest協議等,這些知識幫助我們加快了文件的這些部分。 aneta獨自工作,可能需要經常打斷寫作過程才能研究這些主題。

措辭或句子結構不佳,材料不一致等在四隻眼睛的檢查下很難生存。 例如,我們的一對書面文件由一位極其關鍵的開發人員審閱,該開發人員以發現技術上的不準確性和不良的結構而聞名。 經過特別的審查後,他說:「完美。非常感謝。」

我們每個人都生活在自己的寫作泡沫中,我們通常不知道其他人如何寫作。 配對寫作可以幫助您改善自己的寫作過程。 例如,aneta向我展示了如何更好地處理開發人員提供了起始文字的工作(相對於作家使用他們自己的主題知識從頭開始寫作),我沒有經驗。 此外,她還對文件進行了徹底的構造,我也開始這樣做。

再舉乙個例子,我對vim足夠精通,可以使xml編輯(例如標籤操作)愉快而不是費力。 aneta看到了我如何使用vim,被問到了問題,經歷了學習過程中的痛苦,現在利用了對我有幫助的vim功能。

結對寫作對幫助和指導新作家特別有用,它是結識專業人士(並與他們同樂)的好方法。

除了我已經列出的好處之外,結對寫作還特別適合:

而且,通過成對寫入,反饋是實時的,按需的和雙向的。

不利的一面是,成對寫作的速度可能更快,從而使作家減少思考主題或措辭的時間。 另一方面,成對寫完之後,通常不需要同行評審。

要充分利用成對寫法:

結對寫作是一次會議,但實際上您可以完成工作。 這項活動使作家能夠專注於我們職業中不可或缺的一件事-寫作。

這篇文章是在與aneta steflova結對寫作的幫助下撰寫的。

翻譯自:

技術文件寫作是什麼

為什麼要寫作?

從 2018 年 10 月 21 日開始寫一些東西,至今 216 天,寫一篇關於寫作的體會。對我來說,寫作的一開始是為了打卡完成 arts 極客時間 左耳聽風 專欄作業 每週分享一些技術或是其他方面的思考,這也是我正在做的事。對於現在的我來說,賺錢 並不是我的首要目的,而且現在水平還相差甚遠。總的來...

我為什麼寫技術部落格

補於2016年9月30日 晚 很長一段時間裡除日記之外沒寫過其他東西,前些天吃了點兔子肉,喝了點梅子酒,心煩意亂,趁著酒意寫下上述文字。酒後身體離地半尺,無所顧忌,文字裡態度鮮明,不咬文嚼字,很難文采平平。但也不全是好處,比如思緒滿天飛,邏輯通常不會太好,容易寫到哪算哪。今天依舊心煩意亂,沒有吃酒和...

技術人員為什麼要堅持寫作?

距離上次寫文章好像已經是乙個月前的事情了,這段時間我去幹嘛呢,我開啟了乙個程式設計師的生活,除了公司專案趕進度,平時還要安排看書計畫。看完書之後,筆記整理和行動總是發現不到位。回到家也不想繼續開啟電腦,當然還是很清晰的認識自己的拖延症很嚴重,一直拖到現在,之前誇下的海口一直沒有兌現,在這裡做乙個反思...