專業和技術寫作/修辭/假設
在你開始學習一個主題之前,自然會對它做出一些假設。重要的是,除非你能證明這些假設是正確的,否則不要根據它們採取行動。
大多數人對技術寫作的主要假設是,它就像為課堂寫作一樣:你從一個論點開始,完善它,構建結構化的句子,消除第一人稱觀點,新增引言、主體和結論等等。學校沒有教的是,編寫備忘錄、提案、商務信函和說明與編寫學術論文不同。在工作中寫作時,你不會逐步闡述你的主要觀點——你會立即切入主題。你的老闆不會根據你寫商務備忘錄的水平來給你打分,他們想要的是沒有填充物和“廢話”的相關資訊。
請記住,當你寫備忘錄時,可以傳送後修改。如果你認為第一次提交沒有做好,這給你提供了幾乎可以重新提交任何東西的機會。在學校裡,這個選項很少提供——一旦你提交了一篇論文,就再也沒有“重做”的機會了。你的教授很可能會忽略你的努力。另一方面,你的老闆則希望你進行修改。如果你傳送了一份關於星期二會議的備忘錄,而會議被取消了,如果人們星期二出現在會議上,他們會很生氣。在商業中,重新提交很重要,因為商業一直在變化。但是,當你傳送你的備忘錄初稿時,確保它儘可能接近完美。即使你重做了這份備忘錄,人們可能已經打開了它,或者可能還會開啟它來檢視更改的差異。因此,如果你寫了一份新的備忘錄說會議不再在星期二舉行,這並不一定是一次重做,而是一個全新的備忘錄本身。新的主題將是會議取消而不是星期二的會議。但是,如果你重做一份關於進度報告的備忘錄,你的老闆仍然可能選擇閱讀你的初稿以及你的第二稿。此外,確保你的第二稿比你的第一稿好。很多人認為,如果這是一份第二稿,它顯然會比第一稿好,但這並不總是如此。一定要閱讀並重新閱讀你的備忘錄。
在學校的時候,你的老師希望你證明你在學習。為了最好地展示這一點,你會準備報告、論文、專案並參加考試。很少有老師會無條件地相信你知道某些東西,而不會要求你證明這一點。這就是為什麼在學校寫作具有教育目的。你應該把你所知道的寫出來,如果你遺漏了什麼,你的老師會認為你不知道。
但是,在工作中寫東西則完全不同。你的讀者是同事和客戶,他們對你所寫的東西瞭解得不如你多,他們將你的寫作視為指導。這叫做實用寫作。因為你的讀者試圖實現他們自己的實用目標,所以他們希望你的寫作清晰、簡潔、切中要害。透過只包含必要資訊,你幫助你的讀者找到他們需要的資訊,而不會感到沮喪、無聊或不知所措。
在學校寫作通常比在公司寫作直接得多。當你寫論文時,你只有一段溝通關係:你與你的教授之間的關係。由於這是你與作業相關的唯一社交情況,你不會體驗到像技術寫作那樣多種多樣的關係。當你檢視工作中的寫作時,你會意識到你正在與許多不同的人聯絡。有僱員與僱主之間的關係、供應商與客戶之間的關係以及同事之間的關係。你可能經常與其他人競爭,或者你可能在一個專案中與他們一起工作。
技術寫作中的圖形不僅受到鼓勵,而且是強制性的。當你展示某些東西時,一個彩色的圖形可能非常具有說服力,特別是如果它能直觀地表達你的觀點。圖形的一些示例是
- 表格
- 圖表
- 照片
- 圖形
- 圖紙
- 符號
圖形不僅視覺上具有吸引力,而且使簡報易於瀏覽。通常,它們在學校論文中是不鼓勵的。在商業領域,視覺效果可能是獲得工作、達成交易或給老闆留下深刻印象的決定性因素。但是,在使用圖形時,請確保它們是合適的並且與主題相關。向你的員工傳送不合適的圖形是非常不專業的,如果圖形與你的主題無關,可能會造成混淆。圖形用於增強文件,而不是減損文件。
許多學校開始鼓勵小組寫作,以瞭解你將在工作場所體驗到的團隊合作。辦公室裡的協作很常見;即使你不是團隊成員,你可能仍然會諮詢同事和讀者。你也可以提交不斷修改的草稿。
你對技術寫作的另一個假設可能是它幾乎從不改變。但是,如果你將“技術”這個詞與“技術”聯絡起來,你會發現技術總是在不斷變化。這就是為什麼在你成為一名成功的技術作家之前,你必須瞭解你的組織的風格以及你的寫作的社會和政治因素。
技術寫作不是一個常數。每家公司都有自己的宣傳方式,從自由奔放的休閒風格到保守正式的風格。你需要根據公司希望你如何代表它來調整你的寫作。
許多剛開始從事技術寫作的人都會有一個主要的假設,那就是他們所在城市的公司的標準就是應該在全世界範圍內使用的標準。事實上,這是一個巨大的錯誤。即使這些假設是無意識的,它們仍然是冒犯性的。Geoff Hart 在他的文章“跨文化交流需要我們檢驗我們的假設”中談到了這一點。[1]。他提到,美國人在旅行時會遇到很多明顯的陷阱,尤其是當他們身處之前有過類似經歷的環境中,但對方是其他美國商人時。動詞也會帶來問題,還有比喻和短語。複雜句是最麻煩的問題之一 - 當我們使用大詞和長句時,最容易被誤解。簡短明瞭的寫作方式可能看起來不夠專業,但請記住,你是在為一個特定受眾寫作,他們尋找的是熟悉的詞語,沒有耐心欣賞你對英語的掌握程度。
在為與你習慣的不同的受眾寫作時,最重要的是要永遠不要假設任何事。如果你從另一個角度重新閱讀某段文字,並且想,“也許我的受眾不會理解這一點”,那麼這很可能是真的。技術撰稿人永遠不要認為他們的寫作不需要編輯。學會編輯自己的寫作,就意味著你承認它並不完美。透過這樣做,你證明了你正在努力讓受眾理解你的資訊。
如果你選擇成為一名技術撰稿人,你將面臨許多(潛在的)複雜性。在大多數情況下,這些複雜性與不斷變化的世界、不斷變化的信仰以及不斷變化的文化有關。
技術在技術寫作中至關重要,因為許多撰稿人負責建立指南、說明、政策和程式、培訓材料等等。隨著我們進入數字時代,我們越來越依賴機器來幫助我們,而這些機器的種類每個月都在發生變化。由於技術寫作的主要目標之一是預測任何可能出現的疑問或問題,因此對於撰稿人來說,適應不斷變化的口味可能非常困難。
道德在技術寫作中至關重要。通常情況下,工作場所都會存在道德規範(即使它們並不總是被執行,但確實存在)。道德並非非黑即白,許多人可能會對道德規範產生分歧,這可能會使隨後的寫作變得複雜。
技術編輯的巢穴是一個部落格,其中有一個專門針對道德的版塊,包括如何避免偽造資料、如何選擇詞語、如何保持客觀等等。它非常有用,因為我們所做的大量寫作都可能是主觀的,而我們自己卻沒有意識到,因此技術編輯的巢穴有助於尋找紅旗。
道德問題是另一個關於道德的很有幫助的連結。它特別棒,因為它提供了關於優秀和糟糕的技術寫作的例子,解釋了委婉語以及不清晰寫作和不帶偏見寫作的危險。
不用做任何其他事情,你可以查閱本華夏公益教科書其他部分的專業與技術寫作/道德部分。它是一個關於如何使用道德實踐以及解決不道德實踐的好資源。
我添加了這一部分,因為許多技術撰稿人在他們的職業生涯中可能會發現自己加入了許多團隊,提前瞭解你將要面對的情況是一個好主意。
你和你的隊友可能並不總是同意解決問題的最佳方法。你可能認為自己有最好的想法,但當你發現自己做了所有工作時會感到生氣。然而,團隊合作共同編輯寫作是完成工作最好的方法,因為你不僅在聽自己的聲音 - 你還在聽團隊成員的聲音,這有助於消除主觀性。雖然你可能覺得獨自工作效率更高,但這並不總是真的。無論你是否喜歡,你通常會在職業生涯的大部分時間裡都在團隊中工作,所以儘快適應它。
正如你從這篇複雜的華夏公益教科書中可以看出來,你需要記住很多東西才能成為一名成功技術撰稿人。請記住,在技術寫作中,你的文字越簡潔易懂,效果越好。如果你在一個專案上工作了很長時間,你可能會傾向於偏離主題,但這會嚴重損害你的最終結果。保持專注,並記住從你的作品中剔除任何一絲觀點。一次只關注一個詞。
- ↑ Hart, Geoff. “跨文化交流需要我們檢驗我們的假設。STC-蒙特利爾,2008 年 9 月 30 日