技術(shù)文檔規(guī)范 文本

2020-10-22 13:46 更新

字間距

(1)全角中文字符與半角英文字符之間,應(yīng)有一個半角空格。

錯誤:本文介紹如何快速啟動Windows系統(tǒng)。


正確:本文介紹如何快速啟動 Windows 系統(tǒng)。

(2)全角中文字符與半角阿拉伯?dāng)?shù)字之間,有沒有半角空格都可,但必須保證風(fēng)格統(tǒng)一,不能兩種風(fēng)格混雜。

正確:2011年5月15日,我訂購了5臺筆記本電腦與10臺平板電腦。


正確:2011 年 5 月 15 日,我訂購了 5 臺筆記本電腦與 10 臺平板電腦。

半角的百分號,視同阿拉伯?dāng)?shù)字。

正確:今年我國經(jīng)濟增長率是6.5%。


正確:今年我國經(jīng)濟增長率是 6.5%。

(3)英文單位若不翻譯,單位前的阿拉伯?dāng)?shù)字與單位符號之間,應(yīng)留出適當(dāng)?shù)目障丁?/p>

例1:一部容量為 16 GB 的智能手機


例2:1 h = 60 min = 3,600 s

(4)半角英文字符和半角阿拉伯?dāng)?shù)字,與全角標點符號之間不留空格。

錯誤:他的電腦是 MacBook Air 。


正確:他的電腦是 MacBook Air。

句子

(1)避免使用長句。

不包含任何標點符號的單個句子,或者以逗號分隔的句子構(gòu)件,長度盡量保持在 20 個字以內(nèi);20~29 個字的句子,可以接受;30~39 個字的句子,語義必須明確,才能接受;多于 40 個字的句子,任何情況下都不能接受。

錯誤:本產(chǎn)品適用于從由一臺服務(wù)器進行動作控制的單一節(jié)點結(jié)構(gòu)到由多臺服務(wù)器進行動作控制的并行處理程序結(jié)構(gòu)等多種體系結(jié)構(gòu)。


正確:本產(chǎn)品適用于多種體系結(jié)構(gòu)。無論是由一臺服務(wù)器(單一節(jié)點結(jié)構(gòu)),還是由多臺服務(wù)器(并行處理結(jié)構(gòu))進行動作控制,均可以使用本產(chǎn)品。

逗號分割的長句,總長度不應(yīng)該超過 100 字或者正文的 3 行。

(2)盡量使用簡單句和并列句,避免使用復(fù)合句。

并列句:他昨天生病了,沒有參加會議。


復(fù)合句:那個昨天生病的人沒有參加會議。

(3)同樣一個意思,盡量使用肯定句表達,不使用否定句表達。

錯誤:請確認沒有接通裝置的電源。


正確:請確認裝置的電源已關(guān)閉。

(4)避免使用雙重否定句。

錯誤:沒有刪除權(quán)限的用戶,不能刪除此文件。


正確:用戶必須擁有刪除權(quán)限,才能刪除此文件。

寫作風(fēng)格

(1)盡量不使用被動語態(tài),改為使用主動語態(tài)。

錯誤:假如此軟件尚未被安裝,


正確:假如尚未安裝這個軟件,

(2)不使用非正式的語言風(fēng)格。

錯誤:Lady Gaga 的演唱會真是酷斃了,從沒看過這么給力的表演?。?!


正確:無法參加本次活動,我深感遺憾。

(3)不使用冷僻、生造或者文言文的詞語,而要使用現(xiàn)代漢語的常用表達方式。

錯誤:這是唯二的快速啟動的方法。


正確:這是僅有的兩種快速啟動的方法。

(4)用對“的”、“地”、“得”。

她露出了開心的笑容。
(形容詞+的+名詞)


她開心地笑了。
(副詞+地+動詞)


她笑得很開心。
(動詞+得+副詞)

(5)使用代詞時(比如“其”、“該”、“此”、“這”等詞),必須明確指代的內(nèi)容,保證只有一個含義。

錯誤:從管理系統(tǒng)可以監(jiān)視中繼系統(tǒng)和受其直接控制的分配系統(tǒng)。


正確:從管理系統(tǒng)可以監(jiān)視兩個系統(tǒng):中繼系統(tǒng)和受中繼系統(tǒng)直接控制的分配系統(tǒng)。

(6)名詞前不要使用過多的形容詞。

錯誤:此設(shè)備的使用必須在接受過本公司舉辦的正式的設(shè)備培訓(xùn)的技師的指導(dǎo)下進行。


正確:此設(shè)備必須在技師的指導(dǎo)下使用,且指導(dǎo)技師必須接受過由本公司舉辦的正式設(shè)備培訓(xùn)。

英文處理

(1)英文原文如果使用了復(fù)數(shù)形式,翻譯成中文時,應(yīng)該將其還原為單數(shù)形式。

英文:?information stored in random access memory (RAMs)?


中文:……存儲在隨機存取存儲器(RAM)里的信息……

(2)外文縮寫可以使用半角圓點(.)表示縮寫。

U.S.A.
Apple, Inc.

(3)表示中文時,英文省略號(?)應(yīng)改為中文省略號(……)。

英文:5 minutes later?


中文:5 分鐘過去了……

(4)英文書名或電影名改用中文表達時,雙引號應(yīng)改為書名號。

英文:He published an article entitled "The Future of the Aviation".


中文:他發(fā)表了一篇名為《航空業(yè)的未來》的文章。

(5)第一次出現(xiàn)英文詞匯時,在括號中給出中文標注。此后再次出現(xiàn)時,直接使用英文縮寫即可。

IOC(International Olympic Committee,國際奧林匹克委員會)。這樣定義后,便可以直接使用“IOC”了。

(6)專有名詞中每個詞第一個字母均應(yīng)大寫,非專有名詞則不需要大寫。

“American Association of Physicists in Medicine”(美國醫(yī)學(xué)物理學(xué)家協(xié)會)是專有名詞,需要大寫。


“online transaction processing”(在線事務(wù)處理)不是專有名詞,不應(yīng)大寫。
以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號