[請益] 請問寫文件的訣竅

[et282523 (不屈鬥志)]

各位朋友及前輩

請教一下各位寫文件的時候，有沒有什麼訣竅？
小弟目前正在寫一些說明文件，但發現很難理出一個頭緒

我正在寫的是程式架構和流程的說明
雖然那個程式的架構是我設計及實作出來的
不過因為有點複雜，細節有點多
搞到自己寫文件都不知該怎麼下手

雖然也不是沒寫文件同事就無法理解
但想寫清楚讓未來新進來的同事可以更快的熟悉這個架構

不知道前輩們有沒有什麼建議，寫文件真的好痛苦啊？
好想趕快把文件寫完繼續寫 code 啊...

不知道各位前輩願不願意分享一下你們在寫文件，或是了解
一個系統的時候，那個分析的流程是什麼？不管是自己寫的
程式或是別人的程式。

還有，好奇問一下，你們喜歡寫文件嗎？


--
因為我相信
總有那麼一天
我會得到自己想要的幸福
所以為了守護這份得來不易的幸福
我只能不斷的變強
再也不要因為自己不完美讓幸福又溜走了....

--
※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 125.227.141.182
※ 文章網址: http://www.ptt.cc/bbs/Soft_Job/M.1417579299.A.534.html
※ 編輯: et282523 (125.227.141.182), 12/03/2014 12:02:40
→ wheattea: 程式有程式架構 文件有文件架構 先把文件架構想好吧
※ 編輯: et282523 (125.227.141.182), 12/03/2014 12:47:29
推 miyusuea: 你可以用程式寫一個自動文件產生器
推 qrtt1: 如果我覺得文件太難下筆，有時會先想想程式能不能再簡單些.
推 bleed1979: 文件難下筆是程式不夠簡約，無法切成幾塊幾塊的重點。
→ bleed1979: 回頭修正程式，試圖用註解隔開幾個區塊，再多熟悉之。
※ 編輯: et282523 (125.227.141.182), 12/03/2014 13:41:08
→ et282523: 我也覺得程式被我寫到有點亂了，我再回頭看看好了...
推 domototice: 由上而下的構思  跟由下而上的構思 不太一樣
→ et282523: 不知道各位前輩願不願意分享一下你們在寫文件，或是了解
→ et282523: 一個系統的時候，那個分析的流程是什麼？不管是自己寫的
→ et282523: 程式或是別人的程式。
※ 編輯: et282523 (118.161.129.50), 12/03/2014 22:52:06
→ keyboard56: 基本的流程 結構先出來呀，再來就是特殊處理的地方
→ keyboard56: 要多著墨 這才是大部份問題所在
推 howdiun: code好讀比有文件重要
推 domototice: 註解:流程1.資料庫開啟2.資料寫入資料庫3.資料庫關閉
→ domototice: 功能架構圖 流程架構圖
→ domototice: 配銷系統 請採驗 請購 採購 驗收 等流程 在想細節
→ domototice: UML或 結構程式分析流程
→ domototice: code要有註解 註解整體看起來要流暢 整體
噓 jk47tai: 自己設計，自己寫文件，還能難產，真的是一流的
→ et282523: j大，我只是來請教大家方法的，並不是不寫文件，為什麼
→ et282523: 這麼生氣呢？詢問大家是否有好方法難道很過份嗎？
→ et282523: 公司並沒有要求要寫文件，所以其實我大可以兩手一攤...
→ et282523: 會想寫清楚整個架構，也是基於對自己的要求，也方便他人
→ et282523: 快速上手這部份的程式啊....不需要那麼氣吧？！