前端技术规范总结文档格式.docx
《前端技术规范总结文档格式.docx》由会员分享,可在线阅读,更多相关《前端技术规范总结文档格式.docx(19页珍藏版)》请在冰豆网上搜索。
news_title(性质_描素)
news_title_top(性质_描素_位置)
news_title_top_01(性质_描素_位置_数量)
news_title_top_a_01(性质_描素_位置_分类_数量)news_title_top_b_01(性质_描素_位置_分类_数量)
常用目录名:
data(数据库)images(图片)install(安装)templets(模版)include(包含)admin(后台)rss(定阅)media(媒体)config(配置)Script(脚本)Language(语言)style(样式)等
常用CSS名:
页面外围控制整体布局宽度:
wrapper头:
header内容:
content/container页面主体:
main侧栏:
sidebar尾:
footer等
第二部分:
结构(XHTML)
网站的前端结构与表现分离,达到95%以上。
正式上线后的网页代码结构要清晰、明朗,容易阅读,布局与结构的镶套尽量控制在4-5层以内,严格遵循w3c的xhtml1.0Transtitonal。
并遵循以下原则:
1.DDT类型:
XHTML1.0Transitional2.编码:
utf-83.元标记必须项:
该页面的关键词概况该页面的简要描述具体内容根据SEO要求设置
4.Html代码中的所有标签遵循XHTML1.0的书写规范,包括:
5.
6.7.8.9.10.11.12.13.
a)标签全部使用小写;
b)标签全部闭合;
c)所有属性必须有值而且用双引号;
d)把所有clear:
---------------------------------------------------------容器布局}
每一个属性结尾都必须写分号,其中有的值如果不需要,可以不写,大体上是这样的顺序,也符合思考的顺序。
4.有几点注意事项:
a)font-family:
必须以sans-serif字体做结尾;
b)减少样式数量,尽量重复使用;
c)必须清除float;
d)单位:
使用像素(px);
e)颜色值:
使用#RRGGBB格式
第四部分:
UE指导原则
1.网站LOGO的视觉统一,网站主体的视觉风格、文本颜色、链接颜色、修饰图片风格以及按钮和表单控件的视
觉进行统一;
2.为每一个页面设定一个最合适的标题,使用户和搜索引擎一目了然知道页面的主题;
3.为大部分页面加入元标记,即相关内容,描述页面属性;
在最终页加入具有亲和力的版权说明、
免责声明、交互设计说明文档的链接地址;
4.页面中必须有回到“首页”的链接一般做法是将站点LOGO加上首页的链接,最好还是有回到首页的文字
链接;
5.如果网站栏目很多,要让用户知道所处的页面属于哪个栏目之下,以及很轻松的可以回到上一级栏目标签
是一种不错的方法;
6.现在位置。
如果上一条原则处理的很好,“现在位置”可以去掉;
7.搜索。
合理的放置搜索表单,最好在首屏,并且确保搜索结果的准确性;
表单设计原则:
1.面向菜鸟和专业用户,填写项尽量精简,做简单的填写说明,仅放置与填写表单相关的链接,避免用户通过其
他链接转移视线到别的地方,从而放弃填写表单
2.清晰的验证告诉用户为什么出现错误,并引导正确的填写;
3.如果完成表单任务需要多个步骤,需要用图形或文字表明所需的步骤,以及当前正在进行的步骤使用户知
道离成功还有多远;
4.如果可能,尽量先放置input、textaera等需要键盘输入的项,再放置下拉、单选、复选等键盘操作的项,紧
接着是“提交”按钮就是说,减少键盘操作被鼠标操作打断的次数;
5.文本域允许更改内容的文本格式,比如加粗、字体大小、超链接、图片等等,而且,尽量让此内容与用户完成
发布以后的内容格式相同;
6.提供将表单保存为草稿的功能;
7.设计符合习惯的表单。
个人总结
Web开发的分散性和交互性,决定了Web开发必须遵从一定的开发规范和技术约定,只有每个开发人员都按照一个共同的规范去设计、沟通、开发、测试、部署,才能保证整个开发团队协调一致的工作,从而提高开发工作效率,提升工程项目质量。
本规范并不是一个一成不变的必须严格遵守的条文,特殊情况下要灵活运用,做一定的变通,仅供个人参考。
扩展阅读:
rsp技术开发规范总结
终端RSP
开发规202*-3-4
范目录
一、StoryBoard规范....................................................................................................3
1、场景描述规范................................................................................................32、ServiceTree规范...........................................................................................3二、命名规范..............................................................................................................3
1、RSP命名规范................................................................................................32、元素节点命名规范........................................................................................33、RSP中Java代码命名规范...........................................................................44、切图图片命名规范........................................................................................4三、注释规范..............................................................................................................4
1、RSP文件注释................................................................................................42、RSP节点注释................................................................................................53、业务条件注释................................................................................................5四、开发框架规范......................................................................................................5
1、目录规范........................................................................................................52、RSP框架规范................................................................................................63、屏幕适配框架使用规范..............................................................................104、Cache使用规范...........................................................................................135、CacheObject使用规范.................................................................................14
一、StoryBoard规范
1、场景描述规范
1)描述场景功能,对每个场景编号,该编号和ServiceTree中场景编号对应;
2)描述场景中各个元素的来源,动画效果和交互效果;
2、ServiceTree规范
ServiceTree要对没一个业务场景编号,该编号和StoryBoard的场景编号对应。
ServiceTree要反映各个场景的跳转和层次关系,根据此层次关系确定开发框架中的场景级数。
二、命名规范
1、RSP命名规范
RSP命名形式:
文件所在位置_所属业务_场景名_类型
文件所在位置是指文件是在客户端还是服务器端。
在客户端的文件用"
c"
表
示,在服务器端的文件用"
s"
表示;
所属业务是指该文件属于哪个业务模块,比如该页面在客户端,且属于新闻模块则写成:
c_news.rsp。
业务名全部用英文表示;
场景名是指该rsp所描述对应场景名,场景名用英文表示。
如该页面在客户端是新闻模块,描述的是新闻类型则该rsp名是c_news_type.rsp;
类型是指该rsp是View还是Content。
比如该页面在客户端,且属于新闻模块且为View则写成:
c_news_type_view.rsp;
如果该rsp文件既不是View也不是Content则该类型可以不写。
文件名一律小写。
文件编码必须是UTF-8
2、元素节点命名规范
节点命名形式:
节点域_所属业务_场景名_内容描述
节点域,本地用“Local”,全局用“Global”禁止使用简写;
内容描述,由开发人员定义。
只要符合能表述清楚该节点的功能或内容的原则就行。
内容描述用英文;
节点名称遵循驼峰是命名规则,Global:
newsDetail表示新闻明细或者Global:
news_detail
其他描述同RSP命名规范。
3、RSP中Java代码命名规范
RSP中Java代码变量全小写,只要符合能表述清楚该变量的意义的原则皆可。
代码编写必须遵循java1.5的规范.遵循匈牙利命名规则.
4、切图图片命名规范
图片命名形式