軟體技術文件撰寫要求

1 針對性

文件編制以前應分清讀者物件，按不同的型別、不同層次的讀者，決定怎樣適應他們的需要。

① 對於面向管理人員和使用者的文件，不應像開發文件(面向軟體開發人員)那樣過多地使用軟體

的專業術語。難以避免使用的詞彙，應在文件中新增詞彙表，進行解釋。

② 開發文件使用的專業詞彙未被廣泛認知的，應新增注釋進行說明。

③ 縮寫詞未被廣泛認知的，應在其後跟上完整的拼寫。

2 正確性

① 沒有錯字，漏字。

② 文件間引用關係正確。

③ 文件細節(title/history)正確。

3 準確性

① 意思表達準確清晰，沒有二義性。

② 正確使用標點符號，避免產生歧義。

4 完整性

① 意思表達完整，能找到主語、謂語、賓語，沒有省略主語，特別是謂語。

② 一句話中不能出現幾個動詞乙個賓語的現象。

③ 不遺漏要求和必需的資訊。

5 簡潔性

① 盡量不要採用較長的句子來描述，無法避免時，應注意使用正確的標點符號。

② 簡潔明瞭，不累贅冗餘，每個意思只在文件中表達一次。

③ 每個陳述語句，只表達乙個意思。

④ 力求簡明，如有可能，配以適當的圖表，以增強其清晰性。

6 統一性

① 統一採用專業術語和專案規定的術語集。

② 同乙個意思和名稱，前後描述的用語要一致。

③ 文件前後使用的字型要統一。

④ 同一課題若干文件內容應該協調一致，沒有矛盾。

7 易讀性

① 文字描述要通俗易懂。

② 前後文關聯詞使用恰當。

③ 文件變更內容用其他顏色與上個版本區別開來。

④ 測試步驟要採用列表的方式，用1)、2)、3)…等數字序號標註。

有關軟體分發的特殊理念是作業系統未來發展所需關注的乙個問題，即開發一種同時適用於公司和消費者的作業系統。大家普遍認為linux作為一種根據開源軟體技術的原則建立和分發的作業系統，已經對作業系統產生了較大的影響。大多數作業系統驅動程式和實用程式由分發其軟體可執行版本這些版本不可以研究或更改 ...

為期兩天在北京國際飯店會議中心的ibm軟體技術峰會已近結束，此次大會最大的收穫是能和沃森實驗室的王博士溝通人工智慧軟體的發展問題。領略到ibm 雲計算首席架構師jason r.mcgee如何呼風喚雲的收穫頗豐。一下是去會場的一些見聞。早8點，會場門口，排起長隊中午都有絡繹不絕來參會的會議中...