天天看點

機房收費系統文檔(第一遍)總結

        機房收費系統文檔的編寫先來反思,用時較長,之前看完軟工視訊後就應該開始編寫文檔的。但是總結的不知道要如何寫,在加上要準備各種考試,也給了自己推脫的理由,自考完之後才算是真正的開始寫文檔吧!任何事情隻有你真正的開始做,才能知道它到底難不難,隻有做了你才能真正的了解。

        【知識點】

        軟體文檔是計算機軟體産品的重要組成部分,沒有文檔就不能稱其為軟體,更不能稱其為軟體産品。在寫文檔的過程中慢慢了解的文檔的重要性,我們做任何事情都需要方向的指導,有了大方向才能向着目标不斷前進。我覺得文檔就是軟體實作過程中的大方向的指導,隻有大方向掌握好了,軟體項目的實作也就相對簡單了。軟體文檔的規範編制,在軟體開發工作中占有突出的地位,好的文檔的編寫,有利于軟體産品的設計開發,運作維護,對軟體産品充分發揮其自身效益有着非常重要的意義。

        軟體文檔根據其産生和使用的範圍,主要可劃分為3類:開發文檔、使用者文檔、管理文檔。還有的是按照軟體生存期方法,從形式上将其劃分為兩類:軟體開發過程中需要填寫的各種圖表,和應編制的各種技術檔案或管理資料。不同形式的分類,我覺得前者劃分的更加清晰一些,對于初學者來說更好了解。開發文檔顧名思義是描述軟體開發過程的文檔;管理文檔是各階段工作成果的展現,把軟體開發過程中一些不可見的事物變為可見的文字,提供了管理人員、開發人員、操作人員和使用者之間交流溝通的管道;使用者文檔是軟體開發人員為軟體使用者了解、學習使用軟體的說明文檔。

        軟體文檔從給我的模闆中可以看出,文檔的編寫條理一定要清晰,要規範,規範的文檔才能更好地指導軟體的開發完成。從網上查了一些關于文檔編寫的規則,分享一下:

        1、從讀者的角度編寫文檔

        2、避免出現不必要的重複

        3、避免歧義

        4、使用标準結構

        5、記錄基本原理

        6、使文檔保持更新,但頻度不要過高

        7、針對目标的适宜性對文檔進行評審

         【小結】

        真正寫文檔的時間差不多用了10天,寫文檔的過程中,又一次體會到了什麼事情隻要你去做就好,不管好與壞開始做了,才能算是真正的了解。不能隻是自己想着我不了解,感覺很難就又給自己找理由推脫。沒有開始做之前,沒有資格去評判一件事的難與易,自己真正的體會過了,再下結論也不遲。做事之前無聊的想想是一個痛苦的過程,真正的才是做你會發現投入進去幹一件事是很幸福的。有時實踐要比想的重要很多,最起碼那是實實在在的。不知不覺又走過了一個階段,下一階段繼續加油!Fighting。。。。。。

        附圖一張:

機房收費系統文檔(第一遍)總結

繼續閱讀