文檔作成能力是從事軟件開發人員必備的一項技能,優秀的文檔能使溝通更加順暢。特別是在國際合作或軟件外包行業中,文檔的簡單易懂更加重要。以下是針對在對日外包中文檔作成的10個技法,希望給朋友們一些幫助。
一、用日語作文檔時,避免使用片假名,中文做文檔時,避免使用非專業的直譯名詞。
理由:容易引起歧義和難以理解。
對策:日語的片假名儘量替換成日文漢字,並且能夠註上英文原詞。中文文檔時沒有標準翻譯的專業詞彙儘量採用英文原詞。
二、一篇文章表達一個主題
理由:一篇文章有幾個主題,讓人很難把握重點,難以理解。
對策:採用金字塔式的結構將文章逐條分解。
三、文章的項目編號一定要標出。
理由:如果沒有編號,文章的結構比較模糊
對策:①分項,分段要多用。
②圖和表的編號一定要標註。
③在溝通過程中以及其他文檔引用時使用項目編號進行對話,很容易找到目標文字。
四、採用自動翻譯進行文章的確認。
理由:如果不能自動翻譯或者翻譯很差,說明文章中有語句不夠通順的地方,我們自己也難以理解。
對策:使用翻譯軟件或者翻譯網站等進行翻譯,對翻譯出入較大的地方進行修改。注意句式結構。
五、文章記述粒度(詳細度)要一致。
理由:詳細程度不一,導致文章或者項目組內文檔的意思和理解的容易度混亂不一。
對策:①對於記述粒度要有統一的指導方針.
②分情況書寫時,不要使用“其他”這樣的情況。
③第三方進行記述粒度的檢查。
六、詞語要有嚴密的定義。
理由:模糊的詞語會使讀者難以理解,必須通過上下文的理解才能判斷詞語的意思。
對策:①要寫出文章中各項的說明及讀者閱讀說明。
②整理出文章中的用語集。
七、否定句變爲肯定句。
理由:這個對日文文檔特別注意,因爲日文的否定比較暖昧,難以理解。從心理學角度,肯定句比否定句容易讓人理解和接受。
對策:採用肯定句型。
八、先寫結論,後寫說明。
理由:先寫出結論,讓讀的人很容易把握整體的主旨。
對策:對於短小的文章最好採用先寫出結論後寫說明的習慣。
九、減少文字說明,儘量使用圖和表進行說明。
理由:徒勞,重複,冗長的表達太多。
對策:①少數圖形使用按照MECE原則作成的圖解結構
②採用UML繪製的圖形。
③對於圖形中的文字,只允許使用單句。
④對於連續的流程,處理集羣,因果關係和關聯關係要特別的強調。
注:MECE---是Mutually Exclusive Collectively Exhaustive,中文意思是“相互獨立,完全窮盡”。
也就是對於一個重大的議題,能夠做到不重疊、不遺漏的分類,而且能夠藉此有效把握問題的核心,並解決問題的方法。
十、表格很差,還不如逐條的去寫出來。
理由:不好的表格,對於理論的結構、流程、相互的關係不能很好的表象出來。
對策:①重視對錶達內容的關聯關係時,要捨棄表格的美觀性。
②優先考慮表達內容的充分性,要捨棄表格的美觀性。
③如果使用表格要遵循以下原則:
※ 每個條目簡短表達
※ 每個條目要遵循MECE原則
※ 保證每個條目內容表達充分