流程編寫規(guī)范

1、IVR流程編寫規(guī)范IVR Codi ng Sta ndard 編制單位：新太科技技術(shù)開發(fā)中心 編制時間：2004/2/20文檔編號：SPMS-SEP-12版本號：內(nèi)部試用版編制審核批準(zhǔn)生效日期湯冬兒趙剛張少文變更記錄A - ADDED M- MODIFIEDD - DELETED序號日期左甘口 早節(jié)號A/M/D變更簡述變更人目錄1. 目的 . 2. 說明. 3. 流程規(guī)范 . 組織結(jié)構(gòu) 排版 . 注釋 . 命名 . 變量 . 狀態(tài) . 函數(shù) . 流程動作基本約定 1.目的本部分編寫規(guī)范適用于新太 IPS流程編寫。2.說明本規(guī)范作為一個標(biāo)準(zhǔn)的IPS流程編寫規(guī)范，其中對于規(guī)則是必須 遵守的，建議是

2、提醒您需要注意的地方，或者是在該情況下一個較好 的選擇。3.流程規(guī)范3.1組織結(jié)構(gòu)規(guī)則1-1 :在流程文件存放的根目錄下，只能有 .sc、.cod 、.ini文件。其他的文件，按所屬 業(yè)務(wù)不同存放在不同的目錄下，保持流程的根目錄清潔。建議1-1 :不同類型文件按類型分目錄存放，原則是要類型分明，便于管理，便于過期刪除，目 錄下文件如果有無限增長的趨勢，請按一定規(guī)則（例如日期）分目錄存放。建議1-2 :放音動作所需的語音文件.vox /.v41文件，在./vox/目錄存放；流程圖等文檔說明在./doc/目錄下存放。3.2排版規(guī)則2-1 :流程中各狀態(tài)塊間保留1行空行。規(guī)則2-2 :函數(shù)之間保留3

3、行空行。規(guī)則2-3 :流程頭部配置參數(shù)、宏、函數(shù)、全局變量定義區(qū)域按先后順序分開并注釋含義，便于 查找。例1 :sysvox/:stExit:stSuccessAssig n m_n Retur nedCode, 0 - stExit/正常連接坐席成功:stAge ntExitAssig n m_n Retur nedCode, 4 - stExit:stMai nMenuAssig n m_n Retur nedCode, 8 - stExit:stPreMe nuAssig n m_n Retur nedCode, 7 /轉(zhuǎn)坐席后退岀/回到主流程/回到上層菜單- stExit/ 出錯需要主

4、動退出流程:stExitFlow Assign m_nReturnedCode, 9 - stExit:stExit Return m_nReturnedCode /* End of 連接坐席 *15、規(guī)則 7-11 ：子函數(shù)代碼結(jié)束添加注釋“ End of XXXX ”獨(dú)立一行表示結(jié)束。示例參見上面例 例 17建議 7-1 ： 一個函數(shù)僅完成一件功能。 建議 7-2 ： 不要設(shè)計多用途面面俱到的函數(shù)。說明：這會使理解、測試、維護(hù)變得困難。建議 7-3 ： 函數(shù)的功能應(yīng)該是可以預(yù)測的，也就是只要輸入數(shù)據(jù)相同就應(yīng)產(chǎn)生同樣的輸出 建議 7-4 ： 盡量不要編寫依賴于其他函數(shù)內(nèi)部實(shí)現(xiàn)的函數(shù)。建議 7

5、-5 等。建議 7-6建議 7-7建議 7-8建議 7-9檢查函數(shù)所有數(shù)據(jù)輸入的有效性，如語音文件路徑、全局寄存器、自定義全局變量函數(shù)名應(yīng)準(zhǔn)確描述函數(shù)的功能 / 操作。 盡量使用動賓詞組為執(zhí)行某操作的函數(shù)命名。 避免使用無意義或含義不清的動詞為函數(shù)命名。避免函數(shù)中不必要語句，防止流程中的垃圾代碼，盡量減少流程代碼的行數(shù)。建議 7-10 ： 功能不明確且較小的函數(shù)，特別是僅有一個上級函數(shù)調(diào)用它時，應(yīng)考慮把它合并到 上級函數(shù)中而不必單獨(dú)存在。3.3 流程動作基本約定規(guī)則 8-1 ： 流程中等待輸入三次沒有按鍵響應(yīng)(超時) 或連續(xù)三次輸入出錯，應(yīng)返回上一級菜單。規(guī)則 8-2 ： 主菜單等待輸入三次沒有響應(yīng)(超時)或連續(xù)三次輸入出錯應(yīng)該退出流程。不能讓其 無休止的循環(huán)。確保流程在無人干預(yù)的情況下能夠自動退出流程。規(guī)則 8-3 ： 流程中所有的有分支走向的動作，必須處理Event(-1) 的事件，如 Returned(-1) ，避免出現(xiàn)流程掛死。建議8-1 :涉及到數(shù)據(jù)庫操作建議盡量使用ExecSQL動作，不