流程编写规范.docx

IVR流程编写规范 IVR Codi ng Sta ndard 编制单位：新太科技技术开发中心 编制时间：2004/2/20 文档编号：SPMS-SEP-12 版本号：内部试用版 编制 审核 批准 生效日期 汤冬儿 赵刚 张少文 变更记录 A - ADDED M- MODIFIED D - DELETED 序号 日期 左甘口 早节号 A/M/D 变更简述 变更人 目录 目的 . 说明. 流程规范 . 组织结构 排版 . 注释 . 命名 . 变量 . 状态 . 函数 . 流程动作基本约定 1.目的 本部分编写规范适用于新太 IPS流程编写。 2.说明 本规范作为一个标准的IPS流程编写规范，其中对于规则是必须 遵守的，建议是提醒您需要注意的地方，或者是在该情况下一个较好 的选择。 3.流程规范 3.1组织结构 规则1-1 :在流程文件存放的根目录下，只能有 .sc、.cod 、.ini文件。其他的文件，按所属 业务不同存放在不同的目录下，保持流程的根目录清洁。 建议1-1 :不同类型文件按类型分目录存放，原则是要类型分明，便于管理，便于过期删除，目 录下文件如果有无限增长的趋势，请按一定规则（例如日期）分目录存放。 建议1-2 :放音动作所需的语音文件 .vox /.v41 文件，在./vox/ 目录存放；流程图等文档说 明在./doc/ 目录下存放。 3.2排版 规则2-1 :流程中各状态块间保留 1行空行。 规则2-2 :函数之间保留3行空行。 规则2-3 :流程头部配置参数、宏、函数、全局变量定义区域按先后顺序分开并注释含义，便于 查找。 例1 : \sysvox\\ } //… //… :stExit :stSuccess [Assig n m_n Retur nedCode, 0 ] - stExit //正常连接坐席成功 :stAge ntExit [Assig n m_n Retur nedCode, 4 ] - stExit :stMai nMenu [Assig n m_n Retur nedCode, 8 ] - stExit :stPreMe nu [Assig n m_n Retur nedCode, 7 ] //转坐席后退岀 //回到主流程 //回到上层菜单 - stExit :stExitFlow // 出错需要主动退出流程[ Assign m_nReturnedCode, 9 ] - // 出错需要主动退出流程 :stExit [ Return m_nReturnedCode ] } //********************** End of 连接坐席 ********************** 15、规则 7-11 ：子函数代码结束添加注释“ End of XXXX ”独立一行表示结束。示例参见上面例 例 15、 建议 7-1 ： 一个函数仅完成一件功能。 建议 7-2 ： 不要设计多用途面面俱到的函数。 说明：这会使理解、测试、维护变得困难。 建议 7-3 ： 函数的功能应该是可以预测的，也就是只要输入数据相同就应产生同样的输出 建议 7-4 ： 尽量不要编写依赖于其他函数内部实现的函数。 建议 7-5 建议 7-5 等。 建议 7-6 建议 7-7 建议 7-8 建议 7-9 函数名应准确描述函数的功能 / 操作。 尽量使用动宾词组为执行某操作的函数命名。 避免使用无意义或含义不清的动词为函数命名。 避免函数中不必要语句，防止流程中的垃圾代码，尽量减少流程代码的行数。 建议 7-10 ： 功能不明确且较小的函数，特别是仅有一个上级函数调用它时，应考虑把它合并到 上级函数中而不必单独存在。 3.3 流程动作基本约定 规则 8-1 ： 流程中等待输入三次没有按键响应 (超时) 或连续三次输入出错，应返回上一级菜单。 规则 8-2 ： 主菜单等待输入三次没有响应(超时)或连续三次输入出错应该退出流程。不能让其 无休止的循环。确保流程在无人干预的情况下能够自动退出流程。 规则 8-3 ： 流程中所有的有分支走向的动作，必须处理 Event(-1) 的事件，如 Returned(-1) ，避 免出现流程挂死。 建议8-1 :涉及到数据库操作建议尽量使用 ExecSQL动作，不推荐使用 DBSelect /DBInsert /DBDelete /DBUpdate 等通过 DBINTERFAC间接操作的做法。示例参见例 6中的ExecSQL动作。 END