優秀程式猿寫技術文件的正確姿勢

2021-09-24 10:08:43 字數 748 閱讀 3848

寫文件是程式猿高階的乙個必要步驟之一。

文件寫的清楚,思路就更加清晰,也會讓同事高看你一眼,多梳理業務也有很大幫助。

產品經理對需求文件基本是駕輕就熟信手拈來,但是大多數程式猿寫技術文件卻顯得不夠專業。

最近有小夥伴問怎麼寫技術文件,結合了多個優秀的技術文件的範例,總結了技術文件的框架。

話不多說,直接上乾貨。

關鍵是能夠條理清晰,然後配各種uml圖,**等。

我們主要考慮:

《大象uml》、《uml精粹》

工欲善其事必先利其器。

作uml圖推薦viso、processon、plantuml、umlstar、omnigraffle等。

mindnode、xmind、ithougthtx等

第二部分給出了技術文件的框架,引導我們去思考應該考慮的問題。

僅有這些還不夠,實踐是檢驗真理的標準,要去練習才能真正掌握這個框架。

另外看似有了框架啥都不是問題,照著填就完了,事實並非如此。

正如高考英語作文模板一樣,框架都有了差不哪去,但是具體的內容千差萬別,最終的分數還是有浮動的。

要想寫好技術文件,寫的更加專業還需要一些軟能力,比如思維要縝密一些,畫互動,畫uml圖的能力,畫思維導圖的能力的能力等,這些需要平時主動去學習和訓練的。

《優秀產品經理寫需求文件的正確姿勢》

申請時標註來自csdn。

優秀的程式猿

1.挑剔的架構設計能力 對已有架構勇於提出自己的質疑 對自己正確的觀點,據理力爭 對每一種分層 設計的思考 好不好?有沒更好的方案?為什麼這樣設計?優點 2.堅持的學習能力 對新技術保持熱情 業餘時間,用了大量的時間取學習 培訓期間,有條件的情況下,盡量動手 記筆記 只聽 3.不急不操,一步步完成 ...

論程式設計師成長的正確姿勢

何為成長?成長是指自我提公升,一方面是本身的個人能力,另一方面是社會對你的認可度。最終,程式設計師的職位和薪水都能在成長中得以體現。很多人對成長有誤解,在他們眼中,隨著工作年限的提高,成長是理所當然的事情,這其實是乙個誤區。兩個程式設計師同時工作3年,難道他們兩個的成長就完全一樣嗎?其實是不一樣的。...

論程式設計師成長的正確姿勢

何為成長?成長是指自我提公升,一方面是本身的個人能力,另一方面是社會對你的認可度。最終,程式設計師的職位和薪水都能在成長中得以體現。很多人對成長有誤解,在他們眼中,隨著工作年限的提高,成長是理所當然的事情,這其實是乙個誤區。兩個程式設計師同時工作3年,難道他們兩個的成長就完全一樣嗎?其實是不一樣的。...