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

看板Soft_Job作者qwerty0981 (qwerty@qwerty.tw)時間11年前 (2014/12/03 13:17)推噓3(3推 0噓 13→)

留言16則, 5人參與討論串2/2 (看更多)

※ 引述《et282523 (不屈鬥志)》之銘言： : 各位朋友及前輩 : 請教一下各位寫文件的時候，有沒有什麼訣竅？ : 小弟目前正在寫一些說明文件，但發現很難理出一個頭緒 : 我正在寫的是程式架構和流程的說明 : 雖然那個程式的架構是我設計及實作出來的 : 不過因為有點複雜，細節有點多 : 搞到自己寫文件都不知該怎麼下手 : 雖然也不是沒寫文件同事就無法理解 : 但因為是自己寫出來的架構，很想把自己的想法寫的清楚一點 : 也讓未來新進來的同事可以更快的熟悉這個架構 : 不知道前輩們有沒有什麼建議，寫文件真的好痛苦啊？ : 好想趕快把文件寫完繼續寫 code 啊... 請問，您的說明文件是包含這隻程式如何create的idea，還是僅解釋程式架構和workflow等呢？如果是學生等級的文件，其實structure和flow有出來就可以了。如果是業界等級的文件，可能向您的學長姐有在工作的借一份spec比如DFD參考。如果是經典書籍的等級的文件，可能在文件開頭要包含您create的idea的小故事。大概這樣吧，如還有需要幫忙，請站內信qwerty0981，讓吾幫您補個卦。 -- ※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 220.135.203.156 ※ 文章網址: http://www.ptt.cc/bbs/Soft_Job/M.1417583840.A.4F6.html

推

WisdomOrLie

12/03 13:23, , 1^F

12/03 13:23, 1^F

我很認真回文耶，WisdomOrLie 您，累了嗎？ ※ 編輯: qwerty0981 (220.135.203.156), 12/03/2014 13:28:36

→

et282523

12/03 13:30, , 2^F

12/03 13:30, 2^F

→

et282523

12/03 13:30, , 3^F

12/03 13:30, 3^F

→

qwerty0981

12/03 13:31, , 4^F

12/03 13:31, 4^F

→

et282523

12/03 13:31, , 5^F

12/03 13:31, 5^F

→

qwerty0981

12/03 13:32, , 6^F

12/03 13:32, 6^F

→

et282523

12/03 13:33, , 7^F

12/03 13:33, 7^F

沒的事，祝福您。 ※ 編輯: qwerty0981 (220.135.203.156), 12/03/2014 13:34:55

推

wheattea

12/03 18:10, , 8^F

12/03 18:10, 8^F

我持相對意見。接手人的程度是一點，但不宜被接手人的程度影響自己寫作的內容深度。即使接手人目前程度不能完全參透，只要保有文件，多看幾遍或假以時日他/她再回頭閱讀，因接手人的功力進步後，文件自然就派上用場了。當然，接手人現在看不懂會問問題，那就請原po據實以答就可以了。怎麼拿捏，如何平衡，每個人都會的，沒有佛山無留手的問題。 ※ 編輯: qwerty0981 (220.135.203.156), 12/03/2014 18:19:01

推

wheattea

12/03 22:37, , 9^F

12/03 22:37, 9^F

→

wheattea

12/03 22:38, , 10^F

12/03 22:38, 10^F

嗯，我了解您的意思了，的確是。

→

et282523

12/03 22:45, , 11^F