业务概要设计书是软件开发中最重要的文档之一,其是否可以冻结(确定完成)是项目风险的重要判断依据,也是可否外包的重要判断标准,因此其品质好坏直接决定整个项目的成败,所以本小节特地把概要设计书应该记述的内容以及各种注意事项与技巧以范例的形式进行说明。
本范例概要设计书使用的工具是Excel。各Sheet名称依次为“封面”“页面效果图”“项目定义”“单项目验证”“相关项目验证”“事件处理”“项目状态”“补足(执行)”与“补足”。各页面属性设置分别如下:列宽度为“2”,高度为“16”,字体为“宋体”,大小为“11”,视图形式为“页面预览”。
各Sheet内容要遵循不重复、不遗漏、简明扼要的原则进行叙述,在《页面UI设计规约》或在业务共通设计里进行统一设计与说明的部分,不需要在每个单独设计书里进行分别说明。因为同一个页面内容在增加、修改、删除时式样模板都一样,因此其各页内容安排如下。
(1)封面
封面主要记述文档内容的修改记录,内容的修改必须可追溯(可以是变更管理编号或者故障编号),切忌随意修改设计内容,如图7-6所示。
(2)页面效果图
页面效果图主要根据《页面UI设计规约》描述页面元素外观效果,如图7-7所示。其中页面元素一行最多排列3列,页面元素横纵都要对齐、统一。
图7-6 封面
图7-7 页面效果图
(3)项目定义
项目定义用于描述页面项目元素的详细信息,如图7-8所示。
图7-8 项目定义
(4)单项目验证
单项目验证是对每个输入项目的类型、长度、必填项进行验证的功能,如图7-9所示。因为单项目验证内容比较单一固定,因此一般可以使用代码自动化工具来自动生成代码。因此,这部分设计的格式需要兼顾代码自动化工具的输入格式要求,不能随便删除与增减列的数量(验证项目的行可以随意增减)。
图7-9 单项目验证
(5)相关项目验证
相关项目验证指的是输入项目之间业务逻辑关系的验证,如图7-10所示。这部分内容由于业务类型各式各样而没有一定规律可循,因此一般无法使用工具进行代码的自动化生成。需要强调的是,如果涉及数据库操作,其相应的SQL语要记述在备注里。
(www.daowen.com)
图7-10 相关项目验证
(6)事件处理
事件处理是对页面按钮等所做的业务处理的详细描述(在共通式样里叙述的“返回”“主页”与“退出”除外),如图7-11所示。事件名称顺序按照初期显示及页面事件元素的排序进行记述。为防止页面数据在确认页面被更改,数据的验证在单击“执行”按钮时需再执行一次。
(7)项目状态
项目状态指的是在不同业务需求下页面项目隐藏与活性状况的描述,如图7-12所示。
(8)补足(执行)
补足(执行)是指“事件处理”等Sheet里面,需要进行增加详细补充说明时的补足信息(是补足的一种),如图7-13所示。
(9)补足
补足是对本业务处理、业务规则或者流程等内容的补充,其格式比较自由,如图7-14所示。如果需要可以单独一页,如“补足(执行)”页。
图7-11 事件处理
图7-12 项目状态
图7-13 补足(执行)
图7-14 补足
(10)设定
设定的内容主要是“项目定义”中页面属性描述项选项卡的一览信息,如表7-3所示。
表7-3 设定
免责声明:以上内容源自网络,版权归原作者所有,如有侵犯您的原创版权请告知,我们将尽快删除相关内容。