專刊內文

當前位置:首頁>專刊分享>內文

瀏覽次數 : 1515



iCoder的自動化系統文件

訊光科技/Allen

前言

撰寫系統文件是開發系統的必要週期之一,只有正確的系統文件,才能讓系統在開發及維護上成為其重要參考依據而事半功倍,但往往常因溝通不良、工程人員素質等等各種因素,導致文件資訊不齊全,甚至發生錯誤,因此建立系統文件與程式碼一體兩面一致化的機制有其絕對之必要性。

而系統文件自動化,將會是解決此問題之必要手段,其除了將減少因人為因素導致各種可能的錯誤發生,亦能節省撰寫文件的時間,縮短系統開發時程,更能讓系統開發人員能投入較多精神於專案規劃與需求上,讓系統更為符合使用者的需求,今iCoder既然是一套具人工智慧的開發系統工具,自動化系統文件,當然是不可缺少,因此就其介紹如下:

 

iCoder系統文件之種類

iCoder能處理的系統文件目前有5種,如下列所示:

A. Table schema(資料表結構)

B. Sever Module(服務端模組)

C. RWD Page(前端網頁)

D. Transaction(過帳處理)

E. WorkFlow(工作流程)

 

各種文件產生之步驟

A. Table Schema(資料表結構)EEPCloud設計頁面中(用戶為雲設計才能有此功能),如下圖:  

 

1. 如下圖於Table處按右鍵,點選匯出系統文件選項

 

2. 如下圖選擇您要產生系統文件的Table或勾選名稱可選取得所有Tables

 

3. 例子為勾選3tables,但限於篇幅只列一個,文件內容如下,名稱為table.docx

. 首頁:目錄(可以用Ctrl+滑鼠左鍵連結)

 

. table schema其內容有索引的欄位明細及表結構的明細,包括欄位、名稱、欄位類型、長度、編輯組件、必填、是否編輯或是否顯示等的規格及說明。


 

B. Sever Module(服務端模組)同樣在EEPCloud設計頁面中,如下的操作:

1. 如下圖於Sever處按右鍵,點選匯出系統文件選項

 

2. 如下圖選擇您要產生系統文件的模組或勾選名稱可選取得所有模組

 

3. 例子為勾選3個模組,但限於篇幅只列一個,文件內容如下,名稱為server.docx

. 首頁:目錄(可以用Ctrl+滑鼠左鍵連結)

 

. 各模組之內容有服務端的所有組件圖、SQL組件的內容及Server端的程式碼。

 

C. RWD Page(前端網頁) 同樣在EEPCloud設計頁面中,如下的操作:

1. 如下圖於RWD處按右鍵,點選匯出系統文件選項

 

2. 如下圖選擇您要產生系統文件的Page或勾選名稱可選取得所有Page

 

3. 例子為勾選1page,其文件內容如下,名稱為bootstrap.docx

. 首頁:目錄

 

. Page之內容有前端頁面的所有組件圖、DataGridDataForm規格屬性明細、前端的JS程式碼。

D. Transaction(過帳處理) 同樣在EEPCloud設計頁面中,如下的操作:

1. 如下圖於TRS處按右鍵,點選匯出系統文件選項

 

2. 如下圖選擇您要產生系統文件的TRS或勾選名稱可選取得所有TRS

3. 例子為勾選1TRS,其文件內容如下,名稱為trans.docx

. 首頁:目錄

 

. TRS之內容有交易過帳的關係圖,及過帳明細內容等。


 

E. WorkFlow(工作流程) 同樣在EEPCloud設計頁面中,如下的操作:

1. 如下圖於WorkFlow處按右鍵,點選匯出系統文件選項