先寫文件,就需要拋開**細節,去站在全域性思考,寫作的過程,就是思考的過程。
寫文件可以幫助在寫**之前理清思路和想清整體結構,必須努力把心中一些未成型的混亂的想法和概念確定化和具體化,才能寫出來。
乙個正常的專案組,如果需要長期維護,就需要一定的文件,把設計、操作流程、環境配置等內容記錄下來,而不能依賴於口口相傳。
另外把日常工作中遇到的問題、各種環境配置、一些操作步驟,還有其他可能還會用的上的都記錄下來。
文件是團隊成員很好的溝通工具。
很多人不是不愛寫文件,而是不知道如何寫好文件。寫好文件,關鍵是通過文件把想法表達出來,用詞、格式都是次要的。
一開始的目的是梳理清楚思路,只要腦圖/ppt這種級別的就夠了,在收集反饋的過程中會有很多修改,等到基本確定後再寫細節,就不會有大的反覆。
俗話說:一圖勝千言,寫文件的時候,主要有幾種圖比較常用:線框圖、流程圖、時序圖、截圖。
線框圖
用簡單的方框代替功能、模組、服務等,再用剪頭表示關係或者資料流,簡單直接。需要理清有哪些模組,模組之間的關係。如下netflix賬單系統架構圖。
流程圖
要畫好流程圖,重點是理清楚邏輯關係,各個關鍵節點在不同條件下的走向。如下重置密碼流程圖。
時序圖
可以表示不同物件之間傳送訊息的時間順序,在涉及網路通訊的文件中經常使用。
關鍵是列清楚所有涉及的物件或者服務,以及訊息傳送的先後順序。
最後,也不要陷入過於追求文件的情況中去,花大量的時間寫一些形式化的沒太大意義的文件。
文件很重要,但是工作的軟體高於詳盡的文件。這裡面的平衡很重要。
不需要為**寫很多文件,好的**格式,良好的注釋、完善的單元測試可以很大程度上代替針對**而寫的文件。
10 專案規劃篇 風險管理
風險是指不確定但是一旦發生,可能會造成消極影響的事件。風險包括兩方面的內容 1 發生後,會造成什麼樣的損失?2 發生的概率有多大?風險管理就是指在專案進行過程中,識別可能的風險並進行評估和加以監控,從而減少風險對專案的負面影響。通過對風險的管理,可以有效降低風險發生的概率,減少風險發生後的損失。對軟...
課程11 專案一
任務和 檔名稱 main.c 作 者 lp 完成日期 2017年10月11日 版 本 號 visual studio 2015 問題描述 編寫乙個程式,其功能為 從鍵盤上輸入乙個浮點數 小數點後有三位 然後分別輸出該數的整數部分和小數部分。includeint main 執行結果 在此題的基礎上,我...
第11周專案四
corpyright c 2013,煙台大學計算機學院 all right reseved.完成日期 2014年5月5日 版本號 v1.0 輸入描述 問題描述 第11周專案四 程式輸出 問題分析 演算法設計 include includeusing namespace std class point...