软件设计规范要求.docx

《软件设计规范要求.docx》由会员分享，可在线阅读，更多相关《软件设计规范要求.docx（31页珍藏版）》请在第一文库网上搜索。

1、软件设计规范要求XXX股份有限公司20XX年XX月目录1 用户界面设计规范11.1 界面设计介绍11.1.1 软件启动封面设计.11.1.2 软件框架设计21.1.3 软件按钮设计.21.1.4 软件面板设计.21.1.5 菜单设计.31.1.6 标签设计.31.1.7 图标设计.31.1.8 滚动条及状态栏设计.31.1.9 安装过程设计.41.1.10 包装及商品化42 界面设计原则12.1 易用性12.2 规范性22.3 合理性32.4 美观与协调性42.5 界面一致性52.6 用户帮助73 编程规范总则13.1 排版13.2 注释33.3 标识符命名53.4 可读性73.5 变量与结构

2、73.6 函数与过程93.7 可测性113.8 程序效率133.9 质量保证143.10 代码编辑、编译与审查163.11 代码测试与维护171用户界面设计规范用户界面：又称人机界面，实现用户与计算机之间的通信,以控制计算机或进行用户与计算机之间的数据传送的系统部件。GUI：即图形用户界面，一种可视化的用户界面，它使用图形界面代替正文界面。本系统坚持图形用户界面(GUI)设计原则，界面直观、对用户透明。用户接触软件后对界面上对应的功能一目了然、不需要多少培训就可以方便地使用本应用系统。1.1 界面设计介绍界面设计是为了满足软件专业化标准化的需求而产生的对软件的使用界面进行美化优化规范化的设计分

3、支。1.1.1 软件启动封面设计应使软件启动封面最终为高清晰度的图像，选用的色彩不宜超过256色，大小多为主流显示器分辨率的1/6大。启动封面上应该醒目地标注制作或支持的公司标志、产品商标、软件名称、版本号、网址、版权声明、序列号等信息，以树立软件形象，方便使用者或购买者在软件启动的时候得到提示。插图宜使用具有独立版权的、象征性强的、识别性高的、视觉传达效果好的图形，若使用摄影也应该进行数位处理，以形成该软件的个性化特征。如果是系列软件还将考虑整体设计的统一和延续性。1.1.2 软件框架设计软件的框架设计相对比较复杂，软件框架设计应该简洁明快,尽量少用无谓的装饰，应该考虑节省屏幕空间，各种分辨

4、率的大小，缩放时的状态和原则，并且为将来设计的按钮、菜单、标签、滚动条及状态栏预留位置。设计中将整体色彩组合进行合理搭配,将软件商标放在显著位置，主菜单应放在左边或上边，滚动条放在右边，状态栏放在下边，以符合视觉流程和用户使用心理。1.1.3 软件按钮设计软件按钮设计应该具有交互性，即应该有3到6种状态效果：点击前鼠标未放在上面时的状态；鼠标放在上面但未点击的状态；点击时状态；点击后鼠标未放在上面时的状态；不能点击时状态；独立自动变化的状态。按钮应具备简洁的图示效果，名称易懂，用词准确能望文知意最好，让使用者产生功能关联反应，群组内按钮应该风格统一，功能差异大的按钮应该有所区别。1.1.4 软

5、件面板设计软件面板设计应该具有缩放功能，面板应该对功能区间划分清晰，应该和对话框、弹出框等风格匹配，尽量节省空间，切换方便。1.1.5 菜单设计菜单设计一般有选中状态和未选中状态，左边应为名称，右边应为快捷键。如果有下级菜单应该有下级箭头符号，不同功能区间应该用线条分割。对与进行的操作无关的菜单要用屏蔽的方式加以处理，如果采用动态加载方式，即只有需要的菜单才显示最好。主菜单的宽度要接近，字数不应多于四个，每个菜单的字数能相同最好。主菜单数目不应太多，最好为单排布置。1.1.6 标签设计标签设计应该注意转角部分的变化，状态可参考按钮。1.1.7 图标设计图标设计色彩不宜超过64色，大小为16x1

6、6、32x32两种，应该加以着重考虑视觉冲击力，它需要在很小的范围表现出软件的内涵，在设计时使用简单的颜色，利用眼睛对色彩和网点的空间混合效果，做出精彩图标。1.1.8 滚动条及状态栏设计滚动条主要是为了对区域性空间的固定大小中内容量的变换进行设计，应该有上下箭头，滚动标等，有些还有翻页标。状态栏是为了对软件当前状态的显示和提示。1.1.9 安装过程设计安装过程设计主要是将软件安装的过程进行美化，包括对软件功能进行图示化。1.1.10 包装及商品化软件产品的包装应该考虑保护好软件产品，功能的宣传融合于美观中，可以印刷部分产品介绍。2界面设计原则2.1易用性(1)完成相同或相近功能的按钮用Fra

7、nIe框起来，常用按钮要支持快捷方式；(2)完成同一功能或任务的元素放在集中位置，减少鼠标移动的距离；(3)按功能将界面划分局域块，用Frame框括起来，并要有功能说明或标题；(4)界面要支持键盘自动浏览按钮功能，即按Tab键的自动切换功能；(5)同一界面上的控件数量最好不要超过10个，多于10个，应考虑使用分页界面显示；(6)分页界面要支持在页面间的快捷切换，常用组合快捷键Ctr1Tab；(7)默认按钮要支持Enter及选择操作，即按Enter后自动执行默认按钮对应操作；(8)可写控件检测到非法输入后应给出说明并能自动获得隹占(9) Tab键的顺序与控件排列顺序要一致，目前流行从上到下、从左

8、到右的方式；(10)复选框和选项框要有默认选项，按选择机率的高低而先后排列，并支持Tab选择；(11)界面空间较小时使用下拉框而不用选项框；(12)选项数较少时使用选项框，相反使用下拉列表框；(13)适当使用相关的专业术语，提倡使用通用性字眼。2.2规范性通常界面设计都按WindOWS界面的规范来设计，即包含“菜单条、工具栏、工具厢、状态栏、滚动条、右键快捷菜单”的标准格式。小型软件一般不提供工具箱。(1)菜单前的图标能直观地代表要完成的操作，常用菜单要有命令快捷方式；(2)完成相同或相近功能的菜单用横线隔开放在同一位置,菜单深度一般要求最多控制在三层以内；(3)相同或相近功能的工具栏放在一起

9、，工具栏中的每一个按钮要有及时提示信息；(4)系统常用的工具栏设置默认放置位置，工具栏的图标能直观地代表要完成的操作，一条工具栏的长度不能超出屏幕宽度；(5)工具栏太多时可以考虑使用工具厢；工具厢要具有可增减性，由用户自己根据需求定制，默认总宽度不要超过屏幕宽度的1/5；(6)状态条要能显示用户切实需要的信息，常用的有：目前的操作、系统状态、用户位置、用户信息、提示信息、错误信息等，高度以放置五好字为宜；(7)滚动条的长度要根据显示信息的长度或宽度能及时变换，以利于用户了解显示信息的位置和百分比，并且宽度应比状态条的略窄；(8)菜单和工具条要有清楚的界限，菜单要求凸出显示，这样在移走工具条时仍

10、有立体感；(9)菜单和状态条中通常使用五号字体。工具条一般比菜单要宽，但不要宽得太多，否则看起来很不协调；(10)右键快捷菜单采用与菜单相同的准则。2.3合理性屏幕对角线相交的位置是用户直视的地方，正上方四分之一处为易吸引用户注意力的位置，在放置窗体时要注意利用这两个位置。(1)父窗体或主窗体的中心位置应该在对角线焦点附近；(2)子窗体位置应该在主窗体的左上角或正中，多个子窗体弹出时应该依次向右下方偏移，以显示出窗体标题为宜；(3)重要的命令按钮与使用较频繁的按钮要放在界面上注目的位置；(4)与正在进行的操作无关的按钮应该加以屏蔽(WindoWS中用灰色显示，没法使用该按钮)；(5)对可能造成

11、数据无法恢复的操作必须提供确认信息，给用户放弃选择的机会。2.4美观与协调性(1)按钮大小基本相近，且与界面的大小、空间要协调，忌用太长的名称；(2)避免空旷的界面上放置很大的按钮，放置完控件后界面不应有很大的空缺位置；(3)前景与背景色搭配合理协调，反差不宜太大，最好少用深色，常用色考虑使用WindoWS界面色调；(4)界面风格要保持一致，字的大小、颜色、字体要相同，除非是需要艺术处理或有特殊要求的地方；(5)如果窗体支持最小化、最大化或放大时，窗体上的控件也要随着窗体而缩放；(6)对于含有按钮的界面一般不应该支持缩放，即右上角只有关闭功能；(7)通常父窗体支持缩放时，子窗体没有必要缩放。2

12、.5界面一致性在界面设计中应该保持界面的一致性。一致性既包括使用标准的控件，也指使用相同的信息表现方法，如在字体、标签风格、颜色、术语、显示错误信息等方面确保一致。(1)显示信息一致性标签提示：字体为不加粗、宋体、黑色、灰底或透明、无边框、右对齐、不带冒号、一般情况为五号；日期：正常字体、宋体、白底黑字；对齐方法左对齐：一般文字、单个数字、日期等右对齐：数字、时间、日期加时间分辨率800*600,增强色16色；字体缺省为宋体、五号、黑色；底色缺省为灰色。这些信息的排列显示风格供参考，在同一软件中应当注意表现形式的一致性。(2)布局合理化应注意在一个窗口内部所有控件的布局和信息组织的艺术性，使得

13、用户界面美观。布局不宜过于密集，也不能过于空旷,合理的利用空间。在一个窗口中按tab键，移动顺序不能杂乱无章，先从上至下，再从左至右。一屏中首先应输入的和重要信息的控件在tab顺序中应当靠前，并放在窗口上较醒目的位置。布局力求简洁、有序、易于操作。(3)鼠标与键盘对应应用中的功能只用键盘也应当可以完成，即设计的应用中还应加入一些必要的按钮和菜单项。但是，许多鼠标的操作，如双击、拖动对象等，并不能简单地用键盘来模拟即可实现。例如在一个列表框中用鼠标单击其中一项表示选中该项内容，为了用键盘也能实现这一功能，必须在窗口中定义一个表示选中的按钮，以作为实现单击功能的替。又如在一个窗口中有两个数据窗口，

14、可以用鼠标从一个数据窗口中将一项拖出然后放到另一个中，如果只用键盘，就应当在菜单中设置拷贝或移动的菜单项。2.6用户帮助系统应该提供详尽而可靠的帮助文档，在用户使用产生迷惑时可以自己寻求解决方法。常用的帮助设施有两种：集成的和附加的。集成的帮助设施一开始就是设计在软件中的，它与语境有关，用户可以直接选择与所要执行操作相关的主题。通过集成帮助设施可以缩短用户获得帮助的时间，增加界面的友好性，附加的帮助设施在系统建好以后再加进去，通常是一种查询能力比较弱的联机帮助。(1)帮助文档中的性能介绍与说明要和系统性能配套一致;(2)最好提供目前流行的联机帮助格式或HTM1帮助格式；(3)在帮助中应该提供我

15、们的技术支持方式，一旦用户难以自己解决可以方便地寻求新的帮助方式。3编程规范总则3.1 排版(I)程序块要采用缩进风格编写，缩进的空格数为4个，对于由开发工具自动生成的代码可以不一致；(2)相对独立的程序块之间、变量说明之后必须加空行；(3)较长的语句要分成多行书写，长表达式要在低优先级操作符处划分新行操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读；(4)循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，同3)；(5)若函数或过程中的参数较长，也要进行适当的划分；(6)不允许把多个短语句写在一行中，即一行只写一条语句；(7) if、for、do、whi1ecase、switch、defau1t等语句自占一行，且if、for、do、WhiIe等语句的执行语句部分无论多少都要加括号;(8)对齐只使用空格键，不使用TAB键；（9）函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case语句下的处理语句也要遵从语句缩进要求；（10）程序块的分界符（如大括号和）