iT邦幫忙

0

【請益】整理專案的文件

我是新人,剛進入公司要接手一個已經開發五六年,很成熟的專案,有幾千支程式。我想要把這個專案整理成文件,讓之後新進的員工能看這份文件就能很清楚的知道操作流程還有程式架構,請問要怎麼下手?我對整理文件這方面沒有什麼經驗,打開word思緒又很亂,不知道怎樣去架構文件目錄,有沒有前輩能給什麼建議或是範本呢?

kikulu iT邦研究生 5 級 ‧ 2019-07-05 08:54:08 檢舉
做文件是吃力不討好的事 除非你主管有要求 不然花時間在這邊還不如去重構降低程式數量

主要原因有兩點

1.大部分人都沒有耐心看別人的東西

2.看完了系統文件要和使用者情景對應 是需要一點慧根

如果只是要好維護 應該是反過來從日常作業的情境下手

以下不是正規的做法

Snap2HTML 建立程式檔案清單
oCam 螢幕錄製UI
schemaspy 建立資料表清單

1.以功能的UI為出發的清單整理
用UI Flow 搭配相關的清單與資料表
Ex. xxx功能 相關的 UI 程式 資料表

2.框架定義
要修改資料欄位 要改哪一支
要修改UI 要改哪一支
要修改流程 要改哪一支

幾千支應該是有用一些框架工具產生代碼 這部分代表很多是不需要改 不需要改動的部分就不是新進員工快速上手所需要知道的
q51941 iT邦新手 5 級 ‧ 2019-07-05 18:10:09 檢舉
謝謝大大給的建議,很實用!非常感謝!

2 個回答

1
海綿寶寶
iT邦大神 1 級 ‧ 2019-07-04 18:32:55
最佳解答

這個範本拿去用

你有沒有想過一個問題
為什麼已經五六年的成熟的專案
會沒有文件?

看更多先前的回應...收起先前的回應...
小魚 iT邦大師 1 級 ‧ 2019-07-04 22:40:14 檢舉

很多都沒有文件吧,
除非是要賣給客戶的,
就會有流程的文件,
不過我更好奇的是,
一個專案幾千支程式這是什麼?

ant1017 iT邦新手 4 級 ‧ 2019-07-05 08:13:49 檢舉

我也針對這幾千隻程式感到好奇...0.0

你們因該沒做過很大的專案吧。現在在mvc架構的情況下。是比較難看到幾千支程式碼了,但還是有機會碰到。

再早期的開發的大專案到是很常看到幾千支程式碼。

不過其實海綿有說到一個重點了。為何一直到現在都沒有文件?

不過我還是建議你一下好了。
真要整理舊專案。先從目錄特性下手。然後再從程式檔案標記這是幹啥用的。
簡單而言,先用一份目錄樹的說明檔出來。

再從中來區分物件,外部物件,函數等說明。

q51941 iT邦新手 5 級 ‧ 2019-07-05 18:09:13 檢舉

浩瀚大大說得對,我後來問清楚後才知道,這個專案有十年的歷史了,是很早期的專案,並沒有遵循MVC的模式去寫,所以才會幾千支。然後又不是專業的軟體公司,資訊人員都是接到需求就去做,沒有整理文件,所以我才會覺得很雜亂很難接手,想順便整理成文件。

總之,謝謝各位大大給的建議!!

0
paicheng0111
iT邦高手 1 級 ‧ 2019-07-04 22:44:08

可以試試看用mindmap

q51941 iT邦新手 5 級 ‧ 2019-07-05 18:09:32 檢舉

謝謝!

我要發表回答

立即登入回答