UI规范.doc

UI 规范 UI 规范文件一、适用环境和对象二、必要性三、技术原则四、代码编写规范五、页面模版使用规范一、适用环境和对象本规范适用基于浏览器的 B/S 版软件项目开发工作。开发流程中的模版页面编写和模版文件套用工作必须遵照此规范执行。适用对象为开发编码人员、 UI 设计人员、模版编写人员、界面测试人员等。基于客户端的 C/S 版软件开发工作不适用本技术规范。二、必要性本规范旨在制订开发编码人员和 UI 模版编写人员之间在工作交叉部分的技术标准,使他们遵循同一操作规范,利于交叉工作的平缓顺利交接。以标准化方式, 提高沟通和技术协作的水平, 提高工作效率。减少和改变责任不明,任务不清,和由此产生的信息沟通不畅、反复修改、重复劳动、效率低下的现象。三、技术原则代码规范化书写代码规范化书写实现了脚本整体风格的一致, 保证了同一个人不同时期写的脚本风格保持一致,以及同一个工作组中不同的开发人员编写的脚本风格保持一致。因为开发不可能在孤立中进行, 所以代码规范化书写是项目组人员合作沟通的前提。数据层、结构层、表现层分离数据内容就是页面实际要传达的真正信息, 包含数据、文档或者图片等。这里强调的“真正”, 是指纯粹的数据信息本身。把信息内容以一种合适的方式格式化,简言之就是页面排版,例如:分成标题、作者、章、节、段落和列表等, 使内容更加具有逻辑性, 条理清晰易读易懂,叫做“结构(Structure) ”虽然定义了结构,但是内容还是相同的样式没有改变, 例如标题字体没有变大, 正文的颜色也没有变化, 没有背景, 没有修饰。所有这些用来改变内容外观的东西,称之为“表现(Presentation) ”“表现”的作用使内容看上去漂亮、赏心悦目、打动人心! 所有 HTML 和 XHTML 页面就是由“结构、表现和行为”这三方面组成的。抽象一点理解, 内容是基础层, 然后是附加上去结构层和表现层, 人对页面内容的交互及操作效果叫做“行为( Behavior )”, 对于数据、结构与表现相分离,最早是在软件开发架构理论中提出来的。 UI 设计师设计出页面模版,程序员负责内容数据的嵌入,数据可能是从数据库中提取出来,也可能是静态写入的提示性文字, 最后形成一个新的页面展示给软件操作者。模版文件的结构利用 HTML + XHTML 标签来定义, 而所有涉及表现的东西通通剥离出来, 把它放到一个单独的文件里,这个单独的文件就是 CSS 。数据、结构与表现相分离的好处是: 程序员不需要过多的思考页面显示问题, 而只需要根据模版效果把数据放入模版相应的位置。界面的结构和表现由 UI 设计师负责。填入结构的数据自觉套用设计好了的表现效果。最后呈现一个实现功能的完整界面。表现层的分离保持整个软件界面视觉的一致性,使改版也变得非常简单,修改样式表就可以了; 由于结构清晰, 数据层相对独立, 对数据的集成、更新、处理和再利用也更加方便灵活; 四、代码编写规范(一)目录结构及命名规则目录结构规范 1、目录建立的原则:以最少的层次提供最清晰简便的访问结构。 2 、根目录一般只存放 以及其他必须的系统文件 3、在根目录中原则上应该按照系统的栏目结构, 给每一个栏目开设一个目录,根据需要在每一个栏目的目录中开设一个 images 和 media 的子目录用以放置此栏目专有的图片和多媒体文件, 如果这个栏目的内容特别多, 又分出很多下级栏目, 可以相应的再开设其他目录。根目录下的 images 用于存放各页面都要使用的公用图片, 子目录下的 images 目录存放本栏目页面使用的私有图片 4 、所有 JS,ASP,PHP 等脚本存放在根目录下的 scripts 目录 5 、所有 CGI 程序存放在根目录下的 cgi-bin 目录 6 、所有 CSS 文件存放在根目录下 style 目录 7、每个语言版本存放于独立的目录。例如:简体中文 gb 8 、所有 flash, avi, ram, quicktime 等多媒体文件存放在根目录下的 media 目录 9、 temp 子目录放客户提供的各种文字图片等等原始资料, 以时间为名称开设目录,将客户陆续提供的资料归类整理。文件和目录命名规范 1 、文件命名的原则:以最少的字母达到最容易理解的意义。 2 、每一个目录中包含的缺省 html 文件,文件名统一用 3、文件名称统一用小写的英文字母、数字和下划线的组合, 不得包含汉字、空格和特殊字符 4 、尽量按单词的英语翻译为名称。例如: feedback( 信息反馈), aboutus( 关于我们) 不到万不得已不要以拼音作为目录名称 5 、多个同类型文件使用英文字母加数字命名,字母和数字之间用_ 分隔。例如: 。注意, 数字位