[請益] 如何撰寫程式的document?

看板Soft_Job (軟體人)作者時間18年前 (2007/08/29 12:35), 編輯推噓1(103)
留言4則, 1人參與, 最新討論串1/1
之前老師要我寫一份有關我程式的document 因為原來的程式是改寫別人的 所以並沒有相關的資料參考 所以想問一下 一般而言程式的document 要包含哪些東西阿? 有一定的規格或是有什麼規範嗎?? -- ※ 發信站: 批踢踢實業坊(ptt.cc) ◆ From: 59.104.190.245 ※ 編輯: R119 來自: 59.104.190.245 (08/29 13:10)

08/29 13:34, , 1F
先定義一寫那一種Doc,是reference, tutorial, 或overview?
08/29 13:34, 1F

08/29 13:40, , 2F
不同的文件,會有不同的目的與寫法.
08/29 13:40, 2F

08/29 13:41, , 3F
知道文件的方向後,參考一下MSDN,或是Open Source的文件,
08/29 13:41, 3F

08/29 13:42, , 4F
大致上也就知道怎麼寫了
08/29 13:42, 4F
文章代碼(AID): #16rFTz_D (Soft_Job)
文章代碼(AID): #16rFTz_D (Soft_Job)