每一位程式設計師都應該提高文件編寫能力

2021-10-07 06:13:35 字數 679 閱讀 5154

在軟體界,程式設計師不願寫文件和寫不好文件已經成為普遍現象:

類似的場景,你是否遇見過:

其實,成為ppt架構師固然不好,但成為只會碼程式,無法向同事、老闆、客戶有效解釋、闡述你的意圖、計畫的技術人,你覺得好嗎?

乙個專案通常要包含的文件:

1、專案實施(開發)計畫和方案

2、軟體需求規格說明書

3、軟體設計說明書(概要設計、詳細設計)

4、資料庫設計文件

5、測試文件(測試計畫、測試報告,包括功能測試、效能測試及安全性測試等)

6、管理員操作手冊

7、安裝部署手冊

8、使用者使用手冊

9、試執行報告

10、使用者培訓文件(培訓計畫、培訓報告)

11、專案開發總結報告

對照著上面的清單,你看看寫過幾個?上面加粗的那些內容,通常都是技術經理、架構師、主力程式設計師來完成的,其他部分各公司分工不同,會各有差別。

所謂 「磨刀不誤砍柴工」,如果乙個專案有較為清晰、有效的文件,既有利於控制風險、方便交流、後續維護,也有利於分工合作、計畫的推進、進度控制。

如果想成為架構師或或將來走上管理崗位,文件編寫能力也是必備的素質;否則,你帶的專案只要稍微大點,失去控制是大概率事件;團隊成員難以管理、考核也是大概率事件。

每一位程式設計師手中都應該有一把 奧卡姆剃刀

在網際網路時代,相信幾乎每個人都聽說過 奧卡姆剃刀定律 但是你真的懂它的意思嗎?更進一步,你真的知道在實際中如何運用奧卡姆剃刀定律嗎?奧卡姆剃刀定律 occam s razor,ockham s razor 又稱 奧康的剃刀 它是由14世紀英格蘭的邏輯學家 聖方濟各會修士奧卡姆的威廉 william...

每個程式設計師都應該經歷一次軟考

今天討論的問題可能會引起很多爭議,但我還是堅持做有爭議的敢說真話的人 軟考在很多各大高校裡還是比較流行的,只能說是流行而已,60 的人只是去湊熱鬧為國家軟考辦去做貢獻的,為什麼要說 每個程式設計師都應該經歷一次軟考 呢,這是源自於本人從軟考中得到的感悟吧,在園子裡很多人都是經歷過軟考的,有的人會說軟...

PHP程式設計師都應該知道的五個工具

php程式設計師都應該知道的五個工具 在參與了幾個大型php專案,寫了很多php 以後,我發現很多任務具可以提高 質量,簡化發布,使得做為php開發人員的生涯變得輕鬆許多。許多這樣 的工具可能已經為大家所用。但是,由於一些人甚至沒有注意到這些工具的存在,我會從此開始,好了,不說廢話,下面是我認為所有...