程式設計師寫文件的重要性

2021-07-28 15:25:05 字數 1732 閱讀 7302

寫文件的重要性

對於軟體相關行業,在學校或單位大家也許都已經注意到了,除了要編寫的程式、繪製設計圖之外,還有乙個重要的工作便是寫文件。為什麼要寫文件呢?因為我們要把自己做的東西展示出來,不光展示給同行看,可能還要展示給其他崗位上的工作人員看,甚至展示給使用者看。如果我們只是會寫程式,不會在文件中恰當且優雅地描述自己的想法,那麼就真正的成為「碼農」了。

有關文件書寫,我印象很深的問題有如下幾個方面:

我們每天都會收發很多郵件,我仔細看了一下,很多郵件裡面的內容要麼語句不通順、要麼有很多錯別字、要麼誤用或沒有標點符號。很多時候,從不同的角度理解,一封郵件有很多不同的意思,讓人感覺不知道它究竟要表達乙個什麼意思,這樣極大地降低了工作的效率。

除了**之外,專案也會包含了大量的文件。開啟大部分文件,看到的第一眼,我就有這幾種感覺:排版不工整、格式不正確、語句不通順、錯別字連篇。一看就知道作者沒有認真寫文件,並且語句的表達和組織能力也不強。

在專案小組成員討論的時候,大家幾乎都在說怎樣把程式寫好,而沒有提到在文件書寫方面應如何努力去改進。大家似乎一致認為開發人員的職責就是把程式寫好,其它什麼的都是其次的。

有關計算機軟體的傳統定義為:軟體是計算機系統中與硬體相依存的另一部分,軟體包括程式、資料及其相關文件的完整集合。注意,這裡面就提到了「相關文件」,如果文件沒有寫好,那麼軟體也不能算是優秀的軟體。事實上,軟體功能健全,而由於文件原因出現故障的情況還時有發生。

一般說來,在軟體開發過程中,不同階段涉及到的主要文件如下圖所示:

可見,在軟體的不同階段,需要編寫不同的文件。在計畫階段,需要編寫詳細設計文件、單元測試方案文件和整合測試方案文件等;在開發階段,也是這幾個文件,不過是修訂版,因為我們在實際開發過程中,會發現之前設計不合理的地方或者是考慮不周的地方,這就需要對之前的文件進行修改;在測試階段,要編寫單元測試報告、整合測試報告和系統測試報告等;在軟體的發布階段,要編寫安裝手冊、使用者手冊、公升級指導書等,這些文件主要是面向現場支援人員和使用者的,因此要盡量寫得通俗易懂,千萬不要有模稜兩可的情況存在,否則就只有等待使用者的投訴了。

要想寫好文件,我們需要首先糾正乙個觀念:文件不重要。要把文件放在與程式同等重要的位置。

如何寫出高質量文件?

那麼,我們如何才能寫出高質量的文件呢?我認為可以從如下幾個方面著手:

改變文件為輔的觀念,在平常的工作中,對於自己編寫的每乙份文件,均認真對待。

對於郵件的編寫,要把自己想說的話準確地表達出來,在傳送郵件之前,再看一下內容是否完整、是否還有錯別字、語句是否通順等。

在編寫文件的過程中,要嚴格參照專案組規定的模板來完成。在寫完文件之後,對文件進行語法檢查,以糾正錯別字和有語法錯誤的地方。一般說來,有語法錯誤的語句下面會有一條綠色的波浪線。在提交文件之前,再通讀一下整個文件,看是否還有疏漏和不足。

在工作之餘,可以讀一些能夠提高語言表達能力和寫作能力的書籍或文章,看一下別人是怎樣清晰地闡述自己思想的。例如,經常閱讀csdn上面優秀博主的博文就是乙個提高自己寫作能力的好辦法。

總的說來,和做其它事情一樣,書寫文件也反映了乙個人的態度問題。寫出高質量的文件,不僅可以提公升個人的形象(如果你看到一篇好文件,是不是也對作者有較高的評價?),還能夠提公升產品在客戶心中的形象。如此分析,多花些心思來書寫文件真的是很有必要。

要想做好一件事情,需要我們從各個方面來努力。在開發軟體的過程中,寫好**很重要,清楚明了地在文件中表達自己思想同樣非常的重要。「**」和「文件」就像是乙個人的左膀右臂,一定要讓兩者均衡發展,而不能夠只顧其一。

程式設計師溝通能力的重要性

這是我這段時間工作的一些感悟。功能需求工作上遇到的一些問題。乙個專案的開發,包括前期的功能需求調查 功能需求的確定 功能需求分析。接著是軟體功能設計階段,包括軟體功能架構設計,軟體功能資料庫設計,軟體功能 設計,軟體功能除錯設計,最後是軟體功能的測試。在整個軟體正各開發過程,功能需求調查,功能需求分...

程式設計師拓展人脈的重要性

程式設計師這個群體,相對來說,不夠活躍,交際圈子有限。我現在是個全職的程式設計師,感到自己和身邊的人是有以上共性的。大學 高中 初中 小學,我的朋友都比較少,接觸的人也不多,自己比較內向,也不想與不喜歡的人交往。大三的時候,我的qq好友只有60多個,朋友也很少。當我意識到專心做技術對未來發展不利的時...

文件的重要性 坦率的使用者,文件的重要性

文件的重要性 存檔日期 2019年5月13日 首次發布 2003年11月14日 計算機文件比較偽劣,或者經常不存在。缺少資訊會加劇可用性問題,使使用者無法撥打不友好的技術支援 在 胡思亂想的使用者 的這一期中,peter seebach解釋了文件工作中缺少的內容以及原因。此內容不再被更新或維護。全文...