在一個新創公司從零開始寫程式一年多了,現在老闆提出要文檔化,要讓新來的人也能快速上手項目,我不知道應該寫哪些東西到文檔裡,可能寫進去的過一段時間後程式碼就被別的同事改了,文檔就不對了,我要不要寫文檔,寫什麼,或者有更好的方式?
在一個新創公司從零開始寫程式一年多了,現在老闆提出要文檔化,要讓新來的人也能快速上手項目,我不知道應該寫哪些東西到文檔裡,可能寫進去的過一段時間後程式碼就被別的同事改了,文檔就不對了,我要不要寫文檔,寫什麼,或者有更好的方式?
代碼修改記錄
資料庫修改記錄
出現的問題,解決的方法
同事修改的話,要讓同事更新到文件內容醉後面,別直接替換
我覺得先交代一下公司專案的基本流程和規範比較好,例如新來的可能不一定知道公司之前的一些工作記錄,搞不好做了重複工作和瞎折騰。可以先簡單說明一下公司專案中用到的一些工具,框架,平台的基本介紹和相關連結;然後是公司編碼規範,基本業務,工作計劃(Todo),代碼管理;然後是之前在工作過程中遇到的一些問題和解決方案,避免新人繼續入坑;最後可以給新手推薦一下公司業務可能涉及需要去學習了解的技術棧。
php開源的DokuWiki
這本來就是一個坑,開發的時候沒寫現在寫。
不過可以給些參考:
系統設計文件、資料庫設計文件、介面設計文件、網站佈署設定文件、網站使用說明文件等