做技術的也需要文檔寫得漂亮。軟件類文檔是給人看的,因此“可讀性高”是好文檔的重要標準之一。要想可讀性高,通常需要注意以下幾點:
① 標題、小標題、正文的字號、字重(文字粗細)應該有所區別。
② 正文的字號、行距合適,重點內容要想辦法使之突出,方便閱讀。
③ 軟件操作類的文檔,圖片必不可少,要圖文並茂 。
④ 截圖中有文字的,要想辦法使截圖裏的文字不至於太小。
⑤ 多使用序號,條分縷析。
⑥ 排版美觀,如果文檔頁數較多(大於10頁),要插入目錄。
一、頁邊距
軟件類文檔,通常要插入含有代碼、圖表的截圖,文檔默認頁邊距是“上下2.54cm,左右3.18cm”,這樣留給插入的圖片的寬度其實是比較窄的,所以,我們第一步要調整頁邊距,建議頁邊距均設置爲2cm。
二、字體
字號:
文檔標題的字號要明顯大於正文,例如使用“小一”或者“二號”字號,小標題字號可以略微大於(或等於)正文並加粗。正文使用“小四”或者略小一點的“11號”字號。
字體:
標題、小標題採用較粗的字體,例如“黑體”或者“微軟雅黑加粗”,正文可使用“宋體”或者“微軟雅黑”。
三、截圖
截圖中如果文字較多時(例如有很多代碼),那麼要想辦法不要讓截圖中的文字太小,因爲如果文字太小,閱讀就會很困難。那麼如何實現這個目的呢?舉例說明如下:
示例1:
下面這張圖截的是一個文本比較工具的頁面。圖的寬度很長,導致裏面的文字很小。但是我們發現,其實“紅色橢圓”處並沒有有效信息。
改進如下:
再點一次右上角的“最大化”圖標,讓頁面取消最大化顯示,然後用鼠標調整頁面的寬度(寬度最好小於650像素),再截一張圖粘貼到Word文檔中。
示例2:
下圖中,截取了一段代碼,但是截圖“左右兩端”明顯都有空白的無信息部分。這些無信息部分除了讓截圖中的文字變小,沒有任何其他作用。
改進如下:
重新截一張,不截取兩端無用的空白部分,這樣截圖中的文字明顯大了一號。
如果截圖時,發現頁面中有一行代碼特別長,不妨把它先變成兩行,再截圖。
四、突出重點
軟件類文檔,最重要的是要能讓讀者能迅速抓到重點,所以作爲文檔的撰寫人,就要有意識地標出重點。
① 文字
文字突出重點,主要通過加粗、加下劃線、放大字號、傾斜、改文字顏色實現(或者這幾種方式疊加,常見的是使用加粗和改文字顏色)。
② 圖片編輯
圖片編輯突出重點主要是在圖片中做標記,例如畫線、畫框、加字、加箭頭的方式。如下圖所示: