以一個人開發來說,你提到的下列文件其實就夠了:
如果可以,當然還要包含系統建置及組態文件。系統建置文件說明了如何在新的環境中安裝你所開發的系統;組態文件則說明了那些設定檔是可因環境變動而修改的文件。
如果你夠認真的話,當然也要寫系統分析及設計文件,不過寫的好的人不多,因為常常會直接改程式,而忘了寫這樣的系統分析及設計文件,導致文件與程式不同步,也就失去製作文件的意義了。
方便提供你想要寫的架構嗎?
請問你是要寫Q&A、FAQ...之類的?
還是寫SOP?!
如果是寫Q&A,大概短短幾行敍述就結束。頂多再附上一個連結,給個更進階的說明網頁。
當然進階的說明網頁,你就多花心思,把操作過程的擷圖下來,加上註解就很豐富了~
要寫很大的話~有人甚至用WIKI來應對!
若是說明文件是SOP一類,那通常會有樣版參照。
較完整的架構,可以去參考ISO文件範例。
網路找找就很多囉~
加油~
PS/其實來IT邦多逛逛,技術問答的部份,就很像Q&A了。
公司的開發人員只有我一個
除非你主管要求
否則不必寫說明文件
如果你還是想寫
只要寫好程式裡的註解說明
就功德無量了...
因為是開發公司內部的程式,
所以主管最多要求寫 操作手冊以及Q&A 給一般使用的同仁而已,
這部分目前都是用 Excel (萬能的 Excel~~)
平常的程式註解也是有的,
只是考慮到以後組織規模會變大,
而且總是用 Excel 也很不專業...
想要規劃一個工作流程跟規範,
以後帶新人就講解完規範就可以了,
交接不用幾天
目前是規劃到撰寫說明文件這部份,
不過因為太菜了
這方面不知道怎麼做才行
只要「使用的人看得懂,撰寫的人寫得順手」
就是好方法/好工具
如果只是把Excel換成Word
或是到Web介面填東填西的話
其實沒什麼太大好處
也可參考優秀邦友jamesjan的
好文
看了該文章,發現了許多沒考慮到的東西,
感覺可以有個開始的依據了,感謝。
以我之前寫說明文件的經驗
對產品不了解的人:ex一般使用者
建議是「圖文並茂」,文字說明 圖片輔助
對產品了解的人
給文字步驟就看得懂了
如果是說明書的話我會用 PPT (圖片好拉,大小設定A4)
排版清楚也很重要
要怎麼看出成功的"給一般使用者看的說明文件"?
拿給一個不懂的人看就知道了XDDD