我是新人，剛進入公司要接手一個已經開發五六年，很成熟的專案，有幾千支程式。我想要把這個專案整理成文件，讓之後新進的員工能看這份文件就能很清楚的知道操作流程還有程式架構，請問要怎麼下手？我對整理文件這方面沒有什麼經驗，打開word思緒又很亂，不知道怎樣去架構文件目錄，有沒有前輩能給什麼建議或是範本呢？
已邀請的邦友 {{ invite_list.length }}/5
這個範本拿去用
你有沒有想過一個問題
為什麼已經五六年的成熟的專案
會沒有文件？
我也針對這幾千隻程式感到好奇...0.0
你們因該沒做過很大的專案吧。現在在mvc架構的情況下。是比較難看到幾千支程式碼了，但還是有機會碰到。
再早期的開發的大專案到是很常看到幾千支程式碼。
不過其實海綿有說到一個重點了。為何一直到現在都沒有文件?
不過我還是建議你一下好了。
真要整理舊專案。先從目錄特性下手。然後再從程式檔案標記這是幹啥用的。
簡單而言，先用一份目錄樹的說明檔出來。
再從中來區分物件，外部物件，函數等說明。
浩瀚大大說得對，我後來問清楚後才知道，這個專案有十年的歷史了，是很早期的專案，並沒有遵循MVC的模式去寫，所以才會幾千支。然後又不是專業的軟體公司，資訊人員都是接到需求就去做，沒有整理文件，所以我才會覺得很雜亂很難接手，想順便整理成文件。
總之，謝謝各位大大給的建議！！
iThome鐵人賽
看影片追技術