軟工文件」注意注意「事項

2021-08-13 05:54:04 字數 832 閱讀 4792

。當然更建議大家用onenote。

主要說一下,寫軟工文件我遇到的問題。

1.首先是文件的命名問題,咱們手裡的資料是有名字的,但是那只是乙個模板的名字,我們寫文件嚴格的命名規範不僅要有文件名字,還要有編輯日期和編寫人的名字。

2.操作手冊和使用者手冊,首先解釋這兩個是什麼。操作手冊是安裝的過程,使用者手冊是使用說明。但是這兩個之間有的地方會有安裝上重複,大家寫之前可以對比看一下啊。

3.還有就是文件中資料流程圖的處理,我當時其實腦子很亂,看著**還有sql畫的,也畫的不太好。大家一定要理清楚邏輯還有他們之間的關係再去畫圖。

4.模板中是都給了小標題的,如果你用不到那個小標題 就要刪除,因為是給別人看的,你空著是沒有完成。

1.uml會學習九種圖,以後的文件還有再編輯,在文件中加圖。我還沒有開始uml ,等開始了我再來補充著一條。

2.做乙個軟體,肯定是先寫文件,後做系統,軟工文件一般是專案組長寫的,軟工文件的好壞,直接影響到乙個軟體的好壞。一定要學好怎麼寫文件。

3.區分一下資料字典和輸出輸入項的區別。

4.做好總結,能事半功倍。

Scala API文件檢視注意事項

注意 初學者建議 1.www.scala lang.org api在現瀏覽scaladoc 2.檢視文件時,每個類旁邊的c和o會連線到對應的類 c 或者伴生物件 o 3.使用數字型別,檢視richint richdouble等,使用字串檢視stringops 4.數學函式位於scala.math.包...

維護文件寫作注意事項

list 寫作目的 使維護人員通過該手冊能夠正確對系統進行維護,在維護中,盡可能的不要走彎 路,不要因為某些操作失誤而導致重新操作,這些注意事項都需要表達清楚,整個文件應該描述清楚。不能有模稜兩可的地方。list list 寫作方法 考慮該模組與其它模組之間的關係 涉及到寫作的順序,寫作的配合 盡可...

刪除目錄軟鏈結注意事項

實驗環境 在root 目錄下建立乙個目錄 1 並在該目錄下建立乙個2.txt 的檔案,寫入內容 1.txt root server mkdir 1 root server echo 1.txt 1 2.txt root server tree 1 1 2.txtsection 1 目錄後面不帶 則只...