前端开发设计规范
目录
前端开发设计规范 (1)
一、HTML使用规范 (1)
1.1、页面文件命名规范 (1)
1.2、页面head部分书写规范 (1)
1.3、HTML元素开发规范 (2)
1.3.1、HTML元素书写规范 (2)
1.3.2、HTML元素命名规范 (3)
二、WEB页面开发规范 (4)
2.1、错误跳转页面的处理 (4)
2.2、提示信息的处理 (4)
2.3、页面的返回 (4)
2.4、提交前数据的判断验证 (4)
2.5、删除操作 (5)
2.6、页面中java代码的使用 (5)
2.7、网站页面布局规范 (5)
2.7.1、前台页面尺寸 (5)
2.7.2、标准网页广告图标规格（参考） (6)
2.7.3、页面字体 (6)
2.7.4、字体颜色 (6)
三、javaScript开发规范 (7)
3.1、javaScript文件命名规范： (7)
3.2、javaScript开发规范 (7)
3.2.1、javaScript书写规范 (7)
3.2.2、javaScript命名规范 (8)
四、css样式规范 (9)
4.1、css样式文件命名规范 (9)
4.1.1、通用样式文件命名规范： (9)
4.1.2、业务类样式文件命名规范 (10)
4.1.3、css样式文件命名须知 (10)
4.2、css样式文件存放目录规范 (10)
4.3、css样式定义规范 (10)
4.3.1、css样式内容顶部注释规范 (10)
4.3.2、css样式内容注释规范 (11)
4.3.3、css样式定义规范 (11)
4.3.4、css样式常用id的命名 (12)
4.3.5、css样式常用class的命名 (14)
4.4、css样式书写规范 (14)
4.4.1、css样式排版规范 (14)
4.4.2、css样式书写风格规范 (15)
4.4.3、css样式属性定义顺序规范 (15)
4.4.4、css样式其他规范 (16)
4.4.5、css样式 Hack的使用 (17)
4.4.6、字体定义规范 (17)
4.4.7、css样式检测 (17)
4.4.8、注意事项 (18)
4.5、css样式引用规范 (18)
4.6、媒体内容命名规范 (18)
五、项目文件存放规范 (19)
六、前端开发规则 (19)
一、HTML使用规范
1.1、页面文件命名规范
命名格式为：项目名缩写_所属功能_所属功能子项_... .jsp/html…，文件命名下划线不能超过三个，命名尽量使用简短的能明确表明文件用途的英文或者英文简写。
1.2、页面head部分书写规范
1)、JSP页面：需要在页面的最开始部分增加以下语句：
2)、HTML页面：需要在页面的最开始部分增加以下语句：
3)、HTML5页面：页面添加编码格式可简写为：
4)、响应式的网页添加如下语句：
5)、title元素：一般网页必须添加title元素，若为框架页面，则可以不写。title
统一使用中文，title内容要简洁明了，不能超过20个字。
6)、外部js的引用：页面加载时需要用到的js文件写在head中，引用时不用写
language属性，HTML5可以省略type属性，如。
7)、外部CSS文件的引用：必须使用link方式引入，HTML5可以省略type属性，CSS
文件引入要放在js文件前。
1.3、HTML元素开发规范
1.3.1、HTML元素书写规范
1)、代码的结构要保持完整性，单个标签必须要关闭，如：
，2)、子元素要比父元素缩进两个字符。
3)、body中的所有内容不能直接书写在
标签中，需要在body中嵌入一层div，所有的元素需要写在改div中。
4)、除非必要，所有标签元素的样式都需要使用CSS文件来定义。
5)、img元素：所有展示用图片都要使用alt属性添加能简要描述图片的文字说明，
如首页的广告图片等，必须具有width和height属性。
6)、所有Form都要指定action属性，但属性值需要则填写，不需要则留空，method
属性统一使用POST；所有form表单都要在提交前对输入的数据前进行验证，验证
使用jQuery validate插件，书写规范如下：
7)、所有不可更改的input元素都要设置readonly属性。
8)、按功能模块添加简单明了的注释，在功能模块的开始标明模块开始，结束时标明
模块结束，注释单独占一行；模块之间留行间隔便于查看代码。
9)、已过时的元素标签使用CSS样式来代替，已过时的标签属性禁止使用，使用CSS
样式定义来实现。
1.3.2、HTML元素命名规范
涉及到跟服务端交互的元素，元素命名应当与服务端程序中定义的对应变量名相同，或使用对象名.变量名的形式。
页面上使用到的不涉及与服务端交互的HTML元素其id和name需统一，所有命名使用元素标签的缩写_后缀方式,后缀命名使用小驼峰命名法即第一个单词全部使用小写，其他单词首字母大写，常见元素命名规则如下表所示：
二、WEB页面开发规范
2.1、错误跳转页面的处理
400、401、403、404、405、406、407、410、412、414、500、501、502等错误代码使用其相应的统一页面，所有错误信息全部使用中文错误信息，标点符号使用中文半角符号。页面设计与项目功能相匹配，做到简洁友好。
2.2、提示信息的处理
成功提示信息可以使用弹窗或跳转统一成功页面的方式，成功页面的风格与网站总体风格相同，格式如下："成功："+提示信息+"！"。
2.3、页面的返回
所有需要返回上一页的时候使用history.back();不使用history.go(-1)。
2.4、提交前数据的判断验证
1)、所有由用户输入的数据在提交前都要进行验证。
2)、验证方式使用jQuery validate插件，需要验证的项：
长度验证：默认长度为数据库中数据的最大长度，中文占两个字符，英文占一个字符。
为空验证：所有不允许为空的输入内容为空时不允许提交。
其他验证：需要根据输入内容的不同设定合适的验证，如Email格式是否正确，身份证号格式是否正确等。
3)、验证后发现错误，需要提示明确的错误信息。错误提示信息样式：字体颜色#ff3366，
文字前面加红色感叹号小图标。
4)、可输入表单需要具有输入内容的提示信息，可使用placeholder属性来定义或者
自定义，颜色必须使用灰色，字体比网站使用字体小。
2.5、删除操作
所有涉及删除的操作，需要用户进行确认之后才能进行操作。
2.6、页面中java代码的使用
页面中不允许使用<% %>的方式嵌入java代码。
2.7、网站页面布局规范
2.7.1、前台页面尺寸
1)、800*600下，网页宽度保持在778以内，就不会出现水平滚动条，高度则视版面
和内容决定，1024*768下，网页宽度保持在1002以内，不会出现水平滚动条，高
度同样视版面内容决定。
2)、根据第一条原则，规定网页的尺寸为width=960px,height=600px。
3)、页面长度原则上不超过3屏（可根据实际情况设定），宽度不超过1屏。
4)、全尺寸banner为468*60px，半尺寸banner为234*60px，小banner为88*31px。
5)、每个非首页静态页面含图片字节不超过60K，全尺寸banner不超过14K。
2.7.2、标准网页广告图标规格（参考）
1)、120*120，适用于产品或新闻照片展示。
2)、120*60，主要用于做LOGO使用。
3)、120*90，主要应用于产品演示或大型LOGO。
4)、125*125，适于表现照片效果的图像广告。
5)、234*60，适用于框架或左右形式主页的广告链接。
6)、392*72，主要用于有较多图片展示的广告条，用于页眉或页脚。
7)、468*60，应用最为广泛的广告条尺寸，用于页眉或页脚。
8)、88*31，主要用于网页链接，或网站小型LOGO。
2.7.3、页面字体
正文内容中文统一使用宋体（可根据需要设定），大小为12px，标题使用14px加粗，不建议使用13px字，英文字体使用Arial和Helvetica/Univers。
2.7.4、字体颜色
1)、正文使用灰黑色#333333。
2)、超链接可以使用蓝色#1f376d或#425c9e，也可以根据整体页面布局进行调整，
整个网站的文字超链接样式要统一。
三、javaScript开发规范
3.1、javaScript文件命名规范：
1)、可通用的javaScript文件：项目名称缩写-文件作用.js。
2)、其他javaScript文件：所属功能-文件作用.js。
3.2、javaScript开发规范
3.2.1、javaScript书写规范
1)、javaScript代码都需要写在javaScript文件中，在页面中进行调用，调用代码
除页面加载时需要用到的外全都写在页面最低端。
2)、如验证用javaScript代码等，每个页面不同且比较短的，可以写在页面的最底
端，从最后一个外部javaScript引入命令后开始。
3)、脚本变量开发规范：变量的使用尽量缩小到小的作用域。如循环使用。
4)、尽量避免使用全局变量。
5)、每一句语句都要以分号“；”结束。
6)、函数程序体缩进四个空格，Tab键为4个空格，以Tab键作为缩进单位。
7)、函数名与“（”之间不应该有空格，“）”与“{”之间加空格。
8)、函数体之间应当加空行。
9)、如果代码本身是清楚的，则只需要在函数定义前，添加简单注释说明该函数的作
用，若代码本身比较复杂，可在个别语句后添加简洁明了的注释。
3.2.2、javaScript命名规范
1)、常量以及全局变量名必须全部使用大写字母。
2)、不要再命名中使用“$”和“\”等特殊字符，不要把“_”作为变量名的第一个
字符和最后一个字符。
3)、变量名必须使用其类型的缩写字符串开始。各种类型的缩写字符串如下：
4)、变量名必须采用有意义的单词命名，如：strUserName、lngArrayIndex，以及不
要出现数字编号命名，如：value1，value2…
5)、如果变量名过长可以使用单词缩写，除了被广泛了解的单词缩写以外，所有使用
单词缩写的变量名必须在定义时给出注释，如：
6)、参数变量命名必须加前缀：p_。
7)、function命名规范：使用动词+名词的方式，并且命名需要明确指出其作用，动
词前缀必须是同函数功能相关的完整动词，如getUserId（），用来取用户Id。
8)、所有命名使用小驼峰命名法：第一个单词全部使用小写，其他单词首字母大写，
如：myClassName。
四、css样式规范
4.1、css样式文件命名规范
4.1.1、通用样式文件命名规范：
1)、整个项目通用的css布局样式文件命名为：layout.css。
如：通过于整个网站中使用的div、h1、img等的定义文件。
2)、对引用的开源css样式重定义的文件命名为：开源的css样式文件名-reset.css
如：bootstrap.css为引用的css样式文件，现在对它的.btn重新定义样式内容，这类样式的文件名命名为：开源的css样式文件名-reset.css。
一个项目建议最多使用一个css框架。
3)、外部引用的字体css样式文件命名为：font-加引用的字体名字.css，若有多个
字体引用则使用：font-style.css。
4)、自定义的响应式布局样式命名为：项目名称缩写–responsive.css。
5)、跨项目通用功能定义的css样式文件命名为：实现的功能.css。
6)、为IE浏览器做兼容处理的样式命名为：ie-版本号.css。
4.1.2、业务类样式文件命名规范
自定义的样式统一定义在一个文件内，文件命名为：项目名称-style.css。
4.1.3、css样式文件命名须知
1)、以上所有的css样式文件命名必须是小写字母，不允许中文、大写字母及其他特
殊字符等。如果有样式版本共存或更新需要保留老版本样式，请在样式文件名后面
加上“-版本号”，最新版本样式文件除外，同样版本号只允许是数字或小写字母。
2)、以上css文件命名制定的规范只适用普遍的情况，特殊情况下请开发人员根据实
际情况自行命名，但必须遵行1)的规定。
4.2、css样式文件存放目录规范
项目文件存放目录将在后面说明，此处只针对css样式文件存放规定。
1)、字体样式文件存放文件夹：/font/，包括字体的源文件。
2)、引用的样式保持原来的目录结构，如果有多个引用的样式则按功能新建文件夹来
分别存放。
3)、其他样式文件不用单独新建文件夹。
4.3、css样式定义规范
4.3.1、css样式内容顶部注释规范
1)、请使用utf-8编码。
2)、申明css定义的内容概述或目的，申明编写的人员、更新日期。
3)、请谨慎使用@import url(……)引入其他css样式文件。
4.3.2、css样式内容注释规范
1)、模块注释必须单独写在一行，简要说明模块的功能。
2)、单行注释可以写在单独一行，也可以写在行尾，注释中的每一行长度不超过30
个汉字，或者60个英文字符。
3)、多行注释必须写在单独行内，即/*后换行写注释，*/单独写一行。
4)、用于标注修改、待办等信息的注释以单行注释为基准。
5)、对一个代码区块注释（可选），将样式语句分区块并在新行中对其注释。
4.3.3、css样式定义规范
1)、使用有意义的或通用的id和class命名：id和class的命名应反映该元素的功
能或使用通用名称，而不要用抽象的晦涩的命名。反映元素的使用目的是首选；使
用通用名称代表该元素不表特定意义，与其同级元素无异，通常是用于辅助命名；
使用功能性或通用的名称可以更适用于文档或模版变化的情况。
2)、id和class命名越简短越好，只要足够表达涵义。这样既有助于理解，也能提
高代码效率。
3)、常用命名（多记多查英文单词）：page、wrap、layout、header(head)、footer(foot、
ft)、 content(cont)、menu、nav、main、submain、sidebar(side)、logo、banner、
title(tit)、popo(pop)、icon、note、btn、txt、iblock、window(win)、tips
等。
4)、类型选择器避免同时使用标签、id和class作为定位一个元素选择器，可以使
用class层级来代替。
5)、规则命名中，一律采用小写加中划线的方式，不允许使用大写字母或下划线。
6)、命名避免使用中文拼音，应该采用更简明有语义的英文单词进行组合。
7)、命名注意缩写，但是不能盲目缩写，具体请参见常用的CSS命名规则。
8)、不允许通过1、2、3等序号进行命名，避免class与id重名。
9)、id用于标识模块或页面的某一个父容器区域，名称必须唯一，不要随意新建id。
10)、class用于标识某一个类型的对象，命名必须言简意赅，尽可能提高代码模块的
复用，样式尽量用组合的方式。
4.3.4、css样式常用id的命名
1)、页面结构命名
2)、导航命名
3)、功能命名
以上样式定义须符合css样式定义规范。
4.3.5、css样式常用class的命名
1)、颜色：单独定义颜色时使用颜色的名称，复合颜色用中划线连接。如：.blue
或.blue-green。
2)、字体大小：单独定义时使用font-字号；如：.font-12。
3)、对齐样式：使用对齐目标的英文名称。如：.left。
4)、其他样式：功能缩写-当前的作用区域；如果有多层级，则下一层级定义为：上
一级的样式名-目标区块命名；在嵌入其他门户网站中的应用，如果门户网站没有
特别规定，为了避免样式冲突必须为每一个样式加上前缀，前缀可以按实际情况来
设置。
4.4、css样式书写规范
4.4.1、css样式排版规范
1)、使用一次tab键或者4个空格作为缩进。
2)、规则可以写成单行，或者多行，但是整个文件内的规则排版必须统一。
3)、对于可以发布的网站样式建议进行压缩，直接使用网上的css格式化工具进行压
缩。
4.4.2、css样式书写风格规范
1)、如果是在html页面中定义的css样式，则必须写成单行，不建议在html页面中
定义css样式。
2)、每一条规则的大括号 { 前后加空格，每一条规则结束的大括号 } 前加空格。
3)、属性名冒号之前不加空格，冒号之后加空格。
4)、每一个属性值后必须添加分号; 并且分号后空格。
5)、多个selector共用一个样式集，10个以内的selector必须写成多行形式，10
个以上的selector写成一行。
6)、多行书写时每一条规则结束的大括号 } 必须与规则选择器的第一个字符对齐。
4.4.3、css样式属性定义顺序规范
1)、显示属性：display/list-style/position/float/clear …。
2)、自身属性（盒模型）：width/height/margin/padding/border。
3)、背景：background；行高：line-height。
4)文本属性：color/font/text-decoration/text-align/text-indent/ white-space。
5)、其他：cursor/z-index/zoom/overflow。
6)、CSS3属性：transform/transition/animation/box-shadow/border-radius。
7)、使用CSS3的属性，如果有必要加入浏览器前缀，则按照 -webkit- / -moz- / -ms-
/ -o-的顺序进行添加，标准属性写在最后。
8)、属性定义顺序规范不作严格要求，但在使用css3时最好加上前缀。
4.4.4、css样式其他规范
1)、使用单引号，不允许使用双引号。
2)、每个声明结束都应该带一个分号，不管是不是最后一个声明。
3)、除16进制颜色和字体设置外，CSS文件中的所有的代码都应该小写。
4)、选择器应该在满足功能的基础上尽量简短，减少选择器嵌套，查询消耗。但是一
定要避免覆盖全局样式设置。
5)、background、font、margin、padding、border等可以缩写的属性，尽量使用缩
写形式。
6)、在css中谨慎使用*选择符。
7)、除非必须，否则，一般有class或id的，不需要再写上元素对应的tag。
8)、0后面不需要单位，比如0px可以省略成0，0.8px可以省略成.8px。
9)、如果是16进制表示颜色，则颜色取值字母应该大写；如果可以，颜色尽量用三
位字符表示，例如#AABBCC写成#ABC。
10)、如果没有边框时，不要写成border:0，应该写成border:none。
11)、在保持代码解耦的前提下，尽量合并重复的样式。
12)、除了重置浏览器默认样式外，禁止直接为html tag添加css样式设置。
4.4.5、css样式 Hack的使用
Css hack仅仅是为了兼容浏览器对css的解析而设置，请不要使用浏览器检测和CSS Hacks作为解决浏览器解析差异的首选方式，但应被视为最后的手段。允许使用hack只会带来更多的hack，你越是使用它，你越是会依赖它。
4.4.6、字体定义规范
1)、为了防止文件合并及编码转换时造成问题，建议将样式中文字体名字改成对应的
英文名字，如：黑体(SimHei) 、宋体(SimSun)、微软雅黑 (Microsoft Yahei，几
个单词中间有空格组成的必须加引号)，详细介绍参详附件。
2)、字体粗细采用具体数值，粗体bold写为700，正常normal写为400。
3)、font-size必须以px或pt为单位，推荐用px（注：pt为打印版字体大小设置），
不允许使用small/medium/large/x-large/xx-large等不确定的值。
4)、为了对font-family取值进行统一，更好的支持各个操作系统上各个浏览器的兼
容性，font-family不允许在业务代码中随意设置。
4.4.7、css样式检测
写好一份css样式文件之后，如果不完全确定定义是否符合W3C标准，可借助在线检测工具来检测。常用的测试工具：W3C CSS validator、CSS Lint等不限制。
WEB前端代码规范 规范目的 为提高团队协作效率，便于后台人员添加功能及前端后期优化维护，输出高质量的文档，特制订此文档。本规范文档一经确认，前端开发人员必须按本文档规范进行前台页面开发。本文档如有不对或者不合适的地方请及时提出，经讨论决定后方可更改。 基本准则 符合web标准；语义化html；结构、表现、行为分离；兼容性优良。页面性能方面，代码要求简洁明了有序，尽可能的减小服务器负载，保证最快的解析速度。 文件规范
3.jsp文件命名：英文驼峰式命名，文件名.jsp。按实际模块需求命名。 4.css文件命名：英文驼峰式命名，文件名.css。共用base.css，首页index.css，其他 页面按实际模块需求命名。 5.js文件命名：英文驼峰式命名，文件名.js。共用common.js，其他依实际模块需求命 名。 html书写规范 1.文档类型声明及编码：统一为html5的声明类型；编码统一为 ，书写时利用IDE实现层次分明的缩进。 2.非特殊情况下css文件必须在
...之间引入，选择link方式引入而非 @import形式。 3.非特殊情况下js文件必须在页面底部引入。 4.引入样式文件或JavaScript文件时，须略去默认类型声明，写法如下：11.语义化html，如标题根据重要性用h1-h6(同一页面只能有一个h1)，段落标记用p，列表 用ul，内联元素中不可嵌套块状元素。 12.尽可能减少div的嵌套层数。 13.在页面中尽量避免使用内嵌样式表，即在标签内使用style="…"。 14.以背景形式呈现的图片，尽量写入css样式中；重要图片必须加上alt属性； 15.特殊符号使用：尽可能使用代码替代：比如<(<)、>(>)、空格( )、&(&)、 ”（"）等等； 16.尽量避免使用过度复杂的HTML结构。 css书写规范 1.编码统一为utf-8。 2.为了避免一些浏览器兼容性问题以及增加样式重用性，每个页面必须引入base.css（详见 附件一），此文件不可随意修改。 3.class与id的使用：id是唯一的并是父级的，class是可以重复的并是子级的，所以id 仅使用在大的模块上，class可用在重复使用率高及子级中。 4.为JavaScript预留钩子的命名，请以js_起始，比如：js_hide，js_show。 5.class与id命名：使用英文命名，命名要语义化，简明化，但不要使用诸如first，last 之类的命名。使用驼峰式和下划线分隔相结合的命名规则，即命名应以父级加子级的命名规范，如：父级的类为simple 子级的类应该为simple_first，以此类推，但是尽量避免出现超过四级的类命名。 6.css属性书写顺序，建议遵循：自身属性-->布局定位属性-->文本属性-->其他属性。此条 可根据自身习惯书写，但尽量保证同类属性写在一起。
软件开发过程管理规范文件管理序列号：[K8UY-K9IO69-O6M243-OL889-F88688]
0 引言 如果要提高软件开发人员的开发质量，必须有相应的考核制度，有了制度后才能推动开发人员想方设法改善自已的开发质量。目前研发对软件开发的过程缺乏细粒度的度量，所以不能依据有效的度量数据来考核开发人员的工作绩效，大部份只是凭考核人主观意志来考核，不能形成对被考核人有效的说服力。此绩效考核办法旨在结合实际情况合理客观地评价开发效率和质量。 1 目的 对软件开发的过程所产生的软件项的质量和过程进行定量的评价，用评价的结果指导软件的开发过程，不断地提高软件开发质量水平，并依据度量记录来考核软件开发人员的工作绩效。 2 软件项包括 1）技术文档：主要包括：可行性分析报告、需求分析报告、软件功能规格说明、开发计划、系统设计报告、测试文档、用户手册、总结报告等； 2）计算机程序。 3 度量数据的来源 1）项目计划； 2）评审报告； 3）测试报告； 4）问题报告； 5）软件维护记录； 4 质量度量
4.1 度量指标 主要根据各类软件项检查表的检查指标来确定，例如，软件需求规格说明书检查表（见附录1），有10个检查指标，则根据具体项目检查侧重点不同，可从中选择相应的检查指标作为度量指标。 4.2 质量等级 1）软件项的质量等级的确定根据度量综合指标进行。 2）度量综合指标计算公式为：Total = ∑QiMi。 3）其中i=1,2,...n代表指标数量； 4）Q代表度量的指标； 5）M代表度量的指标Q在整个指标体系中所占的权重系数，对不同的开发项目可能不同，此系数根据开发的不同着重点给出。 度量指标权重系数表： 序号指标权重 1 指标1 权数1 2 指标2 权数2 3 指标3 权数3 4 指标4 权数4 5 指标5 权数5 加权平均分 1.0 6）质量评价：一般地，根据度量综合指标值，有以下评分标准。 质量评价计分标准表 序号得分质量评价
231 GB 8567－88软件开发主要文档编写规范 本附录中列出了《计算机软件产品开发文件编制指南》GB 8567－88中主要软件文档的编写说明，供编写时参考。这些文档主要是：可行性研究报告、项目开发计划、软件需求说明书、概要设计说明书、详细设计说明书、模块开发卷宗、测试计划、测试分析报告、项目开发总结报告。 一、可行性研究报告 l 引言 1.1 编写目的 说明：说明本可行性研究报告的编写目的，指出预期的读者。 1.2 背景 说明： a ．所建议开发的软件系统的名称。 b ．本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络。 c ．该软件系统同其他系统或其他机构的基本的相互来往关系。 1.3 定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4 参考资料 列出用得着的参考资料，如： a ．本项目的经核准的计划任务书或合同、上级机关的批文。 b ．属干本项目的其他已发表的文件。 c. 本文件中各处引用的文件、资料，包括所需用到的软件开发标准。 列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 2 可行性研究的前提 说明对建议开发项目进行可行性研究的前提，如要求、目标、条件、假定和限制等。 2.1 要求 说明对所建议开发软件的基本要求，如： a ．功能。 b ．性能。 c ．输出如报告、文件或数据，对每项输出要说明其特征，如用途、产生频度、接口以及分发对象。 d. 输入说明。系统的输入包括数据的来源、类型、数量、数据的组织以及提供的频度。 e ．处理流程和数据流程。用图表的方式表示出最基本的数据流程和处理流程，并输之以叙述。 f. 在安全与保密方面的要求。 g. 同本系统相连接的其他系统。 h. 完成期限。 2.2 目标 说明所建议系统的主要开发目标，如： a. 人力与设备费用的减少。 b. 处理速度的提高。 c. 控制精度或生产能力的提高。
前端开发设计规范 目录 前端开发设计规范 (1) 一、HTML使用规范 (1) 1.1、页面文件命名规范 (1) 1.2、页面head部分书写规范 (1) 1.3、HTML元素开发规范 (2) 1.3.1、HTML元素书写规范 (2) 1.3.2、HTML元素命名规范 (4) 二、WEB页面开发规范 (5) 2.1、错误跳转页面的处理 (5) 2.2、提示信息的处理 (5) 2.3、页面的返回 (5) 2.4、提交前数据的判断验证 (5) 2.5、删除操作 (6) 2.6、页面中java代码的使用 (6) 2.7、网站页面布局规范 (7) 2.7.1、前台页面尺寸 (7)
2.7.2、标准网页广告图标规格（参考） (7) 2.7.3、页面字体 (8) 2.7.4、字体颜色 (8) 三、javaScript开发规范 (9) 3.1、javaScript文件命名规范： (9) 3.2、javaScript开发规范 (9) 3.2.1、javaScript书写规范 (9) 3.2.2、javaScript命名规范 (10) 四、css样式规范 (12) 4.1、css样式文件命名规范 (12) 4.1.1、通用样式文件命名规范： (12) 4.1.2、业务类样式文件命名规范 (13) 4.1.3、css样式文件命名须知 (13) 4.2、css样式文件存放目录规范 (13) 4.3、css样式定义规范 (14) 4.3.1、css样式内容顶部注释规范 (14) 4.3.2、css样式内容注释规范 (14) 4.3.3、css样式定义规范 (15) 4.3.4、css样式常用id的命名 (17) 4.3.5、css样式常用class的命名 (18)
Web前端开发规范 参考手册 一、规范目的 1.1 概述 为提高团队协作效率，便于后台人员添加功能，及前端后期优化维护，输出高质量的文档，特制订此文档。本规范文档一经确认，前端开发人员必须按本文档规范进行前台页面开发。本文档如有不对或者不合适的地方请及时提出，经讨论决定后可以更改。 1.2 基本准则 符合web标准，语义化HTML，结构表现行为分离，兼容性优良。页面性能方面，代码要求简洁明了有序，尽可能的减小服务器负载，保证最快的解析速度。 二、规范细则 2.1 文件命名规则 文件名称统一用小写的英文字母、数字和下划线的组合，其中不得包含汉字、空格和特殊字符。命名原则的指导思想： ●一是使得工作组的每一个成员能够方便的理解每一个文件的意义。 ●二是当在文件夹中使用“按名称排例”的命令时，同一种大类的文件能够排列在一 起，以便查找、修改、替换、计算负载量等等操作。 1. HTML命名原则 ●引导文件统一使用index.htm、index.html、ndex.asp文件名（小写）。 ●各子页命名的原则首先应该以栏目名的英语翻译取单一单词为名称。例如： ?关于我们\ aboutus ?信息反馈\ feedback ?产品\ product ●如果栏目名称多而复杂并不好以英文单词命名，则统一使用该栏目名称拼音或拼音 的首字母表示；每一个目录中应该包含一个缺省的html 文件，文件名统一用 index.htm、index.html、index.asp。
2. 图片命名原则 ●图片的名称分为头尾两部分，用下划线隔开，头部分表示此图片的大类性质。例如： 广告、标志、菜单、按钮等。 ●放置在页面顶部的广告、装饰图案等长方形的图片取名：banner。 ●标志性的图片取名：logo。 ●在页面上位置不固定并且带有链接的小图片取名：button 。 ●在页面上某一个位置连续出现，性质相同的链接栏目的图片取名：menu。 ●装饰用的照片取名：pic。 ●不带链接表示标题的图片取名：title。 例如： banner_sohu.gif banner_sina.gif menu_aboutus.gif menu_job.gif title_news.gif logo_police.gif logo_national.gif pic_people.jpg ●鼠标感应效果图片命名规范为"图片名+_+on/off"。 例如： menu1_on.gif menu1_off.gif 3. Javascript命名原则 例如： ●广告条的javascript文件名为ad.js ●弹出窗口的javascript文件名为pop.js 4. 动态语言文件命名原则 以性质_描述，描述可以有多个单词，用“_”隔开，性质一般是该页面得概要。例如：register_form.asp register_post.asp topic_lock.asp 2.2 文件存放位置规范 HTML、CSS、js、images文件均归档至<系统开发规范>约定的目录中。 _Root cn 存放中文HTML文件 en 存放英文HTML文件 flash 存放Flash文件 images 存放图片文件 imagestudio 存放PSD源文件
【最新资料,Word版，可自由编辑！】
目录 1.前言 (3) 1.1 目的 (3) 1.2 对象 (3) 1.3 要求 (3) 1.4 适用范围 (3) 1.5 软件开发过程模型 (3) 1.6 开发过程划分 (4) 2.技术过程规范部分 (4) 2.1 概述 (4) 2.2 业务建模阶段 (4) 2.3 需求阶段 (6) 2.4 分析设计阶段 (8) 2.5 实现阶段 (10) 3.管理过程规范部分 (11) 3.1 概述 (11) 3.2 接受项目 (12) 3.3 重新评估项目范围和风险（对于较大项目） (12) 3.4 制定开发计划 (13) 3.5 迭代开发管理 (13) 3.6 监控项目的实施 (14) 3.7 结束项目 (15)
软件开发过程规范 前言 目的 本规范的目的是使整个软件产品开发及项目工程阶段清晰，要求明确，任务具体，便于规范化、系统化及工程化。有利于提高软件生命周期的控制及管理，提高所开发软件的质量，缩短开发时间，减少开发和维护费用，使软件开发活动更科学、更有成效。 对象 本规范面向产品生命周期的所有相关人员，包括管理人员、开发人员、质管人员。 要求 具有软件开发管理职能的人员要求熟知项目开发的各阶段过程和各阶段过程相应的规范。 适用范围 适用于产品开发生命周期中的除产品提交外的其他全部过程；规范分为两部分：技术过程规范和管理过程规范，分别适用于软件开发过程中的技术性活动和管理性活动。 软件开发过程模型 本规范所采用的软件开发过程模型为简化的RUP开发过程模型；软件开发过程是体系结构为中心，用例驱动和风险驱动相结合的过程迭代。
附2: 软件文档编写向导 文档分类 项目包括如下几类文档： 项目管理文档。包括：《软件项目计划》、《项目进度报告》、《项目开发总结报告》 软件开发文档。包括：《需求规格说明》、《概要设计说明》、《详细设计说明》、《测试计划》、《软件测试分析报告》。 产品文档。包括：《用户操作手册》《演示文件》。 软件项目计划 （Software Project Plan） 一?引言 1?编写目的（阐明编写软件计划的目的，指出读者对象。） 2?项目背景（可包括：（1 ）项目委托单位、开发单位和主管部门；（2）该软件系统与 其他系统的关系。） 3?定义（列出本文档中用到的专门术语的定义和缩略词的原文。） 4?参考资料（可包括：文档所引用的资料、规范等；列出资料的作者、标题、编号、发 表日期、出版单位或资料来源。） 二?项目概述 1.工作内容（简要说明项目的各项主要工作，介绍所开发软件的功能性能等?若不编写可行性研究报告，则应在本节给出较详细的介绍。） 2.条件与限制（阐明为完成项目应具备的条件开发单位已具备的条件以及尚需创造的 条件?必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。） 3.产品 （1）程序（列出应交付的程序名称使用的语言及存储形式。） （2）文档（列出应交付的文档。） （3 ）运行环境（应包括硬件环境软件环境。） 4?服务（阐明开发单位可向用户提供的服务?如人员培训安装保修维护和其他运行支持。 5.验收标准
三.实施计划 1.任务分解（任务的划分及各项任务的负责人。） 2?进度（按阶段完成的项目，用图表说明开始时间完成时间。） 3?预算 4?关键问题（说明可能影响项目的关键问题，如设备条件技术难点或其他风险因素，并说明对策。） 四.人员组织及分工 五.交付期限 六.专题计划要点（如测试计划等。） 项目开发进度报告 一.报告时间及所处的开发阶段 二.给出进度 1.本周的主要活动 2.实际进展与计划比较 三.所用工时（按不同层次人员分别计时。） 四.所有机时 五.工作遇到的问题及采取的对策 六.本周完成的成果 七.下周的工作计划 八.特殊问题 项目开发总结报告 一.引言 1.编写目的（阐明编写总结报告的目的，指明读者对象。） 2.项目背景（说明项目的来源、委托单位、开发单位及主管部门。） 3.定义（列出报告中用到的专门术语定义和缩写词的原意。） 4.参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括： （1 ）项目开发计划；（2 ）需求规格说明书；（3 ）概要设计说明书；（4 ）详细设计说明
Web前端开发规范手册 一、规范目的 1.1 概述 (1) 二、文件规范 2.1 文件命名规则 (1) 2.2 文件存放位置 (2) 2.3 css 书写规范 (3) 2.4 html书写规范 (7) 2.5 JavaScript书写规范 (11) 2.6 图片规范 (12) 2.7 注释规范 (13) 2.8 css 浏览器兼容 (13) 一、规范目的 1.1 概述 为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发. 本文档如有不对或者不合适的地方请及时提出, 经讨论决定后可以更改此文档. 二、文件规范 2.1 文件命名规则 文件名称统一用小写的英文字母、数字和下划线的组合，其中不得包含汉字、空格和特殊字符；命名原则的指导思想一是使得你自己和工作组的每一个成员能够方便的理解每一个文件的意义，二是当我们在文件夹中使用“按名称排例”的命令时，同一种大类的文件能够排列在一起，以便我们查找、修改、替换、计算负载量等等操作。
a. HTML的命名原则 引文件统一使用index.htm index.html index.asp文件名（小写） 各子页命名的原则首先应该以栏目名的英语翻译取单一单词为名称。例如： 关于我们\ aboutus 信息反馈\ feedback 产品\ product 如果栏目名称多而复杂并不好以英文单词命名，则统一使用该栏目名称拼音或拼音的首字母表示； 每一个目录中应该包含一个缺省的html 文件，文件名统一用index.htm index.html index.asp； b. 图片的命名原则 图片的名称分为头尾两部分，用下划线隔开，头部分表示此图片的大类性质 例如：广告、标志、菜单、按钮等等。 放置在页面顶部的广告、装饰图案等长方形的图片取名：banner 标志性的图片取名为：logo 在页面上位置不固定并且带有链接的小图片我们取名为button 在页面上某一个位置连续出现，性质相同的链接栏目的图片我们取名：menu 装饰用的照片我们取名：pic 不带链接表示标题的图片我们取名：title 范例：banner_sohu.gif banner_sina.gif menu_aboutus.gif menu_job.gif title_news.gif logo_police.gif logo_national.gif pic_people.jpg 鼠标感应效果图片命名规范为"图片名+_+on/off"。 例如：menu1_on.gif menu1_off.gif c. javascript的命名原则 例如：广告条的javascript文件名为ad.js 弹出窗口的javascript文件名为pop.js d. 动态语言文件命名原则 以性质_描述，描述可以有多个单词，用“_”隔开，性质一般是该页面得概要。 范例：register_form.asp register_post.asp topic_lock.asp 2.2 文件存放位置规范 _Root cn 存放中文HTML文件 en 存放英文HTML文件 flash 存放Flash文件 images 存放图片文件 imagestudio 存放PSD源文件 flashstudio 存放flash源文件 inc 存放include文件 library 存放DW库文件 media 存放多媒体文件 project 存放工程项目资料
1、需求分析是怎样做的？（自己理解着说） 需求分析是构建软件系统的一个重要过程。 一般，把需求类型分成三个类型： 1、业务需求（business requirement）反映了组织机构或客户对系统、产品高层次的目的要求，它们在项目视图与范围文档中予以说明。 2、用户需求(user requirement) 文档描述了用户使用产品必须要完成的任务，这在使用实例文档或方案脚本说明中予以说明。 3、功能需求(functional requirement)定义了开发人员必须实现的软件功能，使得用户能完成他们的任务，从而满足了业务需求。 业务需求和用户需求是软件需求分析的基础，也是软件构建的前提。系统分析员通过对业务需求和用户需求的分解，将其转换成克一形式化描述的软件功能需求。开发软件系统最为困难的部分，就是准确说明开发什么。这就需要在开发的过程中不断的与用户进行交流与探讨,使系统更加详尽,准确到位。这就需要确定用户是否需要这样的产品类型以及获取每个用户类的需求。 4、客户也经常是矛盾的。事实上，很少有客户能够明确的知道怎样的一个系统对自己是最有益处的，他们往往在集中方案之间徘徊，于是经常产生需求的变动。生产厂商经常陷入客户自己的矛盾之中。 客户的负面影响可能对于能够在预算内按时完成项目产生很大的影响。尽管客户需要对需求的质量负责任，但是，当一个软件项目因为客户事先没有预料到的情况而导致失败的时候，即使客户不会追究开发方的责任，就软件项目本身而言，也已经是失败的。 总结： 良好的需求分析是软件成功的基础。以上是作者对需求分析工作实践的一次小结以及综合性的思考，是对需求分析本身所做的一次分析。在此基础上，作者提出了逆向沟通的设想，即系统分析员主动进行沟通，提出指导性意见。当软件融合了客户和系统分析员双方智慧，其质量将会进一步得以提高。 2、 6周 （比较合理的代码行数是多少，如果多了，我是怎么切割的）500行，例如：实现数据3、如何将用户登录的信息保存？ 用户登陆页面将每个用户的信息使用session保存下来,例如: session.setAttribute("UserID","ytang"); 如果用到用户的登陆信息，再从session根据session.getAttribute("userID")所存储的信息例如在项目1中的应用 4．软件项目开发流程应该是什么样子的？ 1。需求分析和获取； 2。界面的设计和修改，直到用户可以接受； 3。后台数据库的建立，做成几张表，写几个存储过程； 4。前台模块的编写和调试； 5。项目的实施和维护；
系统开发规范 1、数据库使用规范 1.1服务器上有关数据库的一切操作只能由服务器管理人员进行。 1.2程序中访问数据库时使用统一的用户、统一的连接文件访问数据库。 1.3原则上每一个频道只能建一个库，库名与各频道的英文名称相一致，库中再包含若干表。比较大的、重点的栏目可以考虑单独建库，库名与栏目的英文名称相一致。 1.4命名： （1）数据库、表、字段、索引、视图等一系列与数据库相关的名称必须全部使用与内容相关的英文单词命名（尽量避免使用汉语拼音），对于一个单词难以表达的，可以考虑用多个单词加下划线（_）连接（不能超过四个单词）命名。 （2）所有的名称必须统一使用英文小写字母。 （3）所有的名称起始和结尾不能使用下划线（_）。 （4）所有的名称不能包含26个英文小写字母和下划线（_）以外的其他字符。 1.5不再使用的数据库、表应删除，在删除之前必须备份（包括结构和内容）。 2、文档规范 所有的项目必须有相关的文档说明（可以是电子文档）。文档应包含如下内容： （1）项目名称。 （2）项目小组名单，项目负责人。 （3）项目开发起始时间和结束时间。 （4）项目内容描述。 （5）项目位置。（在哪个频道、哪个栏目） （6）与项目有关的程序文件名（含路径名），文件内容及实现的功能描述。 （7）完整的程序流程图。
（8）数据库、表、视图、索引的名称，用途。字段的名称、类型、长度、用途，必须附上相关的SQL语句。 3、源代码与页面嵌套规范 3.1源代码： （1）使用自定义变量（包括全局变量、局部变量）之前必须先声明变量，并用注释语句标明变量的类型、用途。 （2）自定义函数必须用注释语句标明函数的用途、参数的数据类型、意义，返回值的类型。 （3）程序中重要的过程或代码较长的过程应使用注释语句标明该过程的起始行和结束行，并注明该过程的功能。 （5）所有的注释文字一律使用简体中文。 3.2 HTML页面嵌套： （1）网页设计部设计的HTML页面以嵌套的方式确定用于动态显示程序执行结果的位置、宽度、行数（或高度）等，并在相应位置予以文字说明。页面中与程序无关的图片、文字、联结等必须使用完整的URL。 （2）软件开发人员和编辑人员可以根据情况协商，将页面文件及图片与程序独立存放在各自的服务器上，页面改版和修改程序独立进行。 （3）使用include技术将分割开的HTML页面分别嵌入程序代码中，要求做到修改HTML页面时无须改写程序，而修改程序时不会影响HTML页面效果，将页面改版和修改程序两项工作分别独立。 （4）页面和程序嵌套以后不能破坏原HTML页面的整体显示效果，字体、字号、颜色等应尽量保持原HTML页面的风格。 （5）动态生成的页面的各项指标（如图片大小、页面宽度、高度、页面文件的字节数等）应符合本公司网页设计方面的要求。 4、测试规范（软件部分） 对于较大的项目应成立相应的测试小组，小组成员由软件开发人员、网页设计人员、技术人员、
命名 命名规则对于维护代码来说是非常重要的,。Objective-C方法名往往很长，不过这也有好处，让很多注释变得毫无意义。 本文推荐驼峰法，也是Objective-C社区的标准。 驼峰法分小驼峰法和大驼峰法。小驼峰法：除第一个单词之外，其他单词首字母大写。大驼峰法相比小驼峰法，大驼峰法把第一个单词的首字母也大写了。 1.基本原则 1.1 清晰 又清晰又简洁是最好的了，但简洁不如清晰重要。总的讲不要使用单词的简写，除了非常常用的简写以外，尽量使用单词全称。API的名称不要有歧义，一看你的API就知道是以什么方式做了什么事情，不要让人有疑问 1.2 一致性 做某个事情代码通常都叫这个名字，比如tag、setStringValue，那么你也这么叫。你在不确定怎么起名字的时候，可以参考一些常用的名字：Method Arguments 2. 类命名 类名(不包括类别和协议名)应该用大写开头的大驼峰命名法。类名中应该包含一个或多个名词来说明这个类（或者类的对象）是做什么的。 在应用级别的代码里，尽量不要使用带前缀的类名。每个类都有相同的前缀不能提高可读性。不过如果是编写多个应用间的共享代码，前缀就是可接受并推荐的做法了(型如MBAPhotoBrowser )。 示例1： @interface ImageBrowseView :UIView @end 示例2：（带前缀MBA） @interface MBAPhotoBrowser :UIView @end
3. 类别命名 类名+标识+扩展（UIImageView +HP+Web） 例：如果我们想要创建一个基于UIImageView的类别用于网络请求图片，我们应该把类别 放到名字是UIImageView+HPWeb.h的文件里。UIImageView为要扩展的类名，HP为专属标识，Web为扩展的功能。 类别的方法应该都使用一个前缀(型如hp_myCategoryMethodOnAString ),以防止Objective- C代码在单名空间里冲突。如果代码本来就不考虑共享或在不同的地址空间(address- space)，方法命名规则就没必要恪守了。 类别HPWeb头文件，UIImageView+HPWeb.h如下： @interface UIImageView (HPWeb) - (void)hp_setImageWithURLString:(NSString *)urlStr; @end 4. 方法命名 方法使用小驼峰法命名, 一个规范的方法读起来应该像一句完整的话，读过之后便知函数 的作用。执行性的方法应该以动词开头，小写字母开头，返回性的方法应该以返回的内容 开头，但之前不要加get。 示例： - (void)replaceObjectAtIndex:(NSUInteger)index withObject:(id)anObject; (instancetype)arrayWithArray:(NSArray *)array;
Web前端开发规范手册 修订历史记录 日期版本说明作者 2012年12月31日 1.0初稿施昀 2012年01月05日 1.1施昀、戴静2012年01月07日 1.2施昀 目录 修订历史记录 (1) 一、规范目的 (2) 1.1概述 (2) 二、基本准则 (2) 三、文件规范 (3) 2.1文件命名规则 (3) 2.1.1HTML的命名原则 (3) 2.1.2图片的命名原则 (3) 2.1.3.javascript的命名原则 (4) 2.1.4动态语言文件命名原则 (4) 2.2文件存放位置规范 (4) 2.3CSS书写规范 (4) 2.3.1基本原则 (4)
2.3.2注意细则 (5) 2.3.3命名规则 (6) 2.4html书写规范 (9) 2.4.1head区代码规范 (9) 2.4.2body区代码规范 (10) 2.5JavaScript书写规范 (10) 2.6图片规范 (10) 2.7注释规范 (11) 2.7.1html注释 (11) 2.7.2css注释 (11) 2.7.3JavaScript注释 (11) 四、执行模式 (12) 一、规范目的 1.1概述 提高团队协作效率 便于前端开发以及后期优化维护 方便新进的成员快速上手 输出高质量的代码 本规范文档一经确认,前端开发人员必须按本文档规范进行前台页面开发。本文档如有不对或者不合适的地方请及时提出，经讨论决定后可以更新此文档。 二、基本准则 符合web标准,语义化html,结构表现行为分离,兼容性优良。 代码要求简洁明了有序,尽可能的减小服务器负载,保证最快的解析速度。
开发时需要遵循如上基本准则，特殊情况可以有所宽限，如一些老项目的页面改造。 三、文件规范 2.1文件命名规则 [使用场景：在新建网页、图片、脚本、CSS文件时，根据此规则给文件命名并放入指定位置] 文件名称统一用小写的英文字母、数字和下划线的组合，其中不得包含汉字空格和特殊字符。命名原则的指导思想一是使得你自己和工作组的每一个成员能够方便的理解每一个文件的意义，二是当我们在文件夹中使用“按名称排例”的命令时，同一种大类的文件能够排列在一起，以便我们查找、修改、替换、计算负载量等等操作。 2.1.1HTML的命名原则 索引文件统一使用index.htm index.html index.asp文件名。 如果栏目名称多而复杂并不好以英文单词命名，则统一使用该栏目名称拼音或拼音的首字母表示。 每一个目录中应该包含一个缺省的html文件，文件名统一用index.htm index.html index.asp。 2.1.2图片的命名原则 图片的名称分为头尾两部分，用下划线隔开，头部分表示此图片的大类性质。 例如：广告、标志、菜单、按钮等等。 放置在页面顶部的广告、装饰图案等长方形的图片取名：banner 标志性的图片取名为：logo 在页面上位置不固定并且带有链接的小图片我们取名为button 在页面上某一个位置连续出现，性质相同的链接栏目的图片我们取名：menu 装饰用的照片我们取名：pic 不带链接表示标题的图片我们取名：title 范例：banner_sohu.gif banner_sina.gif menu_aboutus.gif menu_job.gif title_news.gif logo_police.gif logo_national.gif pic_people.jpg
标准的软件开发过程 软件开发的标准过程包括六个阶段，而六个阶段需要编写的各类文件达14种之多，在每个阶段需要编写哪些文件，以及这些文件的主要内容见下： 1.可行性与计划研究阶段 可行性研究报告：在可行性研究与计划阶段内，要确定该软件的开发目标和总的要求，要进行可行性分析、投资一收益分析、制订开发计划，并完成应编制的文件。 项目开发计划：编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度、所需经费预算、所需软、硬件条件等问题作出的安排记载下来，以便根据本计划开展和检查本项目的开发工作。 2.需求分析阶段 软件需求说明书：软件需求说明书的编制是为了使用户和软件开发者双方对该软件的初始规定有一个共同的理解，使之成为整个开发工作的基础。内容包括对功能的规定对性能的规定等。 数据要求说明书：数据要求说明书的编制目的是为了向整个开发时期提供关于被处理数据的描述和数据采集要求的技术信息。 初步的用户手册：用户手册的编制是要使用非专门术语的语言，充分地描述该软件系统所具有的功能及基本的使用方法。使用户（或潜在用户）通过本手册能够了解该软件的用途，并且能够确定在什么情况下，如何使用它。 3.设计阶段 概要设计说明书：概要设计说明书又可称系统设计说明书，这里所说的系统是指程序系统。 编制的目的是说明对程序系统的设计考虑，包括程序系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计。运行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。
详细设计说明书：详细设计说明书又可称程序设计说明书。编制目的是说明一个软件系统各个层次中的每一个程序（每个模块或子程序）的设计考虑，如果一个软件系统比较简单，层次很少，本文件可以不单独编写，有关内容合并入概要设计说明书。 数据库设计说明书：数据库设计说明书的编制目的是对于设计中的数据库的所有标识、逻辑结构和物理结构作出具体的设计规定。 测试计划初稿：这里所说的测试，主要是指整个程序系统的组装测试和确认测试。本文件的编制是为了提供一个对该软件的测试计划，包括对每项测试活动的内容、进度安排、设计考虑、测试数据的整理方法及评价准则。4.实现阶段 模块开发卷宗（开始编写）：模块开发卷宗是在模块开发过程中逐步编写出来的，每完成一个模块或一组密切相关的模块的复审时编写一份，应该把所有的模块开发卷宗汇集在一起。 编写的目的是记录和汇总低层次开发的进度和结果，以便于对整个模块开发工作的管理和复审，并为将来的维护提供非常有用的技术信息。 用户手册完工 操作手册：操作手册的编制是为了向操作人员提供该软件每一个运行的具体过程和有关知识，包括操作方法的细节。 测试计划终稿： 5.测试阶段 模块开发卷宗(此阶段内必须完成) 测试分析报告：测试分析报告的编写是为了把组装测试和确认测试的结果、发现及分析写成文件加以记载。 项目开发总结报告：项目开发总结报告的编制是为了总结本项目开发工作的经验，说明实际取得的开发结果以及对整个开发工作的各个方面的评价。
软件项目开发计划规范 1 引言 1.1编写目的 ? 阐明开发本软件的目的； ? 说明编写这份项目开发计划的目的； ? 指明软件需求说明书所预期的读者。 1.2背景 ? 表示待开发的软件系统的名称、代码； ? 列出本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络； ? C.说明该软件系统同其他系统或其他机构的基本的相互来往关系。 1.3定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4参考资料 列出用得着的参考资料，如： a．本项目的经核准的计划任务书或合同、上级机关的批文； b．属于本项目的其他已发表的文件； c．本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 2 项目概述 2.1 工作内容 简要地说明在本项目的开发中须进行的各项主要工作。 2.2主要参加人员 扼要说明参加本项目开发工作的主要人员的情况，包括他们的技术水平。 2.3产品 2.3.1程序 列出需移交给用户的程序的名称、所用的编程语言及存储程序的媒体形式，并通过引用有关文件，逐项说明其功能和能力。 2.3.2文件 列出需移交给用户的每种文件的名称及内容要点。 2.3.3服务 列出需向用户提供的各项服务，如培训安装、维护和运行支持等，应逐项规定开始日期、所提供支持的级别和服务的期限。 2.3.4非移交的产品 说明开发集体应向本单位交出但不必向用户移交的产品（文件甚至某些程序）。 2.4验收标准 对于上述这些应交出的产品和服务，逐项说明或引用资料说明验收标准。 2.5完成项目的员迟用限 2.6本计划的批准者和批准日期 3实施计划 3.1工作任务的分门与人员分工
WEB前端开发规范文档+CSS命名规范 规范目的 为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发. 本文档如有不对或者不合适的地方请及时提出, 经讨论决定后方可更改. 基本准则 符合web标准, 语义化html, 结构表现行为分离, 兼容性优良. 页面性能方面, 代码要求简洁明了有序, 尽可能的减小服务器负载, 保证最快的解析速度. 文件规范 1. html, css, js, images文件均归档至<系统开发规范>约定的目录中; 2. html文件命名: 英文命名, 后缀.htm. 同时将对应界面稿放于同目录中, 若界面稿命名为中文, 请重命名与html文件同名, 以方便后端添加功能时查找对应页面; 3. css文件命名: 英文命名, 后缀.css. 共用base.css, 首页index.css, 其他页面依实际模块需求命名.; 4. Js文件命名: 英文命名, 后缀.js. 共用common.js, 其他依实际模块需求命名. html书写规范 1. 文档类型声明及编码: 统一为html5声明类型; 编码统一为, 书写时利用IDE实现层次分明的缩进; 2. 非特殊情况下样式文件必须外链至
...之间;非特殊情况下JavaScript文件必须外链至页面底部; 3. 引入样式文件或JavaScript文件时, 须略去默认类型声明, 写法如下: Example Source Code [https://www.doczj.com/doc/653530644.html,]软件项目开发和管理规范 本文阐述软件项目开发和管理的流程规范，作为软件项目开发的高级指引，本规范定义了软件开发的各个阶段以及每个阶段的工作活动和工件，但不对活动和工件的细节作过多规定。在项目开发过程中，每个项目根据自身的需要确定这些活动和工件的细节。 项目阶段 图2-1 项目开发的五个阶段 ?启动阶段 这个阶段的工作目的是决定一个项目是否需要启动。为了达到这个目的，首先要明确项目的总体战略目标，对项目的需要建立认同。即确定到底需要做什么、开发什么产品或提供什么服务，以及需要解决什么样的问题和需要满足客户或市场的什么要求等，同时还要总结项目工作的范围、所需资源、大约开支、各种风险，以及该项目不执行的其他替代选择等。这些代表了对整个项目目标从战略角度和宏观层次所进行的分析，通过项目的意向书总结出来，由此确证客户或项目发起人和赞助者的要求与期望，并帮助他们判定项目是否上马。项目意向总结书的通过及项目被批准上马形成了这个项目的起始点。 ?计划阶段 这个阶段的工作是为整个项目做计划。项目开始后，首先要确定项目的具体范围，明确定出项目到底要做什么，总结、归纳并定出产品的功能。然后进一步制定项目的计划，列出每项具体工作，并建立所有工作任务的重要性及顺序；确定每项工作的执行人和所需资源；根据人员的配置和能力设定各项工作和整个项目的完成时间表。 ?执行阶段
这个阶段的工作是通过执行项目的计划来完成项目的任务。它包括落实一切所需资源，如：人员、设备、费用、技术、信息，由管理者领导全体项目参与者开展各项工作。同时跟踪各项具体工作和整个项目的进度，定期向全体项目人员及项目的发起人报告项目状态。 ?控制阶段 这个阶段的工作是确证项目工作的结果符合项目的计划。它通过对项目结果的衡量和审核，与项目计划所期望的结果进行比较，找出实际结果与计划的差别，并制定处理措施。这个阶段的工作还包括对项目进程中出现的任何更改要求进行审核和批准。同时调解项目进程中出现的各种问题，如：对缺乏的资源的补偿调节；对项目的进度表及各项具体工作的优先级或顺序的修订。 ?结束阶段 这个阶段的工作是确保项目的最终结果或提交物达到计划的要求，并对完成的结果作可接受的确认。还包括在项目完成之后的收尾工作，对整个项目的经历进行总结，修订项目文档，用户培训等。 阶段完成标志 在项目开发过程中，当一个阶段完成后才会开展下一个阶段的工作；另外，“某个阶段完成”通常被定义为项目的一个里程碑，里程碑标识了项目的进度，它是项目开发和控制的重要参考，对整个项目有重要的意义。因此，“确证某个阶段是否已经完成”的工作非常有重要。 ?每一个阶段的结束以它特定任务的完成为象征 只有当某个阶段中被规定的所有工作任务都完成了，这个阶段才算真正结束，整个项目才可以进入到下一个阶段中去。反过来说，要是阶段中某个任务没有全部完成，按照项目的定义，整个阶段就不能算是完成，因此项目就不能进入到下一个阶段去。 ?衡量阶段结束的工作结果必须是实在的交付品 阶段中的任务是否完成是透过任务活动中产生的交付品来体现的，交付品必须是可交付的、非抽象的、实质的并且可以通过用衡量的方法来判断是否真正地完成了的具体事物。如：某一阶段的完成是以建造一个样品或完成某分文件作为象征。任何项目阶段的结束，都应该有这样的实质性东西的完成作为象征。 ?跨阶段的进程以阶段结尾的合格验证和审核来决定 当一个阶段结束时，在进入到下一个阶段之前所需要做的工作应包括对交付品进行合格验证，并检查这一阶段的工作质量和效率，由此判断是否可以进入到下一个阶段。这些检验象征了一个阶段的结尾终点，表示项目的进程离开了上一个阶段而进入了下一个阶段。
软件开发技术文档编写规范 在项目开发过程中，应该按要求编写好十三种文档，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。 ◇可行性分析报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。 ◇项目开发计划：为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。 ◇软件需求说明书（软件规格说明书）：对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。 ◇概要设计说明书：该说明书是概要实际阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计提供基础。 ◇详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。 ◇用户操作手册：本手册详细描述软件的功能、性能和用户界面，使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。 ◇测试计划：为做好集成测试和验收测试，需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。 ◇测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明，对测试结果加以分析，并提出测试的结论意见。 ◇开发进度月报：该月报系软件人员按月向管理部门提交的项目进展情况报告，报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。 ◇项目开发总结报告：软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力，此外，还需对开发工作做出评价，总结出经验和教训。 ◇软件维护手册：主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明，便于软件的维护。 ◇软件问题报告：指出软件问题的登记情况，如日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。 ◇软件修改报告：软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影响作出详细的描述，提交审批。 1可行性分析报告 1 引言 1.1 编写目的：阐明编写可行性研究报告的目的，提出读者对象。