研发指导手册

****研发指导手册内部专用第一版2016年12月15日***编目录编写说明...........................................................................................................................................3技术指导...........................................................................................................................................4研发流程...........................................................................................................................................5开发规范...........................................................................................................................................7小结................................................................................................................................................10编写说明此指导手册为内部制定并使用的研发部日常工作指导手册。为规范以后的研发工作，制定研发部内部行为准则和工作规范。确定研发工作流程，制定技术指标。为以后的研发工作规范行为，减少不必要的工作。此指导手册为参考手册研发部员工应严格遵守，执行。后期根据实际情况及时进行修改或重编。技术指导当前研发以windows平台为主，采用java语言开发。以关系型数据库为主，采用sql数据库操作语言。编程开发工具为IDEA,数据库根据客户实际需求。如客户没有具体要求以oracle为主，mysql为辅。研发框架以现有框架为主，期间根据实际需求进行修改。项目通过git管理工具进行统一管理。数据库采用建模工具进行建模，模型生成数据库脚本，创建数据库。数据库一律不允许手动创建。页面设计目前没有专门的前台设计，由编程人员自行复杂，制作。代码测试由研发人员自行处理，研发完成后测试人员进行统一功能测试，测试结果出具文档说明，及时修改。研发完成后实施人员像出具实施方案，根据客户意见进行实施。实施后进行业务测试和安全测试，安全测试如有必要请第三方进行测试和修补。系统漏洞早发现，早处理，严格遵守指导要求，避免不必要错误。研发过程中所有流程均做文档保留记录。所有人员定时通过邮件汇报工作进度。研发流程研发团队应严格遵循以下研发流程，保证研发进度。一．前期调研当确定研发任务后需要进行前期调研，安排人员到客户现场收集客户意见，对系统应用场景进行现场考察，确定用户需求和研发工作。二．系统功能设计根据调研结果确定系统模块，根据系统应用场景制定业务流程。功能设计应满足高内聚低耦合的标准。三．数据库设计使用建模工具进行建模，建模后根据模型生成数据库。原则上不允许手动创建数据库表。数据库设计要遵循以下几个原则1.弄清楚将要开发的应用程序是什么性质的（OLTP还是OPAP）2.将数据按照逻辑意义分成不同的块3.不要过度使用“规则2”4.把重复、不统一的数据当成你最大的敌人来对待5.当心被分隔符分割的数据，它们违反了“字段不可再分”6.规则6：当心那些仅仅部分依赖主键的列7.仔细地选择派生列8.如果性能是关键，不要固执地去避免冗余9.多维数据是各种不同数据的聚合10.将那些具有“名值表”特点的表统一起来设计11.无限分级结构的数据，引用自己的主键作为外键四．系统开发开发阶段人员每天填写日志，发送邮件汇报工作进度。每星期制定工作计划。每人负责不同模块，不允许工作交叉。如果遇到问题及时沟通解决问题，原则上当天任务遇到问题在1小时内无法解决就向其他人寻求帮助。五．系统测试开发阶段为自测阶段，由开发人员自行测试。保证在交由测试人员前系统能够正常运行，基本模块完整，功能运行无错误，后台没有错误提示。测试人员进行功能测试对系统功能和业务流程进行测试。测试开始前指定测试文档，根据文档进行测试，测试完成后出具测试报告。开发人员根据测试报告对系统进行修改。此测试要保证快速准确，系统实施前测试人员至少进行2次全面测试，并出具测试报告。六．项目部署实施人员在实施前和客户联系并制定实施报告，保证到现场前设备准备完毕，到达现场后可以直接部署。部署后需要进行漏洞检测，对服务器和系统安全进行测试。根据测试报告打补丁，修复漏洞。原则上在测试阶段对系统的漏洞检测和修复就要完成。七．系统验收实施人员完成部署后由客户验收，并出具验收报告。当验收出现问题及时沟通解决。必要时开发人员到达现场处理问题。八．客户培训具体培训方式由客户和销售人员决定。研发负责提供人员和培训所需资料，辅助完成培训。开发规范一．数据库使用规范1.服务器上有关数据库的一切操作只能由服务器管理人员进行。2.程序中访问数据库时使用统一的用户、统一的连接文件访问数据库。3.原则上每一个频道只能建一个库，库名与各频道的英文名称相一致，库中再包含若干表。比较大的、重点的栏目可以考虑单独建库，库名与栏目的英文名称相一致。4.命名：（1）数据库、表、字段、索引、视图等一系列与数据库相关的名称必须全部使用与内容相关的英文单词命名（尽量避免使用汉语拼音），对于一个单词难以表达的，可以考虑用多个单词加下划线（_）连接（不能超过四个单词）命名。（2）所有的名称必须统一使用英文小写字母。（3）所有的名称起始和结尾不能使用下划线（_）。（4）所有的名称不能包含26个英文小写字母和下划线（_）以外的其他字符。5.不再使用的数据库、表应删除，在删除之前必须备份（包括结构和内容）。二．文档规范所有的项目必须有相关的文档说明（可以是电子文档）。文档应包含如下内容：（1）项目名称。（2）项目小组名单，项目负责人。（3）项目开发起始时间和结束时间。（4）项目内容描述。（5）项目位置。（在哪个频道、哪个栏目）（6）与项目有关的程序文件名（含路径名），文件内容及实现的功能描述。（7）完整的程序流程图。（8）数据库、表、视图、索引的名称，用途。字段的名称、类型、长度、用途，必须附上相关的SQL语句。三．源代码与页面嵌套规范1.源代码：（1）使用自定义变量（包括全局变量、局部变量）之前必须先声明变量，并用注释语句标明变量的类型、用途。（2）自定义函数必须用注释语句标明函数的用途、参数的数据类型、意义，返回值的类型。（3）程序中重要的过程或代码较长的过程应使用注释语句标明该过程的起始行和结束行，并注明该过程的功能。（5）所有的注释文字一律使用简体中文。2.HTML页面嵌套：（1）网页设计部设计的HTML页面以嵌套的方式确定用于动态显示程序执行结果的位置、宽度、行数（或高度）等，并在相应位置予以文字说明。页面中与程序无关的图片、文字、联结等必须使用完整的URL。（2）软件开发人员和编辑人员可以根据情况协商，将页面文件及图片与程序独立存放在各自的服务器上，页面改版和修改程序独立进行。（3）使用include技术将分割开的HTML页面分别嵌入程序代码中，要求做到修改HTML页面时无须改写程序，而修改程序时不会影响HTML页面效果，将页面改版和修改程序两项工作分别独立。（4）页面和程序嵌套以后不能破坏原HTML页面的整体显示效果，字体、字号、颜色等应尽量保持原HTML页面的风格。（5）动态生成的页面的各项指标（如图片大小、页面宽度、高度、页面文件的字节数等）应符合本公司网页设计方面的要求。四．测试规范（软件部分）对于较大的项目应成立相应的测试小组，小组成员由软件开发人员、网页设计人员、技术人员、编辑人员组成。测试过程应参照网页设计部为该项目提供的原HTML页面进行。测试内容包括以下几点：（1）页面宽度、高度（行数）。（2）页面文字、图片、色彩是否风格统一。（3）页面的图片显示是否正常、有无变形。（4）弹出页面的效果。（5）页面的联接是否正确。（6）动态生成的页面是否符合以上几个方面的要求，页面大小（字节数，包括页面的图片、*.js、*.css、*.class等相关文件）是否符合网页设计的要求。（7）软件方面的功能是否实现。如数据库的查询、修改、删除，文件的上传、下载等操作是否正常。（8）测试结束后，根据《软件开发需求书》在《测试报告》上如实填写测试结果，包括测试通过的、未通过的，指出出错的页面和相关的程序文件，并附上测试中出现的错误信息。小结本手册仅为指导手册，为以后研发工作进行指导。实际使用时需要结合实际进行相应修改。具体研发工作以此为依据，进行研发。