文件帶來的思考和對文件的修改

2021-08-25 21:16:27 字數 1897 閱讀 9490

前幾天雲姐驗收了文件,寫了驗收收費系統的驗收報告,和一些心得體會。

首先,沒有重視文件,感覺文件對於**和圖來說在心裡沒有那麼重要。

其實嘴裡一直在說文件的重要性,重要性,比什麼都重要,但是一直進不了心裡去,為什麼??

歸根到底,這個東西做起來沒有什麼成就感,不像**做起來,寫出**來了,功能實現了,感覺到甜頭了,所以我們願意做這個東西。

聽過吃瓜子理論,人們為什麼都愛吃瓜子(不愛吃的除外)。第一:吃瓜子這個動作很簡單,第二:每嗑瓜子一下就能得到一點回報。所以一點一點孜孜不倦的吃,重複的也是乙個動作,因為有了回報,所以人們不會煩。

想到現在的寫文件,寫**,畫圖,這些東西。哪些和吃瓜子是一樣的,自己感覺寫**跟這個理論很像,每寫出一段**,就像吃到了瓜子一樣那麼香,所以我們都熱衷於寫**,而忽略了文件。

怎麼辦?煩了,很枯燥,很無味。忍著吧。記得剛進提高班的時候曹貴生師哥就說過一句話,前途是光明的,道路是曲折的(可能也是枯燥的),要想成功,忍著吧。

身在這個環境,大家都一樣,公尺老師帶了十多年提高班了,到現在還沒有什麼回報,肯定也煩透了,這就是一流人與不入流人的區別。

你做一些事情,投入了很多,看似沒有回報,那是還沒到時候,就像寫文件,就像辦提高班……想成為偉人嗎?先寫好文件吧,忍著吧,待著吧,每個人成為高手之前都是寂寞的。

附:自己驗收中的各種問題

大體上的錯誤:

1.各種命名都不規範,包括變數命名,類命名。

把各層的類,變數,介面等等能改的都進行了重新命名。(參照提高班命名規範)

2.注釋不完全,不規範。

補全了注釋,對一些類進行了類注釋,方法都進行了標準注釋。個別重要的命名判斷都新增了相應的注釋。

3.文件寫了,但是寫的很少,文件不健全。

進行了相應的文件補充,畫了資料流圖,對文件進行了補充,把文件欠缺的部分進行了補充,其中包括需求分析,概要設計,詳細設計。其中詳細設計中增加了原來畫的uml圖,配合文字進行了詳細設計的完善。最後又新增了開發計畫和使用者手冊的編寫。

4.uml

圖的問題不大,主要要求研究了一下變數生命週期和uml圖中乙個過程的對應關係。在網上進行了一些查詢,資料挺少,到現在也不是很明白乙個變數的生命週期在uml中是怎麼對應的。

5.功能實現:大查詢處時間查詢有問題

之前做的根據時間查詢是字串轉換成時間型別在比較,經常出錯,之後根據時間查詢改用datetimepicker代替文字框輸入,實現了根據時間查詢的功能。

針對文件細節問題:

1. 能測試的盡量測試出來,例:程式所佔硬碟,記憶體大小。

2. 資料流圖的問題,角色不完整,資料流不完整。

3. 整體目錄問題,目錄級別錯誤。

4. 文件不全,沒有使用者手冊和專案開發計畫。

5. 按照模板寫的時候有一些不懂是什麼意思,比如資料流量,要求最低配置等,就胡寫了一通,知之為知之不知為不知,不會就乾脆不寫。

6. 使用者手冊中不用術語,用了術語也應該在後面新增相應的解釋,使用者不是你,不可能什麼都懂。

7. 對待文件要負責,問題永遠不可能解決完,做什麼事肯定也完美不了,但是最起碼要有負責的態度,你對它負責了,它才會對你負責。

針對上面的一些問題,我在文件中都做了相應的修改。

XHTML 對文件型別(DOCTYPE)的驗證

xhtml 文件是根據文件型別宣告進行驗證的。xhtml 指可擴充套件超文字標籤語言 extensible hypertext markup language xhtml 的目標是取代 html。xhtml 與 html 4.01 幾乎是相同的。xhtml 是更嚴格更純淨的 html 版本。xhtm...

XHTML 對文件型別(DOCTYPE)的驗證

xhtml 文件是根據文件型別宣告進行驗證的。xhtml 指可擴充套件超文字標籤語言 extensible hypertext markup language xhtml 的目標是取代 html。xhtml 與 html 4.01 幾乎是相同的。xhtml 是更嚴格更純淨的 html 版本。xhtm...

ElasticSearch修改和刪除文件

修改文件方式一 使用prepareupdate,prepareindex兩者選其一皆可 刪除文件方式一 使用preparedelete刪除文件 client.preparedelete blog2 article article.getid tostring get 修改文件方式二 直接使用upda...