小議程式設計師編寫技術文件

2021-09-05 22:58:21 字數 746 閱讀 4105

一提到寫文件,可能很多程式設計師可能會不屑一顧,但是,無論處於規範開發流程,還是就於逃避嫌責的目的,能夠將自己所從事的工作用文件描述記錄下來,還是一件很有成就感的事情,拋開其功用不談,就個人的成長程序看,也是乙個循序漸進式的好習慣,還是值得大家稍微關注一下的。

昨天在和同事的一次交流過程中,就自己編寫的講演文件得到大家的一些有益反饋,不敢獨享,曬出來和大家一起分享:首先,要明確文件的應用人群和該人群對其內容的偏好程度,因為人越多,需求點可能就會越多,而我們往往會採取一條主觀內容路線的方式進行串接、講解,這樣的邏輯順延效果主要發生在我們自身,而對於聽眾來說,可能就很難達到進一步的共鳴了,但,這一點往往不被我們察覺,自我感覺思路清晰,侃侃而談,就認為自己交流的夠清晰,其實不然,聽眾對該內容不出意外都會較我們少很多,就我們記錄的文件內容,可能很難將這些內容進行串接,進而形成乙個清晰的概念,於是降低了交流效果,加上大家又比較晦澀,可能不會就過多的內容進行異議,於是……

如何才能有所改進呢?

(1)在編寫文件前,就目標群體進行一下簡短的需求調研

(2)將文件的理解點盡量降低,由淺入深地進行介紹,並盡量將一些要點醒目標出,方便溫習和查詢

(3)文件中盡量使用圖釋來記錄資訊,文字內容要少而精,但是切忌圖釋為取彩而忘本,華麗並不能代替標準的資訊傳達

(4)根據文件進行講解的時候,最好能夠同時使用實時系統進行輔助,要擅於使用好投影儀等講解工具

(5)注意大家的意見反饋,就講解過程中出現的一些不能馬上回答的問題,要在交流後第一時間反饋給大家

程式設計師是否應該注重文件的編寫?

一 寫文件的重要性 對於軟體相關行業,在學校或單位大家也許都已經注意到了,除了要編寫的程式 繪製設計圖之外,還有乙個重要的工作便是寫文件。為什麼要寫文件呢?因為我們要把自己做的東西展示出來,不光展示給同行看,可能還要展示給其他崗位上的工作人員看,甚至展示給使用者看。如果我們只是會寫程式,不會在文件中...

程式設計師技術變現

程式設計師技術變現的5中方式 1 做課程 2 做私活定製專案 3 做開源收播助 4 投資同行讓同行給你賺錢 5 做產品 企此 融資 1 做 課 程 提 公升 個 人 知 名 度 幫 助 更 多同行新人成長這樣才能為後面四 個做準備 2 有了一定行業名氣會有同行信任 你的能力因為做課程就裡在顯擺自 己...

關於程式設計師寫文件?

最近個把禮拜,在寫所謂的方案,公司缺人沒事找人湊個數 終於發現人生就是個悲劇,寫的東西技術性態強 雖然經理說沒什麼關係 反正給你弄著玩 但是感覺有心無力 終於發現自己 寫文件的方方面面還是要差很多 連乙個簡單的東西也說不清楚 自己汗乙個 就這個東西延伸點 我看大部分的人 當然是程式設計師 需要寫 的...