如何写"完"UI设计说明书

如何写“完”UI 设计说明书.txt 男人应该感谢20多岁陪在自己身边的女人。因为20岁是男人人生的最低谷,没钱,没事业;而20岁,却是女人一生中最灿烂的季节。只要锄头舞得好,哪有墙角挖不到?1004*623

如何写“完”UI 设计说明书

我们中的大多数人都写过UI 设计说明书(或UI 规格说明书),论坛里也经常会有类似的讨论,对UI 设计说明书的框架和结构我就不做过多的说明了。为什么有人写了上百页的UI 设计说明书,别人还是看不懂,或者说忽略了细节呢?那今天我们重点讨论一下关于细节阐述和表达的一些经验,以免写出只有自己看得懂的UI 设计说明书。

我先说说我总结的一些经验吧,希望大家积极讨论:

我们的目标是:(没有蛀牙,^_^ 玩笑!)

既要清晰描述用户界面原型中的细节和交互方式,又要方便项目组的其他开发人员、需求人员以及测试人员等角色交流察看的说明文档。

主要内容包括:

1. 产品的目标和成功标准,(例如一个全新的预言项目不可能要求用户满意度在90%以上,对升级产品要求就会高一些。)

2. 产品最终用户群及产品用途(了解用户的年龄、职业、产品的使用环境等都是非常必要的)

3. 首先满足基本功能。(例如DVD 机的基本功能是播放影碟,可能还有播放CD 的功能等等)

4. 主要功能(在产品的几十个功能中通过用户验证和项目组筛选,选取用户最常用到的功能,将其优化,以不同层次展现于界面上。)

5. 用户界面特性。(每一款界面都有自己的特性,比如触摸屏的操作界面与手机的操作界面就算功能完全一样,结构、布局等特点也不会相同的。)

几点注意事项

1. 必须紧贴需求,围绕功能点展开。

2. 描述语言简短精确(这样别人看的时候才不会烦)

3. 保持文本的易维护性,建议使用WORD 的大纲视图编写,便于更改和查找。

4. 说明书一定要有版本管理,对每次更新内容要做详细说明。

5. 图标要与名称一同提交,并说明是什么类型,如桌面图标、列表中的图标、工具栏图标、按钮图标、属性框或提示信息框中的图标等等。

6. 注意纪录,包括项目组和用户以及合作伙伴,如果在解释某一特性时令两人以上会感到困惑,那这一部分就需要更清楚的阐述了。

7. 设计与实现同步,这个时最难的了,很多设计由于程序无法实现都被“卡”掉,早期程序也无法确定是否可以实现,伤脑筋!

8. 维护UI 设计说明书时不要忘记维护原型,作为UI 设计说明书的补充原型是很重要的。 UI 设计中容易被忽略的地方

1. 支持错误提示和撤销操作

2. 简便的安装和卸载。

3. 必要的设置和帮助。

4. 异常处理、错误消息的描述和问题回应提示。

5. 除界面上有的图标和按钮外,还要有快捷键、菜单访问键、右键菜单、是否支持从其它软件界面内托拽复制文件等操作的说明。

6. 域、菜单和按钮在什么情况下为不可点击状态。

7. 状态区,用来描述界面状态的区域,通常位于页面下方。(PS 存储时状态区会显示进度条)

8. 剪贴板行为,用户在我们产品中拷贝的文字或图片的局部,是否可以贴入其他程序。

9. 指针的行为,说明超过多长时间的等待时应出现沙漏状态,在文本输入区光标应有改变、

有链接的地方有变为小手等

10. 声音行为,警示音、按钮触发音等

11. 统一消息窗的弹出位置、背景色、大小、布局及特色

12. 菜单栏和下拉选项等程序动作的描述,是向下还是向右弹出等。

13. 动态状态描述,如果要求窗口渐隐或渐显,那就要说明渐隐或渐显过程的时间以及方式(半透明还是马赛克)等。

Art Designer作业规范书

1定义

2作业环境

? Art Designer日常作业的主要编辑工具:

? 软件图标主要编辑工具:

? 各种Logo 设计及印刷设计:

其他常用的编辑工具:

2.2 Art Designer 一般作业要求

? 各个产品需求图档主要是:

Logo & Symbolic Mark:软件的识别标志象征图及标准字搭配方案;

Autorun :光碟自动执行界面;

Splash :软件激活时的欢迎及说明画面;

Login :登陆界面;

Banner :显示版权信息及系列软件版本号画面;

Icon :软件工具栏,应用程序配套图标;

Source :各类软件所图形资源。

? 命名规范:

aaa_bbb.ccc aaa-软件代号 bbb-图片类别 (splash、sanner 、logo 等) ccc-文件后缀名(文件类型)

? 备份共享方式:

3产品相关图文件 编辑规格

3.1 图文件编辑规格

以下为产品图文件编辑模板的举例说明:

图文件编辑规格(附图以“XXXXXX ”为例)

Logo & Symbolic Mark:软件的标志和象征图形用于宣传和视觉记忆。

(由于标志的范围很广,设计制作时必须用适量设计软件完成,以满足各种不同运用的需求) Autorun:软件CD 安装时有不同选项在以此图为基础添加不同选项的链接按钮。

(软件直接安装无选项时以此图为底图)

软件执行图标 (Icon) 编辑规格

应用程序图标规格:

? 64*64 32bit、48*48 32bit、32*32 32bit、24*24 32bit、16*16 32bit

? 48*48 16bit、32*32 16bit、24*24 16bit、16*16 16bit

? 32*32 4bit、16*16 4bit

(Windows 2000及以下版本支持16bit 图标而Windows xp 支持32bit 的图标,全规格的图标可以在不同系统中自动匹配,4bit 的图标主要用于“安全模式”中显示)

Tool Bar 图标规格:

? 24*24 16bit、16*16 16bit

? 16*16 4bit

Menu 图标规格:

? 16*16 16bit

? 16*16 4bit

4. Art Designer 作业遵循流程规范

5 Art Designer作业中 Adobe Photoshop 专用层面图文件命名规范

6 软件包装设计的规范

7 宣传页的设计要素及注意事项

8 Art Designer日常学习交流

UI 设计指南

年-月-日

版本:V1.0

作者: ***

审核: ***

批准: *** 年-月-日

更改记录

日期 被修改的章节 修改的类型* 修改描述 修改人

年-月-日 全部 A 新建 **

* 修改类型分为 A - ADDED M - MODIFIED D - DELETED

1 简介

1.1 目的

提供UI 设计流程定义,为交互设计提供依据。

1.2 背景

使UI 工作整体流程更具规范化和为这一规范更具有可视性。

1.3 适用范围

任何具有UI 设计阶段的项目。

1.4 缩写和术语

1.4.1可用性 usability

以有效性、效率和满意度为指标,产品在特定使用背景下为了特定的目的可为特定用户使用的程度。

1.4.2 用户 user

与产品交互的个体。

1.4.3 任务 task

实现目的所必需的活动。

1.5 参考资料

(本规范使用到的参考资料)

1.6 本文结构概述

定义UI 设计流程和角色定义。

1.7 流程概述

介绍整个UI 设计阶段的执行过程。

2 流程定义

2.1 流程图划分

UI 设计流程图

在流程图中其实是有两个纬度,分别是纵向和横向

2.1.1 纵向:是角色的划分对于一个项目来说通常会有三个角色分别是用户研究角色、设计角色、制作角色

用户研究角色:主要是让UI 实现以用户为中心的设计主要工作有两点

在进行界面设计前了解整体产品的需求,并针对UI 设计了解用户对UI 的需求,再把这需求传达给设计师,即《UI 需求分析报告》,这过程中的主要方法有焦点小组等。 在UI 设计过程当中会不停的要求对设计进行评价这是就要求让用户来评价,我们称这种方法叫使用性测试,在流程图中的表现是对交互模型的使用性测试和验证性地使用性测试。

设计角色:主要是实现界面的交互设计即逻辑设计和界面设计

在做交互设计时一般是要根据《UI 需求分析报告》做交互模型,即用一些工具实现一些交互的动作,让用户能直观的了解界面间的逻辑关系,来确认设计的可行性。 在界面设计时主要是设计皮肤即界面的布局图标的摆放等,这时的设计也是要遵循需求,并且要写《UI 设计说明》。

制作角色:主要是实现界面的截图及坐标的定义

在这过程中制作角色要和开发人员沟通,两个角色相互配合完成项目的最后阶段。

2.1.2横向:是代表时间轴和整个项目开发的过程是对应的:UI 的数据采集阶段实际上就是项目的启动阶段交互设计和使用性测试阶段就是项目的细化阶段界面设计和美术制作阶段就是项目的构造阶段。

2.2 关于评审点的说明

在UI 流程图中实际上可以把UI 的工作划分成四个部分即数据采集、交互设计、界面设计、美术制作。

在数据采集阶段:会有可能是非正式评审主要会有交互设计师需求人员等参与;

在交互设计阶段:也会有评审主要会有用户研究角色、需求角色和开发人员角色来评审逻辑关系的合理性,包括使用合理性和设计合理性;

在界面设计阶段:在设计过程中会不断的和用户及需求人沟通以达到以用户为中心的设计,这结束后会有很正规的评审活动,这是的评审实际上是对整个UI 项目的整体评审,包括工作量、质量等多项的正规的评审;

在美术制作阶段:美术制作阶段实际上就是制作角色和开发人员的不断的沟通完成全部开发工作的阶段,因此这过程的评审是由双方面的协调与合作来表现的。

2.3 UI设计主要流程

时间1 时间2 时间3

UI 启动阶段 UI细化阶段 UI构造阶段

数据采集 分析报告 交互模型 使用性测试 界面原型设计 使用性测试 评审 美术制作 验证性测试

需求分析报告 需求分析报告

2.4 UI设计时间表和里程碑:

数据采集** 交互模型** 使用性测试**

启动阶段《分析报告》 细化阶段《需求分析报告》

细化阶段《需求分析报告》

验证性测试** 美术制作 评审 使用性测试** 界面原型设计

:表示时间点

“**”:表示可裁减的活动

“《.. 》”:表示阶段生成文档

2.5 参与人及担任角色和工作量

角色 人员 工作量

项目经理

交互研究工程师

设计角色

制作角色

界面设计之图标设计规范 图标样式应该有趣、色彩丰富且充满活力,因为现在的系统支持图标是32位图标,并且边缘非常平滑。在矢量程序中绘制完每个图标后,再用Adobe Photoshop 进行处理可使图像更加完美。本规范是专为设计者编写的。在创建图像时,建议您与高水平的图形设计者一起工作,尤其是具有丰富的矢量和3D 软件经验的图形设计者。 图标设计概述的目的是让您熟悉WindowsXP 的新样式,为创建图标做好准备。 图标样式特性

(1) 色彩丰富,是对WindowsXP 外观的补充。 (2) 不同的角度和透视特性为图像增添了动态活力。 (3) 元素的边角十分柔和,并略微有些圆滑。 (4) 光源位于图标的左上角,同时有环绕光照亮图标的其它部分。 (5) 渐变效果使图标具有立体感,进而使图标的外观更加丰满。 (6) 投影使图标更具对比度和立体感。 (7) 添加轮廓可使图像更清晰。 (8) 日常对象(如计算机和设备) 具有更现代化的个人外观。 图标尺寸

Windows XP 图标有四种尺寸,建议使用以下四种尺寸: (1) 48×48像素 (2) 32×32像素 (3) 24×24像素 (4) 16×16像素 图标色彩深度支持

WindowsXP 支持32位图标。32位图标为24位图像加上8位alpha 通道。使图标边缘非常平滑,且与背景相融合。 每个WindowsXP 图标应包含以下三种色彩深度,以支持不同的显示器显示设置: 24位图像加上8位alpha 通道(32位) 8位图像(256色) ,加上1位透明色 4位图像(16色) ,加上1位透明色 调色板

图标中使用的主要颜色。 对象的角度和分组

WindowsXP 样式图标使用的透视网格:并非所有对象使用16×16的复杂图像都能获得较好效果。某些对象通常以直观图像显示:文档图标、符号图标(如警告或信息图标) 、单一对象图标(如放大镜) 除非创建重叠辅助对象可以更清楚地表达图标的含义,否则就可读性和完整性而言,还是应使用直观图像。还应考虑如何按组查看图标,以便确定如何将对象分组。 投影

使用投影后,WindowsXP 图标将更清晰且更具立体感。可在Photoshop 中实现这种效果,本指南的后面部分将对此进行描述。若要为图像添加投影,请在 Photoshop中双击图像的图层,并选择Drop Shadow。然后将Angle 更改为135,Distance 更改为 2,Size 更改为2。此时投影为75%不透明黑色。 轮廓

绘制XP 样式图标时,为图像添加轮廓可使之更清晰,并可保证图像在不同背景色上都具有较好效果。 概念

设计图标时,请考虑以下因素: 使用已有概念以确保真实表达了用户的想法。考虑图标在用户界面环境中以何种形式出现,以及如何作为图标集的一部分使用。考虑图形的文化背景。避免在图标中使用字母、单词、手或脸。必须用图标表示人或用户时,请尽可能使其大众化。如果图标中的图像由多个对象组成,应考虑如何使图像尺寸更小。建议在图标中使用的对象不超过三个。对于 16×16的尺寸大小,还可考虑删除某些对象或简化图像使之更容易辨认。 透明工具

将Gif Movie Gear(GMG)打开一个对话框,其中显示您的图标。使用吸管工具单击图标的背景色。此颜色将更改为暗黄绿色(或在 GMG中选作透明背景色的颜色) 。重复所有4位和8位帧。若要保存图标,请选择 File->Save Icon As...。 创建工具栏

Windows 工具栏图标除不使用投影之外,使用的样式与其它图标相同。由于工具栏图标非常小,建议您使用简单的图像。如果以直观方式显示图像即可清晰地表达图标的含义,则不必使用其它复杂方式。 创建AVI

WindowsXP 使用8位AVI 。创建.avi 文件的过程与创建图标的过程相同-在Photoshop 中准备图像,然后将其拖动到GMG 中。请按以下指导创建8位图标。若要使用GMG 保存AVI ,请转至File->Export As->AVI file 。 创建.avi 文件时,请考虑以下因素:使用品红(R255 G0 B255)作为背景透明色。在Photoshop 中,重要的一点是不要出现杂散像素。

详细设计说明书编写规范

Detailed Design Specification

详细设计说明书编写规范

第1章 引言

1.1 目的

使项目详细设计说明书的编写规范化,从而规范软件管理。 尽可能详细地描述程序的各成份的设计考虑,以利于编制程序。

[此处加入编写目的]

1.2 背景

说明该软件系统名称,开发者,详细设计原则和方案

[此处加入项目背景资料]

1.3 参考资料

列出有关的参考资料名称,作者,发表日期,出版单位

[此处加入参考资料]

1.4 定义

列出本文件中专用的术语,定义和缩写词

[此处加入术语和缩写词]

第2章 程序系统的组织结构

2.1 运行环境(编程协定)

[此处加入运行环境]

2 .1.1 操作系统&数据库系统

列出系统运行的有关操作系统&数据库系统的名称,版本号,对应版权单位

[此处加入操作系统]

[此处加入数据库系统]

2 .1.2 编程工具

列出开发此系统的所需的主要编成工具的名称,版本号,对应版权单位, 并简述其特点

[此处加入编程工具]

2 .1.3 编辑、调试、联接程序

[此处加入编辑、调试、联接程序]

2 .1.4 编译工具

[此处加入编译工具]

2 .1.5 模拟、仿真数据

模拟数据使用过去的真实数据,数据如下:

[此处加入数据]

过程如下:

[此处加入过程]

2 .1.6 诊断、测试程序

[此处加入诊断、测试程序]

2 .1.7 检测程序

[此处加入检测程序]

2.2 单元命名规则

[此处加入单元命名规则]

2.3 程序逻辑

用图表列出本程序系统内每个模块(或子程序)的名称,标识符,以及这些模块(或子程序)之间的层次关系

[此处加入程序逻辑]

第3章 单元设计说明

[此处加入单元设计说明]

3.1 模块单元(或子程序)(标识符)1(名称)

注明该功能模块的编号和模块名称

3 .1.1 程序描述

简要描述安排本模块(或子程序)的目的意义,程序的特点

[此处加入程序描述]

3 .1.2 功能

(1) 功能说明

详细描述此模块(子程序)完成的主要功能

[此处加入功能说明]

(2) 功能框图

[此处加入功能框图]

3 .1.3 输入项

描述每个输入项的特征,如:标识符,数据类型,数据格式,数值的有效范围,输入方式等

[此处加入输入项]

3 .1.4 输出项

描述每个输出项的特征,如:标识符,数据类型,数据格式,数值的有效范围,输出方式等

[此处加入输出项]

3 .1.5 算法

[此处加入算法]

3 .1.6 流程逻辑

[此处加入流程逻辑]

3 .1.7 接口

分别列出和本模块(子程序)有调用关系的所有模块(子程序)及其调用关系,说明与本模块(子程序)有关的数据结构

[此处加入接口]

3 .1.8 限制条件

说明本模块(子程序)运行中受到的限制条件

[此处加入限制条件]

3.2 模块单元(或子程序)(标识符)2(名称)

„„„

第4章 软件界面设计规范

说明:软件界面设计属于详细设计,设计人员可根据项目的规模及时间跨度来决定是否单列出来,可灵活掌握

4.1 编写目的

当今软件界的所有软件无不是可视化的用户界面,它的好处不外乎它有美观、直接、操作者易懂和操作方便等好处。(此处输入编写文档的具体目的)。

4.2 内容:

4 .2.1 界面设计思想

“为用户设计,而不是设计者”。

4 .2.2 界面设计原则

(1) 界面要美观、操作要方便并能高效率地完成工作。

(2) 界面要根据用户需求设计。

(3) 界面要根据不同用户的层次设计。(有的用户对计算机相当了解而有的从来就没碰过计算机)

(4) 避免出现嵌套式的界面设计。

(5) 界面和代码要相互制约。

(6) 界面要通“人性”。即要有引导用户操作的功能,不能是操作一有误就卡住什么都做不下去,又无任何提示来帮助用户如何进行操作。

4 .2.3 界面设计样式

(1) 登录界面 (此处加入登陆界面图)

(2)系统功能布局

菜单形式 (此处加入界面图)

标签栏形式 (此处加入界面图)

(3) 录入界面 (此处加入界面图)

(4) 查询界面 (此处加入界面图)

(5) 统计界面 (此处加入界面图)

4 .2.4 常见提示信息样式

(1) 当操作会带来严重后果时(默认按钮为“否“)

(此处加入界面图)

(2) 当操作会带来一定后果时(默认按钮为“否“)

(此处加入界面图)

(3) 当需征求操作者意愿时(默认按钮为“是“)

(此处加入界面图)

(4) 当需提供操作者帮助时

(此处加入界面图)

(5) 当操作者操作有错时

(此处加入界面图)

(6) 当是一般提示时

(此处加入界面图)

范例: (此处加入界面图)

4 .2.5 常见错误信息样式

(此处加入界面图)

4 .2.6 其他界面约定

字体:一般界面字体为宋体,字号为9Twip (只要把窗体字体设为宋体,字号为9twip 即可)。

颜色:界面颜色采用默认色(除非用户有特殊要求)。

按钮:高度375Twip ,除“确定”和“取消”外都需含有快捷键。 常见按钮快捷键:添加(A)、删除(D)、查询(S)、更新(U)、打印(P)、关闭(C)、重新查询(R)、统计(T)、退出(E)。

数据:REAL 型数据一律保留两位小数且右对齐。

对齐方式:界面上的标题(Label )右对齐,其他控件左对齐。

第5章 编码标准规范

5.1 编写目的:

使用统一编码约定集的主要原因,是使应用程序的结构和编码风格标准化,以便于阅读和理解这段编码。好的编码约定可使源代码严谨、可读性强且意义清楚,与其它语言约定相一致,并且尽可能的直观。

一组通用目的的编码约定应该定义完成上述目的所必需的、能让程序员自由地创建程序逻辑和功能流程的最小的要求。编码约定的目的是使程序易于阅读和理解,而不是用过份的约束和绝对的限制来束缚程序员本身的创造性。 5.2 内容: 程序设计语言的特性和风格会直接影响到软件的质量和可维护性。

编码原则:

应尽量避免在系统初始化时运行过多的代码。(此处加入详细原则)

(1) 选用控制结构只准许一个入口和一个出口。

(2) 程序语句组成容易识别的块,每块只有一个入口和一个出口。

(3) 复杂的结构应该用基本控制结构进行组合嵌套来实现。

(4) 语句中没有的控制结构,可用一段等价的程序段模拟,但要求该程序段在整个系统应前后一致。

(5) 严格控制GOTO 语句,仅在下列情形才可使用。 用一个非结构化的程序设计语言去实现一个结构化的构造。

? 在某种可以改善而不是损害程序可读性的情况下。

? 5 .2.1 对象命名约定

公式:对象名称=对象前缀+自定义名称(自定义名称要有一定的意义且第一个字母大写) 说明:如果是不需要对其编码的对象,那么对象名用默认对象名。

应该用一致的前缀来命名对象,使人们容易识别对象的类型。

下面列出了 Delphi 支持的一些推荐使用的对象约定。

(1) 推荐使用的项目前缀

控件类型 前缀 例子

Class Module cmdl cmdlCheck

Data Environment dev devPrints

Data Report drt drtEnglish

Form frm frmEntry

MDIForm mfrm mfrmSinoexport

Module mdl mdlConnection

Project pjt pjtCkmis

(2)推荐使用的控件前缀

控件类型 前缀 例子

3D Panel pnl pnlGroup

ADO Data ado adoBiblio

Animated button ani aniMailBox

Check box chk chkReadOnly

Combo box drop-down list box cbo cboEnglish

Command button cmd cmdExit

Common dialog dlg dlgFileOpen

Communications com comFax

Control (当特定类型未知时,在过程中所使用的) ctr ctrCurrent

Data dat datBiblio

Data-bound combo box dbcbo dbcboLanguage

Data-bound grid dbgrd dbgrdQueryResult

xxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxx xxxxxxxx

(3)推荐使用的数据访问对象的前缀

用下列前缀来指示数据访问对象。

数据库对象 前缀 例子

Connection con conReports

xxx db dbAccounts

一些例子: (此处加入例子)

(4)推荐使用的菜单前缀

应用程序频繁使用许多菜单控件,对于这些控件具备一组唯一的命名约定很实用。除了最前面 "mnu" 标记以外,菜单控件的前缀应该被扩展:对每一级嵌套增加一个附加前缀,将最终的菜单的标题放在名称字符串的最后。下表列出了一些例子。

菜单标题序列 菜单处理器名称

(此处加入标题序列及处理器名称)

当使用这种命名约定时,一个特定的菜单组的所有成员一个接一个地列在 Visual Basic 的“属性”窗口中。而且,菜单控件的名字清楚地表示出它们所属的菜单项。

(5)为其它控件选择前缀

对于上面没有列出的控件,应该用唯一的由两个或三个字符组成的前缀使它们标准化,以保持一致性。只有当需要澄清时,才使用多于三个字符的前缀。

例如,(此处加入例子)

5 .2.2 常量和变量命名约定

公式:常量或变量名称=常量或变量范围前缀+常量或变量类型前缀+自定义名称(自定义名称要有一定的意义且第一个字母大写) 除了对象之外,常量和变量也需要良好格式的命名约定。本节列出了(此处加入变量列表)。

变量应该总是被定义在尽可能小的范围内。全局 (Public) 变量可以导致极其复杂的状态机构,并且使一个应用程序的逻辑非常难于理解。全局变量也使代码的重用和维护更加困难。

Delphi 中的变量可以有下列范围:

范围 声明位置 可见位置

过程级(此处加入名称)

模块级(此处加入名称)

全局(此处加入名称)。

较好的编码习惯是尽可能写模块化的代码。例如,如果应用程序显示一个对话框,就把要完成这一对话任务所需要的所有控件和代码放在单一的窗体中。这有助于将应用程序的代码组织在有用的组件中,并减小它运行时的开销。

除了全局变量(应该是不被传递的),过程和函数应该仅对传递给它们的对象操作。在过程中使用的全局变量应该在过程起始处的声明部分中标识出来。

变量范围前缀

随着工程大小的增长,划分变量范围的工作也迅速增加。在类型前缀的前面放置单字母范围前缀标明了这种增长,但变量名的长度并没有增加很多。

范围 前缀 例子

全局 g GstrUserName

模块级 m MblnCalcInProgress

本地到过程 无 DblVelocity

(此处加入说明)

变量 声明所有的变量将会(此处加入说明)。

应该给变量加前缀来指明它们的数据类型。而且前缀可以被扩展,用来指明变量范围,特别是对大型程序。

变量数据类型

用下列前缀来指明一个变量的数据类型。

(此处加入说明)

描述变量和过程名

变量或过程名的主体应该使用大小写混合形式,并且应该足够长以描述它的作用。而且,函数名(此处加入函数名称)。

对于频繁使用的或长的项,推荐使用标准缩略语以使名称的长度合理化。一般来说,(此处加入特例说明)就困难了。

当使用缩略语时,要确保它们在整个应用程序中的一致性。在一个工程中,如果一会儿使用(此处加入说明问题),将导致不必要的混淆。

用户定义的类型

在一项有许多用户定义类型的大工程中,常常有必要给每种类型一个它自己的三个字符的前缀。如果这些前缀是(此处加入前缀名称)。 5 .2.3 结构化编码约定

(此处加入约定说明)

记住下列几点:

每一个重要变量的声明应该包括(此处加入变量名称)。

(2)格式化代码

因为许多程序员(此处加入问题)

(此处加入解决问题的说明)

(3)给常量分组

变量和定义的常量应该按功能分组,而不是分散到单独区域或特定文件中。

(4)运算符

(此处加入运算符列表及说明)

(5)为(此处加入问题) 查询创建字符串

(此处加入说明)

5 .2.4 数据源的约定

(此处加入数据源的约定)

5 .2.5 数据库访问约定

访问数据库用ODBC drivers/ADO,但如果在有的技术ADO 解决不了的情况下可用其他方法。

数据库访问技术有:(此处加入说明)

5 .2.6 其他约定

(1)当日期、时间型数据要求严格时,(此处加入说明)

(2)记录集应用约束

(此处加入约束)

利用记录集

(此处加入记录集说明)

(3)文件命名约定

工程文件和各模块文件以汉字命名保存,这样可方便管理和查找。

如何写“完”UI 设计说明书.txt 男人应该感谢20多岁陪在自己身边的女人。因为20岁是男人人生的最低谷,没钱,没事业;而20岁,却是女人一生中最灿烂的季节。只要锄头舞得好,哪有墙角挖不到?1004*623

如何写“完”UI 设计说明书

我们中的大多数人都写过UI 设计说明书(或UI 规格说明书),论坛里也经常会有类似的讨论,对UI 设计说明书的框架和结构我就不做过多的说明了。为什么有人写了上百页的UI 设计说明书,别人还是看不懂,或者说忽略了细节呢?那今天我们重点讨论一下关于细节阐述和表达的一些经验,以免写出只有自己看得懂的UI 设计说明书。

我先说说我总结的一些经验吧,希望大家积极讨论:

我们的目标是:(没有蛀牙,^_^ 玩笑!)

既要清晰描述用户界面原型中的细节和交互方式,又要方便项目组的其他开发人员、需求人员以及测试人员等角色交流察看的说明文档。

主要内容包括:

1. 产品的目标和成功标准,(例如一个全新的预言项目不可能要求用户满意度在90%以上,对升级产品要求就会高一些。)

2. 产品最终用户群及产品用途(了解用户的年龄、职业、产品的使用环境等都是非常必要的)

3. 首先满足基本功能。(例如DVD 机的基本功能是播放影碟,可能还有播放CD 的功能等等)

4. 主要功能(在产品的几十个功能中通过用户验证和项目组筛选,选取用户最常用到的功能,将其优化,以不同层次展现于界面上。)

5. 用户界面特性。(每一款界面都有自己的特性,比如触摸屏的操作界面与手机的操作界面就算功能完全一样,结构、布局等特点也不会相同的。)

几点注意事项

1. 必须紧贴需求,围绕功能点展开。

2. 描述语言简短精确(这样别人看的时候才不会烦)

3. 保持文本的易维护性,建议使用WORD 的大纲视图编写,便于更改和查找。

4. 说明书一定要有版本管理,对每次更新内容要做详细说明。

5. 图标要与名称一同提交,并说明是什么类型,如桌面图标、列表中的图标、工具栏图标、按钮图标、属性框或提示信息框中的图标等等。

6. 注意纪录,包括项目组和用户以及合作伙伴,如果在解释某一特性时令两人以上会感到困惑,那这一部分就需要更清楚的阐述了。

7. 设计与实现同步,这个时最难的了,很多设计由于程序无法实现都被“卡”掉,早期程序也无法确定是否可以实现,伤脑筋!

8. 维护UI 设计说明书时不要忘记维护原型,作为UI 设计说明书的补充原型是很重要的。 UI 设计中容易被忽略的地方

1. 支持错误提示和撤销操作

2. 简便的安装和卸载。

3. 必要的设置和帮助。

4. 异常处理、错误消息的描述和问题回应提示。

5. 除界面上有的图标和按钮外,还要有快捷键、菜单访问键、右键菜单、是否支持从其它软件界面内托拽复制文件等操作的说明。

6. 域、菜单和按钮在什么情况下为不可点击状态。

7. 状态区,用来描述界面状态的区域,通常位于页面下方。(PS 存储时状态区会显示进度条)

8. 剪贴板行为,用户在我们产品中拷贝的文字或图片的局部,是否可以贴入其他程序。

9. 指针的行为,说明超过多长时间的等待时应出现沙漏状态,在文本输入区光标应有改变、

有链接的地方有变为小手等

10. 声音行为,警示音、按钮触发音等

11. 统一消息窗的弹出位置、背景色、大小、布局及特色

12. 菜单栏和下拉选项等程序动作的描述,是向下还是向右弹出等。

13. 动态状态描述,如果要求窗口渐隐或渐显,那就要说明渐隐或渐显过程的时间以及方式(半透明还是马赛克)等。

Art Designer作业规范书

1定义

2作业环境

? Art Designer日常作业的主要编辑工具:

? 软件图标主要编辑工具:

? 各种Logo 设计及印刷设计:

其他常用的编辑工具:

2.2 Art Designer 一般作业要求

? 各个产品需求图档主要是:

Logo & Symbolic Mark:软件的识别标志象征图及标准字搭配方案;

Autorun :光碟自动执行界面;

Splash :软件激活时的欢迎及说明画面;

Login :登陆界面;

Banner :显示版权信息及系列软件版本号画面;

Icon :软件工具栏,应用程序配套图标;

Source :各类软件所图形资源。

? 命名规范:

aaa_bbb.ccc aaa-软件代号 bbb-图片类别 (splash、sanner 、logo 等) ccc-文件后缀名(文件类型)

? 备份共享方式:

3产品相关图文件 编辑规格

3.1 图文件编辑规格

以下为产品图文件编辑模板的举例说明:

图文件编辑规格(附图以“XXXXXX ”为例)

Logo & Symbolic Mark:软件的标志和象征图形用于宣传和视觉记忆。

(由于标志的范围很广,设计制作时必须用适量设计软件完成,以满足各种不同运用的需求) Autorun:软件CD 安装时有不同选项在以此图为基础添加不同选项的链接按钮。

(软件直接安装无选项时以此图为底图)

软件执行图标 (Icon) 编辑规格

应用程序图标规格:

? 64*64 32bit、48*48 32bit、32*32 32bit、24*24 32bit、16*16 32bit

? 48*48 16bit、32*32 16bit、24*24 16bit、16*16 16bit

? 32*32 4bit、16*16 4bit

(Windows 2000及以下版本支持16bit 图标而Windows xp 支持32bit 的图标,全规格的图标可以在不同系统中自动匹配,4bit 的图标主要用于“安全模式”中显示)

Tool Bar 图标规格:

? 24*24 16bit、16*16 16bit

? 16*16 4bit

Menu 图标规格:

? 16*16 16bit

? 16*16 4bit

4. Art Designer 作业遵循流程规范

5 Art Designer作业中 Adobe Photoshop 专用层面图文件命名规范

6 软件包装设计的规范

7 宣传页的设计要素及注意事项

8 Art Designer日常学习交流

UI 设计指南

年-月-日

版本:V1.0

作者: ***

审核: ***

批准: *** 年-月-日

更改记录

日期 被修改的章节 修改的类型* 修改描述 修改人

年-月-日 全部 A 新建 **

* 修改类型分为 A - ADDED M - MODIFIED D - DELETED

1 简介

1.1 目的

提供UI 设计流程定义,为交互设计提供依据。

1.2 背景

使UI 工作整体流程更具规范化和为这一规范更具有可视性。

1.3 适用范围

任何具有UI 设计阶段的项目。

1.4 缩写和术语

1.4.1可用性 usability

以有效性、效率和满意度为指标,产品在特定使用背景下为了特定的目的可为特定用户使用的程度。

1.4.2 用户 user

与产品交互的个体。

1.4.3 任务 task

实现目的所必需的活动。

1.5 参考资料

(本规范使用到的参考资料)

1.6 本文结构概述

定义UI 设计流程和角色定义。

1.7 流程概述

介绍整个UI 设计阶段的执行过程。

2 流程定义

2.1 流程图划分

UI 设计流程图

在流程图中其实是有两个纬度,分别是纵向和横向

2.1.1 纵向:是角色的划分对于一个项目来说通常会有三个角色分别是用户研究角色、设计角色、制作角色

用户研究角色:主要是让UI 实现以用户为中心的设计主要工作有两点

在进行界面设计前了解整体产品的需求,并针对UI 设计了解用户对UI 的需求,再把这需求传达给设计师,即《UI 需求分析报告》,这过程中的主要方法有焦点小组等。 在UI 设计过程当中会不停的要求对设计进行评价这是就要求让用户来评价,我们称这种方法叫使用性测试,在流程图中的表现是对交互模型的使用性测试和验证性地使用性测试。

设计角色:主要是实现界面的交互设计即逻辑设计和界面设计

在做交互设计时一般是要根据《UI 需求分析报告》做交互模型,即用一些工具实现一些交互的动作,让用户能直观的了解界面间的逻辑关系,来确认设计的可行性。 在界面设计时主要是设计皮肤即界面的布局图标的摆放等,这时的设计也是要遵循需求,并且要写《UI 设计说明》。

制作角色:主要是实现界面的截图及坐标的定义

在这过程中制作角色要和开发人员沟通,两个角色相互配合完成项目的最后阶段。

2.1.2横向:是代表时间轴和整个项目开发的过程是对应的:UI 的数据采集阶段实际上就是项目的启动阶段交互设计和使用性测试阶段就是项目的细化阶段界面设计和美术制作阶段就是项目的构造阶段。

2.2 关于评审点的说明

在UI 流程图中实际上可以把UI 的工作划分成四个部分即数据采集、交互设计、界面设计、美术制作。

在数据采集阶段:会有可能是非正式评审主要会有交互设计师需求人员等参与;

在交互设计阶段:也会有评审主要会有用户研究角色、需求角色和开发人员角色来评审逻辑关系的合理性,包括使用合理性和设计合理性;

在界面设计阶段:在设计过程中会不断的和用户及需求人沟通以达到以用户为中心的设计,这结束后会有很正规的评审活动,这是的评审实际上是对整个UI 项目的整体评审,包括工作量、质量等多项的正规的评审;

在美术制作阶段:美术制作阶段实际上就是制作角色和开发人员的不断的沟通完成全部开发工作的阶段,因此这过程的评审是由双方面的协调与合作来表现的。

2.3 UI设计主要流程

时间1 时间2 时间3

UI 启动阶段 UI细化阶段 UI构造阶段

数据采集 分析报告 交互模型 使用性测试 界面原型设计 使用性测试 评审 美术制作 验证性测试

需求分析报告 需求分析报告

2.4 UI设计时间表和里程碑:

数据采集** 交互模型** 使用性测试**

启动阶段《分析报告》 细化阶段《需求分析报告》

细化阶段《需求分析报告》

验证性测试** 美术制作 评审 使用性测试** 界面原型设计

:表示时间点

“**”:表示可裁减的活动

“《.. 》”:表示阶段生成文档

2.5 参与人及担任角色和工作量

角色 人员 工作量

项目经理

交互研究工程师

设计角色

制作角色

界面设计之图标设计规范 图标样式应该有趣、色彩丰富且充满活力,因为现在的系统支持图标是32位图标,并且边缘非常平滑。在矢量程序中绘制完每个图标后,再用Adobe Photoshop 进行处理可使图像更加完美。本规范是专为设计者编写的。在创建图像时,建议您与高水平的图形设计者一起工作,尤其是具有丰富的矢量和3D 软件经验的图形设计者。 图标设计概述的目的是让您熟悉WindowsXP 的新样式,为创建图标做好准备。 图标样式特性

(1) 色彩丰富,是对WindowsXP 外观的补充。 (2) 不同的角度和透视特性为图像增添了动态活力。 (3) 元素的边角十分柔和,并略微有些圆滑。 (4) 光源位于图标的左上角,同时有环绕光照亮图标的其它部分。 (5) 渐变效果使图标具有立体感,进而使图标的外观更加丰满。 (6) 投影使图标更具对比度和立体感。 (7) 添加轮廓可使图像更清晰。 (8) 日常对象(如计算机和设备) 具有更现代化的个人外观。 图标尺寸

Windows XP 图标有四种尺寸,建议使用以下四种尺寸: (1) 48×48像素 (2) 32×32像素 (3) 24×24像素 (4) 16×16像素 图标色彩深度支持

WindowsXP 支持32位图标。32位图标为24位图像加上8位alpha 通道。使图标边缘非常平滑,且与背景相融合。 每个WindowsXP 图标应包含以下三种色彩深度,以支持不同的显示器显示设置: 24位图像加上8位alpha 通道(32位) 8位图像(256色) ,加上1位透明色 4位图像(16色) ,加上1位透明色 调色板

图标中使用的主要颜色。 对象的角度和分组

WindowsXP 样式图标使用的透视网格:并非所有对象使用16×16的复杂图像都能获得较好效果。某些对象通常以直观图像显示:文档图标、符号图标(如警告或信息图标) 、单一对象图标(如放大镜) 除非创建重叠辅助对象可以更清楚地表达图标的含义,否则就可读性和完整性而言,还是应使用直观图像。还应考虑如何按组查看图标,以便确定如何将对象分组。 投影

使用投影后,WindowsXP 图标将更清晰且更具立体感。可在Photoshop 中实现这种效果,本指南的后面部分将对此进行描述。若要为图像添加投影,请在 Photoshop中双击图像的图层,并选择Drop Shadow。然后将Angle 更改为135,Distance 更改为 2,Size 更改为2。此时投影为75%不透明黑色。 轮廓

绘制XP 样式图标时,为图像添加轮廓可使之更清晰,并可保证图像在不同背景色上都具有较好效果。 概念

设计图标时,请考虑以下因素: 使用已有概念以确保真实表达了用户的想法。考虑图标在用户界面环境中以何种形式出现,以及如何作为图标集的一部分使用。考虑图形的文化背景。避免在图标中使用字母、单词、手或脸。必须用图标表示人或用户时,请尽可能使其大众化。如果图标中的图像由多个对象组成,应考虑如何使图像尺寸更小。建议在图标中使用的对象不超过三个。对于 16×16的尺寸大小,还可考虑删除某些对象或简化图像使之更容易辨认。 透明工具

将Gif Movie Gear(GMG)打开一个对话框,其中显示您的图标。使用吸管工具单击图标的背景色。此颜色将更改为暗黄绿色(或在 GMG中选作透明背景色的颜色) 。重复所有4位和8位帧。若要保存图标,请选择 File->Save Icon As...。 创建工具栏

Windows 工具栏图标除不使用投影之外,使用的样式与其它图标相同。由于工具栏图标非常小,建议您使用简单的图像。如果以直观方式显示图像即可清晰地表达图标的含义,则不必使用其它复杂方式。 创建AVI

WindowsXP 使用8位AVI 。创建.avi 文件的过程与创建图标的过程相同-在Photoshop 中准备图像,然后将其拖动到GMG 中。请按以下指导创建8位图标。若要使用GMG 保存AVI ,请转至File->Export As->AVI file 。 创建.avi 文件时,请考虑以下因素:使用品红(R255 G0 B255)作为背景透明色。在Photoshop 中,重要的一点是不要出现杂散像素。

详细设计说明书编写规范

Detailed Design Specification

详细设计说明书编写规范

第1章 引言

1.1 目的

使项目详细设计说明书的编写规范化,从而规范软件管理。 尽可能详细地描述程序的各成份的设计考虑,以利于编制程序。

[此处加入编写目的]

1.2 背景

说明该软件系统名称,开发者,详细设计原则和方案

[此处加入项目背景资料]

1.3 参考资料

列出有关的参考资料名称,作者,发表日期,出版单位

[此处加入参考资料]

1.4 定义

列出本文件中专用的术语,定义和缩写词

[此处加入术语和缩写词]

第2章 程序系统的组织结构

2.1 运行环境(编程协定)

[此处加入运行环境]

2 .1.1 操作系统&数据库系统

列出系统运行的有关操作系统&数据库系统的名称,版本号,对应版权单位

[此处加入操作系统]

[此处加入数据库系统]

2 .1.2 编程工具

列出开发此系统的所需的主要编成工具的名称,版本号,对应版权单位, 并简述其特点

[此处加入编程工具]

2 .1.3 编辑、调试、联接程序

[此处加入编辑、调试、联接程序]

2 .1.4 编译工具

[此处加入编译工具]

2 .1.5 模拟、仿真数据

模拟数据使用过去的真实数据,数据如下:

[此处加入数据]

过程如下:

[此处加入过程]

2 .1.6 诊断、测试程序

[此处加入诊断、测试程序]

2 .1.7 检测程序

[此处加入检测程序]

2.2 单元命名规则

[此处加入单元命名规则]

2.3 程序逻辑

用图表列出本程序系统内每个模块(或子程序)的名称,标识符,以及这些模块(或子程序)之间的层次关系

[此处加入程序逻辑]

第3章 单元设计说明

[此处加入单元设计说明]

3.1 模块单元(或子程序)(标识符)1(名称)

注明该功能模块的编号和模块名称

3 .1.1 程序描述

简要描述安排本模块(或子程序)的目的意义,程序的特点

[此处加入程序描述]

3 .1.2 功能

(1) 功能说明

详细描述此模块(子程序)完成的主要功能

[此处加入功能说明]

(2) 功能框图

[此处加入功能框图]

3 .1.3 输入项

描述每个输入项的特征,如:标识符,数据类型,数据格式,数值的有效范围,输入方式等

[此处加入输入项]

3 .1.4 输出项

描述每个输出项的特征,如:标识符,数据类型,数据格式,数值的有效范围,输出方式等

[此处加入输出项]

3 .1.5 算法

[此处加入算法]

3 .1.6 流程逻辑

[此处加入流程逻辑]

3 .1.7 接口

分别列出和本模块(子程序)有调用关系的所有模块(子程序)及其调用关系,说明与本模块(子程序)有关的数据结构

[此处加入接口]

3 .1.8 限制条件

说明本模块(子程序)运行中受到的限制条件

[此处加入限制条件]

3.2 模块单元(或子程序)(标识符)2(名称)

„„„

第4章 软件界面设计规范

说明:软件界面设计属于详细设计,设计人员可根据项目的规模及时间跨度来决定是否单列出来,可灵活掌握

4.1 编写目的

当今软件界的所有软件无不是可视化的用户界面,它的好处不外乎它有美观、直接、操作者易懂和操作方便等好处。(此处输入编写文档的具体目的)。

4.2 内容:

4 .2.1 界面设计思想

“为用户设计,而不是设计者”。

4 .2.2 界面设计原则

(1) 界面要美观、操作要方便并能高效率地完成工作。

(2) 界面要根据用户需求设计。

(3) 界面要根据不同用户的层次设计。(有的用户对计算机相当了解而有的从来就没碰过计算机)

(4) 避免出现嵌套式的界面设计。

(5) 界面和代码要相互制约。

(6) 界面要通“人性”。即要有引导用户操作的功能,不能是操作一有误就卡住什么都做不下去,又无任何提示来帮助用户如何进行操作。

4 .2.3 界面设计样式

(1) 登录界面 (此处加入登陆界面图)

(2)系统功能布局

菜单形式 (此处加入界面图)

标签栏形式 (此处加入界面图)

(3) 录入界面 (此处加入界面图)

(4) 查询界面 (此处加入界面图)

(5) 统计界面 (此处加入界面图)

4 .2.4 常见提示信息样式

(1) 当操作会带来严重后果时(默认按钮为“否“)

(此处加入界面图)

(2) 当操作会带来一定后果时(默认按钮为“否“)

(此处加入界面图)

(3) 当需征求操作者意愿时(默认按钮为“是“)

(此处加入界面图)

(4) 当需提供操作者帮助时

(此处加入界面图)

(5) 当操作者操作有错时

(此处加入界面图)

(6) 当是一般提示时

(此处加入界面图)

范例: (此处加入界面图)

4 .2.5 常见错误信息样式

(此处加入界面图)

4 .2.6 其他界面约定

字体:一般界面字体为宋体,字号为9Twip (只要把窗体字体设为宋体,字号为9twip 即可)。

颜色:界面颜色采用默认色(除非用户有特殊要求)。

按钮:高度375Twip ,除“确定”和“取消”外都需含有快捷键。 常见按钮快捷键:添加(A)、删除(D)、查询(S)、更新(U)、打印(P)、关闭(C)、重新查询(R)、统计(T)、退出(E)。

数据:REAL 型数据一律保留两位小数且右对齐。

对齐方式:界面上的标题(Label )右对齐,其他控件左对齐。

第5章 编码标准规范

5.1 编写目的:

使用统一编码约定集的主要原因,是使应用程序的结构和编码风格标准化,以便于阅读和理解这段编码。好的编码约定可使源代码严谨、可读性强且意义清楚,与其它语言约定相一致,并且尽可能的直观。

一组通用目的的编码约定应该定义完成上述目的所必需的、能让程序员自由地创建程序逻辑和功能流程的最小的要求。编码约定的目的是使程序易于阅读和理解,而不是用过份的约束和绝对的限制来束缚程序员本身的创造性。 5.2 内容: 程序设计语言的特性和风格会直接影响到软件的质量和可维护性。

编码原则:

应尽量避免在系统初始化时运行过多的代码。(此处加入详细原则)

(1) 选用控制结构只准许一个入口和一个出口。

(2) 程序语句组成容易识别的块,每块只有一个入口和一个出口。

(3) 复杂的结构应该用基本控制结构进行组合嵌套来实现。

(4) 语句中没有的控制结构,可用一段等价的程序段模拟,但要求该程序段在整个系统应前后一致。

(5) 严格控制GOTO 语句,仅在下列情形才可使用。 用一个非结构化的程序设计语言去实现一个结构化的构造。

? 在某种可以改善而不是损害程序可读性的情况下。

? 5 .2.1 对象命名约定

公式:对象名称=对象前缀+自定义名称(自定义名称要有一定的意义且第一个字母大写) 说明:如果是不需要对其编码的对象,那么对象名用默认对象名。

应该用一致的前缀来命名对象,使人们容易识别对象的类型。

下面列出了 Delphi 支持的一些推荐使用的对象约定。

(1) 推荐使用的项目前缀

控件类型 前缀 例子

Class Module cmdl cmdlCheck

Data Environment dev devPrints

Data Report drt drtEnglish

Form frm frmEntry

MDIForm mfrm mfrmSinoexport

Module mdl mdlConnection

Project pjt pjtCkmis

(2)推荐使用的控件前缀

控件类型 前缀 例子

3D Panel pnl pnlGroup

ADO Data ado adoBiblio

Animated button ani aniMailBox

Check box chk chkReadOnly

Combo box drop-down list box cbo cboEnglish

Command button cmd cmdExit

Common dialog dlg dlgFileOpen

Communications com comFax

Control (当特定类型未知时,在过程中所使用的) ctr ctrCurrent

Data dat datBiblio

Data-bound combo box dbcbo dbcboLanguage

Data-bound grid dbgrd dbgrdQueryResult

xxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxx xxxxxxxx

(3)推荐使用的数据访问对象的前缀

用下列前缀来指示数据访问对象。

数据库对象 前缀 例子

Connection con conReports

xxx db dbAccounts

一些例子: (此处加入例子)

(4)推荐使用的菜单前缀

应用程序频繁使用许多菜单控件,对于这些控件具备一组唯一的命名约定很实用。除了最前面 "mnu" 标记以外,菜单控件的前缀应该被扩展:对每一级嵌套增加一个附加前缀,将最终的菜单的标题放在名称字符串的最后。下表列出了一些例子。

菜单标题序列 菜单处理器名称

(此处加入标题序列及处理器名称)

当使用这种命名约定时,一个特定的菜单组的所有成员一个接一个地列在 Visual Basic 的“属性”窗口中。而且,菜单控件的名字清楚地表示出它们所属的菜单项。

(5)为其它控件选择前缀

对于上面没有列出的控件,应该用唯一的由两个或三个字符组成的前缀使它们标准化,以保持一致性。只有当需要澄清时,才使用多于三个字符的前缀。

例如,(此处加入例子)

5 .2.2 常量和变量命名约定

公式:常量或变量名称=常量或变量范围前缀+常量或变量类型前缀+自定义名称(自定义名称要有一定的意义且第一个字母大写) 除了对象之外,常量和变量也需要良好格式的命名约定。本节列出了(此处加入变量列表)。

变量应该总是被定义在尽可能小的范围内。全局 (Public) 变量可以导致极其复杂的状态机构,并且使一个应用程序的逻辑非常难于理解。全局变量也使代码的重用和维护更加困难。

Delphi 中的变量可以有下列范围:

范围 声明位置 可见位置

过程级(此处加入名称)

模块级(此处加入名称)

全局(此处加入名称)。

较好的编码习惯是尽可能写模块化的代码。例如,如果应用程序显示一个对话框,就把要完成这一对话任务所需要的所有控件和代码放在单一的窗体中。这有助于将应用程序的代码组织在有用的组件中,并减小它运行时的开销。

除了全局变量(应该是不被传递的),过程和函数应该仅对传递给它们的对象操作。在过程中使用的全局变量应该在过程起始处的声明部分中标识出来。

变量范围前缀

随着工程大小的增长,划分变量范围的工作也迅速增加。在类型前缀的前面放置单字母范围前缀标明了这种增长,但变量名的长度并没有增加很多。

范围 前缀 例子

全局 g GstrUserName

模块级 m MblnCalcInProgress

本地到过程 无 DblVelocity

(此处加入说明)

变量 声明所有的变量将会(此处加入说明)。

应该给变量加前缀来指明它们的数据类型。而且前缀可以被扩展,用来指明变量范围,特别是对大型程序。

变量数据类型

用下列前缀来指明一个变量的数据类型。

(此处加入说明)

描述变量和过程名

变量或过程名的主体应该使用大小写混合形式,并且应该足够长以描述它的作用。而且,函数名(此处加入函数名称)。

对于频繁使用的或长的项,推荐使用标准缩略语以使名称的长度合理化。一般来说,(此处加入特例说明)就困难了。

当使用缩略语时,要确保它们在整个应用程序中的一致性。在一个工程中,如果一会儿使用(此处加入说明问题),将导致不必要的混淆。

用户定义的类型

在一项有许多用户定义类型的大工程中,常常有必要给每种类型一个它自己的三个字符的前缀。如果这些前缀是(此处加入前缀名称)。 5 .2.3 结构化编码约定

(此处加入约定说明)

记住下列几点:

每一个重要变量的声明应该包括(此处加入变量名称)。

(2)格式化代码

因为许多程序员(此处加入问题)

(此处加入解决问题的说明)

(3)给常量分组

变量和定义的常量应该按功能分组,而不是分散到单独区域或特定文件中。

(4)运算符

(此处加入运算符列表及说明)

(5)为(此处加入问题) 查询创建字符串

(此处加入说明)

5 .2.4 数据源的约定

(此处加入数据源的约定)

5 .2.5 数据库访问约定

访问数据库用ODBC drivers/ADO,但如果在有的技术ADO 解决不了的情况下可用其他方法。

数据库访问技术有:(此处加入说明)

5 .2.6 其他约定

(1)当日期、时间型数据要求严格时,(此处加入说明)

(2)记录集应用约束

(此处加入约束)

利用记录集

(此处加入记录集说明)

(3)文件命名约定

工程文件和各模块文件以汉字命名保存,这样可方便管理和查找。


相关内容

  • 基于耦合度的分布问题研究
  • 【摘要】 本文主要讨论分布式应用系统中基于耦合度的用户分布、功能分布和数据分布问题。【关键词】用户分布,功能分布,数据分布,耦合度,领域知识,自动构造  随着client/server结构应用系统复杂和扩大,其数据、功能和用户的分布问题变得日益突出。合理有效地设计mis系统模型是mis系统能否有效发 ...

  • 浅谈易用性测试
  • 浅谈易用性测试 对于一个需要面对用户的软件产品来说,最直观的UI和使用感受也是产品能否获得用户认可的关键一环.个人认为,在毒霸的产品传统中,从设计到开发再到测试,对产品的易用性和GUI的规范往往给予的关注较少.我在测试过程中就遇到了很多影响使用心情的非关键功能方面的 BUG.希望此文可以在毒霸的易用 ...

  • UI设计师笔试题
  • UI 设计师笔试 基础题 色彩的三原色分别是____._____._____,PS 画笔工具的快捷键是_____,AI 将图层 移至最上层的的快捷键是_______________,PS 去色的快捷键是______________.横向下拉菜单最多________级菜单,网页设计一般用的字体是___ ...

  • it项目管理心得
  • 项目开发方面 项目应以需求为核心.一个项目是否能够成功,对需求的准确把握在成功因素中要占上60%的比例.不管系统的架构设计.团队管理有多么的成功,如果需求出现偏差,仍然是南辕北辙.由于eas项目的特殊性,项目开发过程中能够与客户建立有效快速的沟通渠道,是项目成功的关键. 需求必须获得客户的确认.通过 ...

  • 互联网产品经理人的工作流程
  • 互联网产品经理人的工作流程 Ctrl BY 2010-08-23 | 分类 网络技术0 个评论 产品经理人(product manger):PM在一个企业中因为接触的领域最广,所以需要学习的东西也要最多,不需要成为专才,但是起码也得是个通才.所以PM是个不断积累的职业,即使有一天你失去了这个职位,那 ...

  • 未来ui设计师发展前景如何
  • ui 设计师前景如何 随着时代的发展,尤其是互联网的飞速发展,每天都有大量的网页诞生,这时候就突出了一个新兴行业,那就是ui 设计师,随之而来的就是人们关于ui 的各种问题,ui 设计师的前景无疑是有意向从事ui 设计的人群最为关心的问题,今天千锋小编就和大家谈谈ui 设计师的前景如何? 因为大量网 ...

  • 招聘要求(UI设计师和产品经理)
  • UI设计师招聘要求 岗位职责: 1.牵头WEB产品.移动端产品界面视觉的用户研究.设计流行趋势分析: 2.根据产品经理提供的需求,组织界面的关键元素(布局.功能.按钮.风格.特效): 3.根据风格需求以及设备平台特性制定产品视觉以及VI设计: 4.主导设计体验.流程的制定和规范的输出: 5.充分应用 ...

  • 181电能电功
  • 课题:18.1<电能 电功>教学稿 九年级 物理 学科 上 上下)册 主备人:刘霞优秀次备: 刘俊丽 审核人: 审核日期:11.23 教学目标 知识与技能: 1.知道电能及其单位和单位的换算. 2.知道电能表的作用.读数方法.表上几个参数的意义. 3.知道电源和用电器工作过程中的能量转化 ...

  • 产品经理的主要职责
  • 产品经理的主要职责 Product Management & Product Marketing - A Definition 做为一名新进产品经理,甚至一名资深PM,你可能都或多或少对这个职位产生某种迷惑.到底什么是产品经理?这个职位的主要职责是什么?在IT 产业的不同领域,甚至在同一领域 ...