oa项目命名与编码规范
软件测试编码规范
1 项目编号:项目名称首字母+项目性质(系统SYS,网站WEB,办公OA)+项目立项时间例如:湖南中铁国旅系统立项时间2014-11-11项目编号:HNZTGLSYS20141111湖南中铁国旅网站立项时间2014-11-11项目编号:HNZTGLWEB20141111市疾控OA 立项时间2014-10-15项目编号:SJKOA20141015市疾控老人体检系统立项时间2014-10-15项目编号:SJKLRTJSYS201410152 功能编号:项目编号+功能序号例如:湖南中铁国旅系统第一个功能用户登录功能编号:HNZTGLSYS20141111001湖南中铁国旅系统第五个功能添加订单功能编号:HNZTGLSYS201411110053 用例编号:功能编号+用例等级+用例序号例如:湖南中铁国旅系统第一个功能用户登录A级用例第一个用例编号:HNZTGLSYS20141111001A01湖南中铁国旅系统第五个功能添加订单B级用例第三个用例编号:HNZTGLSYS20141111005B03测试阶段描述:第一阶段集成测试代号BT 说明:初级测试阶段A级BUG少于5,BUG总数少于50,可进入下一阶段测试环境为内网内部最优环境第二阶段系统测试代号SAT 说明:中级测试阶段A级BUG不大于1,BUG总数少于10可进入下一阶段测试环境为内网通用环境压力测试(STT):多用户同步使用问题,极限用户数量使用问题安全性测试(SST):URL注入问题,数据注入问题,应急处理措施第三阶段验收测试代号UAT 说明:终极测试阶段无C级以上BUG,BUG总数少于5 可做内部评审测试环境为外网正式环境或模拟客户真实环境4 BUG编号:用例编号+测试阶段+BUG等级+BUG序号例如:湖南中铁国旅系统第一个功能用户登录A级用例第一个集成测试阶段产生A级BUG第三个BUG编号:HNZTGLSYS20141111001A01BTA003湖南中铁国旅系统第五个功能添加订单B级用例第三个系统测试阶段产生C级BUG第十个BUG编号:HNZTGLSYS20141111005B03SATC010湖南中铁国旅系统第五个功能添加订单B级用例第三个验收测试阶段产生C级BUG第十个BUG编号:HNZTGLSYS20141111005B03UATC0105 BUG等级:A B C D E6 用例数规定:(测试用例指描述测试过程期望结果,实际结果,如期望结果与实际结果不符,则产出BUG)每个项目A级用例10个(针对直观问题测试,一看就是错误的,以及界面问题)B级用例40 个(针对数据问题测试,各种正确数据,错误数据,边界数据,非空数据等)C级用例10个(针对流程,权限,状态问题测试)测试功能模板:。
项目文件编号规则(奥力)
7
PPAP文件
PF
8
人员培训
ET
9
控制发运
GP
10
采购过程
PP
11
工装及模具
MF
12
工程变更
CE
部门受控号
示例如下:
04 — 1111 001 — CP
控制计划
编号的顺序号
11年11月
PBD部门受控号
4、参考文件和相关附件:
江苏奥力威传感高科股份有限公司编号规则
附表
文件类别清单
序号
阶段文件名称
文件类别代码
备注
1
项目确定
ID
2
产品实现
PR
3
OTS文件
OF
4
过程开发
PD
5
检验与试验
IT
6
产品及过程确认
20111125文件类别清单序号123456789101112阶段文件名称项目确定产品实现ots文件过程开发检验与试验产品及过程确认ppap文件人员培训控制发运采购过程工装及模具工程变更文件类别代码idprofpditpvpfetgpppmfce备注编制
1.目的
对公司所有项目管理文件进行统一编号,达到便于识别、分类、查询等目的。
3.项目文件编号规则:
项目管理用的文件即表格、记录,除固定的表式号外还有编号,以区别不同时间、不同类别的表格、记录。其文件编号原则为:
XX —X XXX XXX — XX
二位英文字母(文件类别:具体见附表)
三位流水号(以月份为一个顺序单元)
填表日期(年份两位,月份为两位)
项目编码规范编写指南
项目编码规范1 命名规范1).包名采用域后缀倒置的加上自定义的包名,采用小写字母。
在部门内部应该规划好包名的范围,防止产生冲突。
部门内部产品使用部门的名称加上模块名称。
产品线的产品使用产品的名称加上模块的名称。
格式:com.huawei.产品名.模块名称com.huawei.部门名称. 项目名称示例:Relay模块包名 com.huawei.msg.relay通用日志模块包名 com.huawei.msg.log2). 类名和接口使用类意义完整的英文描述,每个英文单词的首字母使用大写、其余字母使用小写的大小写混合法。
示例:OrderInformation,CustomerList,LogManager,LogConfig3). 方法名使用类意义完整的英文描述:第一个单词的字母使用小写、剩余单词首字母大写其余字母小写的大小写混合法。
示例:private void calculateRate();public void addNewOrder();4). 方法中,存取属性的方法采用setter 和 getter方法,动作方法采用动词和动宾结构。
格式:get + 非布尔属性名()is + 布尔属性名()set + 属性名()动词()动词 + 宾语()示例:public String getType();public boolean isFinished();public void setVisible(boolean);public void show();public void addKeyListener(Listener);5).属性名使用意义完整的英文描述:第一个单词的字母使用小写、剩余单词首字母大写其余字母小写的大小写混合法。
属性名不能与方法名相同。
示例:private customerName;private orderNumber;private smpSession;6). 常量名使用全大写的英文描述,英文单词之间用下划线分隔开,并且使用 final static 修饰。
OA软件界面设计及编码标准规范剖析
OA系统 1.0软件界面设计及编码标准规范软件界面设计及编码标准规范项目开发相关资源命名规范1. 包的命名原则一般用com.csscis开头,然后项目所在行业,项目名称,模块简称等行业说明:电力:power,水利:water,其他根据实际情况命名...com.csscis.power.pms.ecm.pojocom.csscis.power.pms.ecm.daocom.csscis.power.pms.ecm.servicecom.csscis.power.pms.ecm.ctrl...2. Pojo类命名及实现说明Pojo类名采用数据库表名去掉_后的逻辑名,如:数据库表:SM_USERPojo类 : SmUser3. Dao接口、类命名及实现说明Dao接口采用Pojo名+Dao,Dao类采用接口名+Impl,如:Dao接口:SmUserDaoDao类:SmUserDaoImpl一般情况下,您不必编写Dao接口,因为PlatformDao接口已经足够强大,如PlatformDao接口不能满足时,再编写对应接口实现说明:Dao接口应该继承 PlatformDaoDao类应该实现 Dao接口并继承 PlatformDaoImpl如:Dao接口定义public interface SmCommonDao extends PlatformDao {}Dao实现类定义public class SmCommonDaoImpl extends PlatformDaoImpl implements SmCommonDao {}4. Service接口及类命名及实现说明Service接口采用Pojo名+Service,Service类采用接口名+Impl,如:Service接口:SmUserServiceService类:SmUserServiceImpl实现说明:Service接口应该继承 PlatformServiceService类应该实现 Service接口并继承 PlatformServiceImpl如:Service接口定义public interface SmUserService extends PlatformService {}Service实现类定义public class SmUserServiceImpl extends PlatformServiceImpl implements SmUserService {}5. Controller命名及实现说明Controller类采用功能含义+Controller,根据实际用途命名,如:用户维护功能对应的,UserController实现说明Controller类应该继承 PlatformController如:public class UserController extends PlatformController {}6. JSP页面命名及实现说明jsp采用具体含义的英文单词命名,全部为小写字母命名,可加_。
项目编码规则
项目编码规则
一、项目编码分类原则:
项目类别以事业部为划分标准。
二、项目编码规则:
(一)OA、ERP系统里的项目编码为9位。
(二)第一、二位字母:代表事业部,取自事业部拼音首字母,如图:
(三)第三至四位数字:代表年份,“10”代表2010年,“11”代表
2011年,以此类推。
(四)第五位字母:代表国际/国内项目,“W”代表国外项目,“N”代表国内项目。
(五)第六位字母:代表结算范围,“A”代表对外结算,“B”代表对内结算。
对内结算项目名称必须与其对应的对外结算项目名称一致。
(六)第七至第九位数字:流水号。
(七)9位项目编码规则如图:
例如:
“YT10NA001”表示一体化项目部2010年境内对外结算的第一个项目。
“WJ11WA009”表示完井事业部2011年境外对外结算的第九个项目。
三、项目名称命名规则:
以甲方发包、招标项目名称命名。
OA办公系统流程命名规则
协同办公管理系统命名规范说明目录一、流程分类规范 (2)二、流程命名规范 (3)三、环节命名规范 (4)四、流向命名规范 (5)五、角色命名规范 (6)六、字段命名规范 (7)一、流程分类规范通常流程可以按照所属部门或业务类型来分类:二、流程命名规范命名规则(采用按业务流程分类的命名规则):2位业务类型代码+4位流水号+“-”+流程名称例如:财务管理流程类型下面,有费用报销的审批,则其命名应为:“CW0001-费用报销”其中各字段含义如下:三、环节命名规范命名规则:[岗位/职位/角色]+环节动作例如:某流程的某环节需要采购部经理审批,那么该环节名称可以命名为:采购部经理审批;再如某流程的某环节需要总裁加签,那么该环节名称可以命名为:总裁加签,诸如此类。
常用的环节动作有:1、开始节点:拟稿、提交、发起、起草、申请、创建等。
2、中间节点:加签、接收、发布、处理、审批、审核、初审、终审、反馈、套红(公文、发文)等。
3、结束节点:完成、归档、结束等。
四、流向命名规范命名规则:谓语+[环节名称](如果下一环节为最后环节,则直接用环节名称)例如:呈交[审计总监审批],退回[申请人起草],归档常用的谓语有:a、呈交:文档流向上级领导办理b、转交:文档流向平级或下级人员办理c、退回:文档流向前面环节办理d、转发:文档流向流程环节以外人员办理e、知会:文档知会相关人员五、角色命名规范命名规则:原则上根据具体流程来命名角色。
1、流程专用角色:[流程编号]+岗位/职位2、流程公用角色:[Public]+ 岗位/职位例如:[CW001]出纳,[IT001]系统管理员,[Public]总裁。
六、字段命名规范命名规则:如果是与其他系统集成,则参考这些系统的字段名称命名,如K3、HR系统中的字段。
如果不是与其他系统集成,则按照汉语拼音或英文命名。
例如:字段“申请人”,汉语拼音方式命名为:shenqingren;英文命名方式为:proposer。
项目命名及管理规范
项目命名及管理规范一、项目命名规范项目命名是项目管理中的重要环节,规范的项目命名可以提高项目管理效率和沟通效果。
以下是项目命名的规范格式:1. 项目名称:项目名称应简洁明了,能够准确反映项目的核心内容和目标。
例如,假设我们要开展一个新的在线教育平台项目,可以将项目命名为“e学习平台”。
2. 项目代号:为了方便内部管理和沟通,可以给项目分配一个独立的代号。
代号可以由字母、数字或符号组成,长度不超过5个字符。
例如,我们可以将“e学习平台”项目的代号设定为“ELP”。
3. 版本号:对于长期进行迭代和更新的项目,可以使用版本号来标识不同的项目版本。
版本号通常由数字和点组成,例如1.0、2.0等。
每次更新时,版本号应递增。
例如,我们可以将“e学习平台”项目的第一个版本标识为“1.0”。
4. 日期:在项目命名中加入日期信息可以方便追踪项目的时间线和历史记录。
日期格式应为YYYYMMDD,例如20220101。
将日期加入项目命名中可以避免重复和混淆。
例如,我们可以将“e学习平台”项目的第一个版本发布日期为“20220101”。
综上所述,我们可以将“e学习平台”项目的命名规范为:项目名称-项目代号-版本号-日期,即“e学习平台-ELP-1.0-20220101”。
二、项目管理规范项目管理规范是为了确保项目顺利进行和达到预期目标而制定的一系列规定和流程。
以下是项目管理规范的一些基本要求:1. 项目目标和范围明确:在项目启动阶段,应明确项目的目标和范围,并与项目相关方进行充分沟通和确认。
项目目标和范围应具体、明确,避免模糊和含糊不清的描述。
2. 项目计划和进度管理:项目经理应制定详细的项目计划,包括项目的各个阶段、任务和里程碑。
项目计划应合理、可行,并与项目相关方进行共享和确认。
项目进度应及时跟踪和更新,确保项目按时完成。
3. 资源管理:项目经理应合理配置项目所需的人力、物力和财力资源,确保项目执行过程中资源的有效利用和协调。
作业规范文件编号规则
作业规范文件编号规则一、总体原则。
编号就像给作业规范文件的身份证号,得让咱们一眼就能看出些关键信息。
二、编号的组成部分。
1. 项目名称缩写(2 3个字母)如果是超级大项目“火星探索计划”,就可以取“HX”。
这部分就像是文件的姓,先让你知道这个文件大概和哪个大项目有关。
2. 部门代码(1 2个字母)比如研发部门是“RD”,市场部门是“MK”。
这就像是文件的家族分支,告诉你是哪个部门负责这个作业规范的。
3. 年份(4位数字)例如2023年就是“2023”。
这是文件的出生年份,能让我们快速判断这个规范是啥时候定下来的。
4. 顺序编号(3位数字)从001开始,如果这是这个部门在2023年关于火星探索计划的第5个作业规范文件,那顺序编号就是“005”。
这就像是文件在家族里的排行,是同一年同项目同部门里的序号。
三、示例。
一个研发部门在2023年关于火星探索计划的第2个作业规范文件,编号可能就是“HX RD 2023 002”。
这样的编号简单明了,不管是新员工还是老员工,一看就能大致知道这个文件的来龙去脉。
或者。
一、规则概述。
作业规范文件编号呢,就像是给文件穿上一件有特殊标识的衣服,方便我们能快速从“文件堆”里把它认出来。
二、编号结构。
1. 业务类型(1个字母)用“P”表示生产相关的作业规范,“S”表示销售方面的。
这是文件的第一个标签,让我们先对文件的业务范围有个大概印象。
2. 地点代码(2 3个字母)如果是上海的分公司就用“SH”,北京的用“BJ”。
这就像文件的籍贯,能显示出这个作业规范主要适用的地点范围。
3. 主题关键词缩写(3 5个字母)要是作业规范是关于“产品包装设计”的,就取“PKGZ”。
这部分能让我们对文件的主题内容有个快速的了解。
4. 修订版本号(1 2位数字)初始版本是“01”,每次修订就往上加1。
这就像文件的年龄增长,每修订一次就长大一点。
三、举例。
一个关于北京销售业务的“客户服务流程”作业规范文件,第一次发布,编号可能就是“S BJ KHFW 01”。
项目命名及管理规范 (2)
项目命名及管理规范标题:项目命名及管理规范引言概述:在进行项目开辟或者管理过程中,良好的命名规范和管理规范是非常重要的。
规范的命名可以提高代码的可读性和维护性,规范的管理可以提高团队的效率和项目的质量。
本文将详细介绍项目命名及管理的规范。
一、项目命名规范1.1 项目命名的规范性- 项目名称应简洁明了,能够准确反映项目的内容和目的。
- 避免使用拼音或者缩写,应该使用英文单词或者词组。
- 项目名称应该具有惟一性,避免与其他项目混淆。
1.2 文件命名的规范性- 文件名应该具有描述性,能够清晰表达文件内容。
- 文件名应该使用小写字母,单词之间可以使用下划线或者连字符分隔。
- 避免使用特殊字符或者空格,确保文件名在不同操作系统下都能正常使用。
1.3 变量命名的规范性- 变量名应该具有描述性,能够清晰表达变量的用途和含义。
- 遵循驼峰命名法或者下划线命名法,统一团队内的命名风格。
- 避免使用单个字母或者数字作为变量名,提高代码的可读性和维护性。
二、项目管理规范2.1 版本管理规范- 使用版本控制工具进行代码管理,如Git、SVN等。
- 遵循分支管理策略,确保主干代码的稳定性和可靠性。
- 定期进行代码合并和发布,保持团队的协作和沟通。
2.2 任务分配规范- 使用项目管理工具进行任务分配和跟踪,如Jira、Trello等。
- 明确任务的责任人和截止日期,确保任务按时完成。
- 定期进行任务进度汇报和评估,及时调整项目进度和资源分配。
2.3 团队协作规范- 建立团队协作文化,鼓励成员之间的沟通和合作。
- 定期进行团队会议和代码审查,提高项目的质量和效率。
- 遵循团队规范和流程,确保项目的顺利进行和顺利交付。
三、文档管理规范3.1 编写文档的规范性- 编写项目文档时应遵循统一的格式和风格,确保文档的一致性。
- 文档内容应详细全面,包括项目需求、设计、实现等方面。
- 定期更新和维护文档,确保文档与项目的实际情况保持一致。
项目文档规范No001文档编码与命名
文档编号:A H Z Y-M E S-Q D-W D G F001-V1.1安徽中烟MES项目文档规范(文档编码与命名规范)2011年10月安徽中烟MES项目组1文档修改记录目录1.概述 (1)2.技术类文档编码规范 (1)3.技术类文档命名规范 (2)4.记录汇报类文档编码规范 (3)5.记录汇报类文档命名规范 (4)1.概述为加强安徽中烟MES项目文档管理,便于项目人员阅读、修改和跟踪,采用标准化规范对文档进行统一编码、命名。
2.技术类文档编码规范举例说明:(1)合肥卷烟厂MES项目调研问卷No001-排产与调度.doc编码:AHHF-MES-XQ-DYWJ001-V2.0(2)合肥卷烟厂MES项目调查问卷No002-生产标准.doc编码:AHHF-MES-XQ-DYWJ002-V2.0(3)安徽中烟MES项目文档规范No001-文档编码与命名.doc编码:AHZY-MES-QD-WDGF001-V1.03.技术类文档命名规范文档命名规范:“项目实体名称”+“项目名称”+“文档类型No序号”+“-”+“文档详细内容概括”例如:安徽中烟MES项目文档规范No001-文档编码与命名.doc 安徽中烟MES项目调研问卷No001-排产与调度.doc安徽中烟MES项目调研问卷No002-生产标准.doc4.记录汇报类文档编码规范举例说明:(1)合肥卷烟厂MES项目周工作报告_2011_9_16_第一周.doc编码:AHHF-MES-ZB-20110916-01(2)合肥卷烟厂MES项目卷包车间调研会议纪要20110920.doc编码:AHHF-MES-JY-20110920-01(3)合肥卷烟厂MES项目动力车间调研会议纪要20110920.doc编码:AHHF-MES-JY-20110920-025.记录汇报类文档命名规范文档命名规范:“项目实体名称”+“项目名称”+“文档类型”+“文档日期”+“-”+“文档详细内容概括”,其中“文档详细内容概括”可以没有。
oa流程编号的使用
OA流程编号的使用1. 概述OA流程编号是在办公自动化系统中用于标识和跟踪不同业务流程的唯一编号。
通过使用流程编号,可以方便地查找和管理各个流程,提高工作效率和信息准确性。
本文将介绍OA流程编号的使用方法和注意事项。
2. 流程编号的生成规则流程编号的生成规则可以根据具体的业务需求进行定义,一般包括以下几个要素:•流程类别标识:根据不同的业务需求,可以将不同类型的流程进行分类标识,如采购流程、审批流程等。
•年份标识:在流程编号中加入年份标识,可以更好地进行归档和查找工作。
•流水号:每个流程在同一年内需要有唯一的流水号,一般可以采用序号或者时间戳进行生成。
3. 流程编号的使用方法在使用流程编号时,需要遵循以下几点:•统一标准:制定统一的流程编号标准,确保每个流程编号都遵循相同的规则,方便管理和查找。
•编号生成工具:可以借助办公自动化系统提供的功能或者编写相应的脚本来生成流程编号,减少手动输入的错误和工作量。
•编号的记录和存档:应当将每个流程编号记录并存档,便于日后查询和追踪。
•编号的有效期限:可以根据具体业务需求,设置流程编号的有效期限,过期的流程可以进行归档或者删除。
4. 流程编号的注意事项在使用流程编号时,需要注意以下几点:•唯一性:每个流程编号必须是唯一的,避免出现重复的编号导致混淆和错误。
•可读性:流程编号应当具有良好的可读性,便于用户理解和记忆。
•保密性:对于涉及敏感信息的业务流程,需要对流程编号进行保密处理,限制访问权限。
•流程变更时的处理:在流程发生变更时,如流程名称或者内容的修改,需要根据实际情况进行对应的编号处理,避免混淆和错误。
5. 示例流程编号以下是一个示例流程编号,供参考:•采购流程编号:PO20211001•审批流程编号:AP20211002•报销流程编号:RE20211003以上示例中,流程类别标识为采购、审批和报销,年份标识为2021,流水号分别为01、02和03。
6. 总结通过合理的使用OA流程编号,可以有效地管理和跟踪各个业务流程,提高工作效率和准确性。
项目编码规范
1.项目代码编程规范2.应用范围3.本规范应用于采用J2EE规范的项目中, 所有项目中的JAVA代码(含JSP, SERVLET,JAVABEAN, EJB)JS代码、HTML代码及数据库设计均应遵守这个规范。
同时, 也可作为其它项目的参考。
4.设计类和方法4.1. 创建具有很强内聚力的类方法的重要性往往比类的重要性更容易理解, 方法是指执行一个独立逻辑的一段代码。
类常被错误的视为是一个仅仅用于存放方法的容器。
有些开发人员甚至把这种思绪作了进一步的发挥, 将他们的所有方法放入单个类之中。
之所以不能对的的结识类的功能, 因素之一是类的实现事实上并不影响程序的执行。
当一个工程被编译时, 假如所有方法都放在单个类中或者放在几十个类中, 这没有任何关系。
虽然类的数量对代码的执行并无太大的影响, 但是当创建便于调试和维护的代码时, 类的数量有时会带来很大的影响。
类应当用来将相关的方法组织在一起。
当类包含一组紧密关联的方法时, 该类可以说具有强大的内聚力。
当类包含许多互不相关的方法时, 该类便具有较弱的内聚力。
应当努力创建内聚力比较强的类。
4.2. 大多数工程都包含许多并不十分适合与其他方法组合在一起的方法。
在这种情况下, 可认为这些不合群的方法创建一个综合性收容类。
4.3. 创建类时, 应知道“模块化”这个术语的含义是什么。
类的基本目的是创建相称独立的程序单元。
4.4. 创建松散连接和高度专用的方法4.4.1.使所有方法都执行专门的任务每个方法都应执行一项特定的任务, 它应杰出的完毕这项任务。
应避免创建执行许多不同任务的方法。
创建专用方法有许多好处。
一方面调试将变得更加容易。
4.4.2.尽量使方法成为自成一体的独立方法当一个方法依赖于其他方法的调用时, 称为与其他方法紧密连接的方法。
紧密连接的方法会使调试和修改变得比较困难, 由于它牵涉到更多的因素。
松散连接的方法优于紧密连接的方法, 但你不也许使每个方法都成为独立的方法。
项目命名及管理规范
项目命名及管理规范引言概述:在软件开发过程中,项目命名及管理规范是非常重要的,它不仅能提高团队协作效率,还能方便项目的维护和扩展。
本文将从项目命名规范、项目管理规范、版本控制规范、文档管理规范和代码规范五个方面详细阐述。
一、项目命名规范:1.1 项目名称:项目名称应简洁明了,能够准确表达项目的功能和目的。
避免使用缩写或过于复杂的词汇,以免给团队成员带来困扰。
1.2 文件命名:文件命名应具有描述性,能够清晰地表达文件的内容和作用。
采用驼峰命名法或下划线命名法,统一命名风格,便于团队成员的理解和查找。
1.3 目录结构:项目目录结构应合理划分,按照功能或模块进行分类,以便于团队成员的协作和维护。
同时,应遵循统一的命名规范,方便团队成员的理解和使用。
二、项目管理规范:2.1 项目计划:在项目启动阶段,制定详细的项目计划,包括项目目标、里程碑、资源分配等内容,明确项目的时间和质量要求,确保项目的顺利进行。
2.2 任务分配:根据项目计划,合理分配任务给团队成员,明确每个人的责任和工作内容。
同时,建立良好的沟通机制,及时了解项目进展和解决问题。
2.3 进度管理:定期进行项目进度的跟踪和评估,及时发现和解决项目中的问题和风险。
同时,建立项目管理工具,记录项目的进展和问题,方便团队成员的参考和回顾。
三、版本控制规范:3.1 分支管理:根据项目的需要,合理划分分支,如开发分支、测试分支和发布分支等。
每个分支应有明确的目的和规范的操作流程,确保代码的稳定性和可维护性。
3.2 提交规范:团队成员在提交代码时,应遵循统一的提交规范,包括提交信息的格式和内容要求。
提交信息应简洁明了,能够清晰地表达代码的修改内容和目的。
3.3 版本发布:在代码经过测试和审核后,进行版本的发布。
每个版本应有明确的版本号和发布说明,方便用户了解和使用。
同时,建立版本回退机制,确保项目的稳定性和可靠性。
四、文档管理规范:4.1 文档分类:根据项目的需要,将文档进行分类,如需求文档、设计文档和测试文档等。
项目编码规范
项目编码规范项目编码规范(一)命名规范Java包、类的命名应尽量采用完整的英文描述符,一般采用小写英文字母,但类名、接口名以及任何非初始单词的第一个字母要大写,不能用完整英文描述的,应以该英文单词的前四个字母或能代表单词意思的缩写代替。
具体如下:(1)尽量使用完整的英文描述符;(2)采用合适于相关领域的术语(3)采用大小写混合使名字可读(4)尽量少用缩写,确有需要的,要能表达其意义;(5)避免使用长的名字(小于15个字母)(6)避免使用类似的名字,或者是大小写不同的名字;(7)避免使用下划线(除静态常量等);举例如下:包(packge) 采用完整的英文描述符,应该都是由小写字母组成。
对于全局包,将你的internet域名反转并接上包名。
如:com.boyi.eim,com.boyi.oa.web 类(Class) 采用完整的英文描述符,所有单词的第一个字母大写。
如:User,StuManager接口(interface) 采用完整的英文描述符说明接口封装,所有单词第一个字母大写。
名字后面加上后缀Dao,实体类实现接口加上后缀Impl 类变量:采用完整的英文描述符,第一个字母小写,后所有单词的第一个字母大写。
如:userName参数:同上获取成员函数:封装字段,被访问时调用get set方法普通成员函数:采用完整的英文描述符,第一个字母小写,后所有单词的第一个字母大写。
静态常量字段:全部采用大写字母,单词之间用下划线分隔。
循环计数器:通常采用字母I,j,k……………..数组:采用完整的英文描述符,第一个字母小写,后所有单词的第一个字母大写(二)代码注释良好的注释习惯对于一支程序来说,是其易于解读的关键。
也就是说,如果另一个编程人员从未见过这段代码,要在合理的时间内理解代码,需要知道哪些信息。
并以此作为注释的依据。
因此对于注释来说,需要注意以下几点:(1)注释应该增加代码的清晰度;(2)保持注释的简洁;(3)在写代码之前写注释(4)注释出为什么做了一些事,而不仅仅是做了什么使用代码注释的目的:(1)文字说明代码的作用(即为什么要用编写该代码,而不是如何编写);(2)确指出该代码的编写思路和逻辑方法;(3)人们注意到代码中的重要转折点;(4)使代码的阅读者不必在他们的头脑中仿真运行代码的执行方法.代码注释原则:1. 用文字说明代码的作用:简单的重复代码做写什么,这样的注释几乎不能给注释增加什么信息.如果你使用好的命名方法来创建直观明了的代码那么这些类型的注释绝对增加不了什么信息.2. 如果你想违背好的编程原则,请说明为什么:有的时候你可能需要违背好的编程原则,或者使用了某些不正规的方法,.遇到这种情况时,请用内部注释来说明你在做什么和为什么要这样做。
BP01-10-A-流程文件命名与编码规则
价值链体系
流程区域
英文
缩写
战略流程
企业战略规划
CompanyStrategic Planning
CSP
全面预算管理
OverallBudget Management
OBM
企业绩效管理
CompanyPerformance Management
CPM
运营流程
营销
Marketing
MKT
研发
Research And Development
RD
工程
Engineering
ENG
计划
ProductAnd Material Control
PMC
采购
Purchasing
PUR
生产
Manufacturing
MFG
客户服务
CustomerService
CS
物流&库存&关务管理
Logistics & Inventory And Customs Affairs Management
5.1.3.不得使用特殊字符;
5.1.4.各级文件命名规则
文件级别
命名规则
一级
企业战略地图
二级
XX程序
示例:质量管理程序
三级
流程类文件:XX流程
规范类文件:XX规范或XX规则,如《物料编码规则》
四级
XX表,XX单,XX模版,XX报告
版本控制规则
5.1.5.文件必须有版本,以便区别文件状态。
5.1.6.正式文件版本以A、B、C……Z形式递增,版本超过Z后,先取消该份文件,再以新文件(新的文件编号)的A版新发行。
oa项目命名与编码规范
编写说明标题:项目命名与代码编写规范版本历史:1编写目的作为朗沃进行项目开发的技术规范,是进行软件质量控制的必要规范。
2命名2.1业务模块名在需求建模阶段按照用例划分来对业务模块进行命名,要求简洁易懂。
2.2包的命名2.2.1业务包命名业务包指与项目所要实现的业务逻辑相关的包。
包的命名由前缀和包的逻辑名组成,其中前缀:com.lovo.+项目名称逻辑名:业务模块名+层名,如果项目规模不是很大,直接采用层名,例如:project.action或actionproject.service或service业务模块“项目管理”完整的包名示例:com.lovo.cmts.action(web.action)com.lovo.cmts.domain(model)com.lovo.cmts.service2.2.2基础包命名基础包指在项目中供多个业务包共用的包,一般放置到下列包中moncom.lovo.cmts.utils2.3Java命名Java命名的时候需要同时兼顾业务和技术,命名要能体现软件的层次结构。
接口命名命名规范:首字母大写,如果有多个单词,每个单词头字母大写例如:StudentInfoservlet类命名:命名规范:以Servlet单词结尾例如:LoginServletStruts Action类命名:命名规范:Action的命名以域模型对象名称来制定,域模型对象名称Action 例如:一个域模型对象名称为Diary,其对应的action为DiaryActionAction中所有对service的引用,变量命名必须以*Service结尾,比如:userService。
Struts Form类命名:命名规范:Form的命名以域模型对象名称来制定,域模型对象名称Form例如:一个域模型对象名称为Diary,其对应的Form为DiaryForm业务逻辑接口命名:命名规范:业务逻辑接口的命名以域模型对象名称来制定,I域模型对象名称Service例如:一个域模型对象名称为Diary,其对应的业务逻辑接口为IDiaryService业务逻辑接口实现命名:命名规范:业务逻辑接口的命名以域模型对象名称来制定,域模型对象名称ServiceImpl例如:一个域模型对象名称为Diary,其对应的业务逻辑接口为DiaryServiceImpl 2.4Jsp页面命名命名规范:以模块名+ _开头,jsp页面名称要以小写字母开头,如果有多个单词组成,后面的单词以大写字母开头。
项目编码规则
项目编码规则项目编码规则是指在项目管理中为了方便统一管理和识别项目而制定的一套编码规则。
项目编码规则的制定可以匡助项目团队准确识别和跟踪项目,提高项目管理的效率和准确性。
下面是一份标准格式的项目编码规则文本,详细介绍了项目编码规则的内容和要求。
1. 编码结构项目编码由多个部份组成,每一个部份之间使用分隔符进行分隔。
普通情况下,项目编码包括以下几个部份:- 组织标识:用于标识项目所属的组织或者单位,通常是组织的缩写或者代号。
- 项目类型:用于区分不同类型的项目,如研发项目、市场推广项目等。
- 年份:用于标识项目启动的年份。
- 项目序号:用于标识同一年度内不同项目的序号。
2. 编码要求- 组织标识:组织标识应该是惟一的,可以根据组织的名称或者缩写进行设置。
- 项目类型:项目类型应该根据实际情况进行设置,可以根据项目的性质、目标或者阶段进行分类。
- 年份:年份应该使用四位数表示,如2022年表示为"2022"。
- 项目序号:项目序号从1开始递增,每一个项目的序号应该是惟一的。
3. 示例下面是一个示例项目编码规则:- 组织标识:ABC- 项目类型:RD(研发项目)- 年份:2022- 项目序号:001根据以上规则,该项目的编码为:ABC-RD-2022-001。
4. 使用说明- 项目编码应该在项目启动时进行分配,并在整个项目生命周期中使用。
- 项目编码应该在项目管理系统或者文档管理系统中进行记录和管理。
- 项目编码应该在项目相关的文档、报告、会议等场合中进行使用和引用。
5. 好处和意义- 统一标识:项目编码可以匡助项目团队统一标识和识别项目,避免混淆和错误。
- 快速定位:通过项目编码,可以快速定位和查找项目相关的信息和文档。
- 信息归档:项目编码可以匡助项目团队对项目信息进行归档和管理,方便后续的审计和查阅。
- 统计分析:项目编码可以为项目管理提供数据支持,方便进行项目统计和分析。
综上所述,项目编码规则是项目管理中非常重要的一部份,它可以匡助项目团队准确识别和跟踪项目,提高项目管理的效率和准确性。
北京市电子政务信息系统与项目命名规范
北京市电子政务信息系统与项目命名规范一、系统命名规则北京市电子政务信息系统命名体系包括中文全称、编号、英文全称、简称共四部分。
其中中文全称、编号为必须内容;英文全称、简称为可选内容。
(一)系统中文全称命名规则1.系统中文全称结构如下:应用范围+ 主要业务或主要功能+ “系统”应用范围指系统用户范围:(1)若系统为面向全市的信息共享、服务类系统,则应为“北京(市)”;(2)若本系统支撑的业务为该单位所特有,不会引起歧义的,也可以为“北京(市)”;(3)委办的门户网站、本委办内部办公系统或非支撑本单位的特有业务的(如网上审批等),则应为系统主责单位的标准简称,如“北京市信息办”;(4)对于共建的,覆盖多个委办局的交叉业务系统,一般为“北京市”,特殊情况(共建、交叉系统的绝大多数业务智能集中于主责单位)可以使用主责单位简称。
主要业务或主要功能是用简单词汇对系统功能、定位的描述,如“办公自动化”,“网上审批”,“××数据库”,“××信息管理”,“××网站”等,这部分内容要体现系统支撑的主要业务或系统的主要功能、内容。
为保持系统命名相对稳定,可结合本单位信息化规划对系统功能进行前瞻性描述,采用规划中该系统将具有的功能描述做为系统名称。
若一个系统支撑多项业务,或其功能具有多个方面,可以采取以下方式:(1)采用主要功能;(2)采用具有前瞻性的系统整合、升级后的功能描述;(3)用“及”连接,如“网络及视频会议”、“办公自动化及网上审批”等;(4)使用综合性的名称,例如“北京市××局综合业务管理系统”。
2.系统中文全称命名规则的其他要求(1)系统的中文全称应当根据系统的类型选择使用常用命名词汇。
(2)系统中文全称中禁用英文或英文缩写。
(3)系统的版本不在中文全称中体现。
(4)系统中文全称不宜太长,一般在25个字内(包括标点)。
(5)与国家衔接的垂直系统,按国家垂直系统的方式命名。
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
编写说明标题:项目命名与代码编写规范版本历史:1编写目的作为朗沃进行项目开发的技术规范,是进行软件质量控制的必要规范。
2命名2.1业务模块名在需求建模阶段按照用例划分来对业务模块进行命名,要求简洁易懂。
2.2包的命名2.2.1业务包命名业务包指与项目所要实现的业务逻辑相关的包。
包的命名由前缀和包的逻辑名组成,其中前缀:com.lovo.+项目名称逻辑名:业务模块名+层名,如果项目规模不是很大,直接采用层名,例如:project.action或actionproject.service或service业务模块“项目管理”完整的包名示例:com.lovo.cmts.action(web.action)com.lovo.cmts.domain(model)com.lovo.cmts.service2.2.2基础包命名基础包指在项目中供多个业务包共用的包,一般放置到下列包中moncom.lovo.cmts.utils2.3Java命名Java命名的时候需要同时兼顾业务和技术,命名要能体现软件的层次结构。
接口命名命名规范:首字母大写,如果有多个单词,每个单词头字母大写例如:StudentInfoservlet类命名:命名规范:以Servlet单词结尾例如:LoginServletStruts Action类命名:命名规范:Action的命名以域模型对象名称来制定,域模型对象名称Action 例如:一个域模型对象名称为Diary,其对应的action为DiaryActionAction中所有对service的引用,变量命名必须以*Service结尾,比如:userService。
Struts Form类命名:命名规范:Form的命名以域模型对象名称来制定,域模型对象名称Form例如:一个域模型对象名称为Diary,其对应的Form为DiaryForm业务逻辑接口命名:命名规范:业务逻辑接口的命名以域模型对象名称来制定,I域模型对象名称Service例如:一个域模型对象名称为Diary,其对应的业务逻辑接口为IDiaryService业务逻辑接口实现命名:命名规范:业务逻辑接口的命名以域模型对象名称来制定,域模型对象名称ServiceImpl例如:一个域模型对象名称为Diary,其对应的业务逻辑接口为DiaryServiceImpl 2.4Jsp页面命名命名规范:以模块名+ _开头,jsp页面名称要以小写字母开头,如果有多个单词组成,后面的单词以大写字母开头。
名称要体现出该页面的意义,最好能够与模块名称联系在一起。
例如列表页面,project_list.jsp详细信息页面,project_detail.jsp3项目目录结构3.1总体目录结构根据eclipse工具的特征,项目的目录结构为:姓名(例:wangxh)----存放java文件(源文件结构详见后续描述)|--config --存放相关配置文件WebRoot|--images --存放web程序所需的公共图片|--css --存放web程序所需的公共样式表|--js --存放web程序所需的公共js文件|--commons --存放web程序所需的公共文件|--upload 上传的公共文件,其下可以继续建目录存放不同类别文件|--功能模块文件夹(存放与某个功能模块相关的资源)|--images --存放与该功能模块相关的图片|--css --存放与该模块相关的样式表文件|--js --存放与该模块相关的js文件|--jsp或html页面(不建文件夹,直接存放)|--upload 上传的文件,其下可以继续建目录存放不同类别文件|--WEB-INF|--classes|--lib --项目中的包|--tld --tld文件doc|--rq --需求相关文档|--plan --项目计划相关文档|--db --数据库相关文档(包括建表sql,数据初始化sql)3.2配置文件规范Spring配置文件:系统中所有的配置文件统一放到config/下。
spring文件配置Spring配置文件放在config/spring/spring-baseConfig.xml 基本配置文件(dao的配置也是这里)spring-service.xml,业务类配置文件以上是公共部分文件,每个人的struts action在spring中的配置文件命名规则为:spring-action-模块名-姓名拼音缩写.xmlspring-action-sale-zs.xml,表示张三所写的销售模块的action配置。
spring-action-schedule-ls.xml,表示李四所写的计划模块的action配置。
struts配置文件:●struts配置文件放在config/struts/●struts-baseConfig.xml 基本配置文件(全局出错定义、process的定义等)●除此之外为个人配置文件,命名规则为:struts-模块名-姓名拼音缩写.xmlstruts-sale-zs.xml,表示张三所写的销售系统的action配置。
struts-schedule-ls.xml,表示李四所写的计划系统的action配置。
ibatis文件配置●ibatis配置文件放在onfig/ibatis/●ibatis-baseConfig.xml 基本配置文件,此文件中要启用命名空间。
●除此之外为个人配置文件,命名规则为:ibatis-模块名-实体对象名-姓名拼音缩写.xml,例如:ibatis-sale-place-zs.xml即表示销售系统中的 place实体对象,由张三所写。
iabtis-schdule-schduleTemple-ls.xml即表示计划系统中的计划模板实体对象,由李四所写。
hibernate文件配置命名规则config/hibernate/中存放hibernate.cfg.xml,如果该文件中的配置已经移到spring中,此文件可不写。
config/hibernate/hbm/下存放所有实体类映射文,如过多,可考虑按模块分包存放。
3.3源代码包结构规范根目录结构Wangxh--|--com.lovo.cmts.dao --项目中的持久化接口|--impl --持久接口实现类|--com.lovo.cmts.service --项目中的业务层接口|--impl --业务层实现类|--com.lovo.cmts.domain(model) --领域层对象,其下可继续按模块划分子包|--com.lovo.cmts.vo(dto) --值对象,其下可继续按模块划分子包|--com.lovo.cmts.exception --业务异常包|--com.lovo.cmts.util --工具包|mons --公共类包|--com.lovo.cmts.web --与V层、C层相关类|--struts/formbean –formbean对象,可按模块分包存放 |--struts/action –action对象,可按模块分包存放 |--util –web工具类(包装器、过滤器等)|--test --项目中的所有测试类,其下可继续按业务模块建子包分类对以上源文件中的目录结构说明如下:(1)domain,存放领域模型对象如果对象较多,可考虑按模块再划分子包,分类保存,以方便维护:比如:com.lovo.cmts.domain.sale.Order,表示保存在sale子包中的订单领域对象;com.lovo.cmts.domain.message.Mail,表示保存在message子包中的邮件领域对象;(2)dao包●dao持久层对象,保存系统中所有持久层接口,比如:com.lovo.cmts.dao.IOrderDao,表示订单持久层对象●dao.impl持久化接口实现类,比如:com.lovo.cmts.dao.impl.OrderDaoImpl,表示订单持久化实现类;(注:如果采用通用DAO方法,就建立CommonDAO与QueryDao,只需这两个接口即可)(3)service包●service包存放服务对象接口比如:com.lovo.cmts.service.ISaleService,表示销售业务接口。
●service.impl包中存放业务类实现方法:比如:com.lovo.cmts.service.impl.SaleServiceImpl,表示销售业务接口实现类。
(4)exception系统异常包异常可按业务分类,分包存放,所有异常父类选择为ng.Exception。
比如:com.lovo.cmts.exception.SendMailException,表示发送邮件失败异常。
(5)util包该包中存放项目中用的的工具类,比如:字符串处理、日期处理、MD5加密库、UUID生成器、验证码生成器、图片处理类等。
(6)commons包项目中其它模块用到的公共类,比如:常量接口。
(7)vo包项目中用到的值对象或DTO对象,可根据业务要求及前台要求,自行定义,但统一以VO结尾,比如:MailVO,表示邮件值对象。
(8)web包该包存放所有与控制层与视图层相关的类,该包下有如下子包:●web.struts.formbean,存放静态formbean(类命名以Form结尾,比如:LoginForm)●web.struts.action,存入系统中的所有action,所有action均继承自系统中的BaseAction。
(类命名以Action结尾,比如:LoginAction)●web.util,存放web相关工具,比如:包装器,乱码过滤器等(9)测试类以test开头,分类存放比如: .lovo.cmts.service.SaleServiceTest,表示销售业务测试类.lovo.cmts.dao.SaleDaoTest,表示销售持久对象测试类4注释规范类注释/**************************************************************** ** 类逻辑名称 : 项目业务类* 类功能 : 实现项目对象的持久化* @Author 编程者 : 张三* 初作时间 : 2009/6/20* 关联类 :* 通用DAO:CommonDAO;* 领域对象:Project;* 处理流程 :** 调用示例 :** ---------------------------------------------------------- * 时间: 修改者:* 修改内容:** ---------------------------------------------------------- * 时间: 修改者:* 修改内容:** ----------------------------------------------------------******************************************************************* /方法注释对于业务方法都应该加上注释,但GET,SET不用添加注释/*** 方法名称* 方法实现的业务说明* @param 进行参数说明* @return 对返回值进行说明*/JSP页面注释采用HTML注释进行注释,对于使用标记库的循环如forEach需要在开始和结束时进行注释<!—开始循环显示projectList--><c:forEach items=”projectList” var=”project”></c:forEach><!—结束循环-->本次OA项目规范:1.所有页面、代码、项目、服务器编码采用utf-8.2.主要软件:a)MyEclipse professional 2014 项目名 GoodOAb)软件 Tomcat 7c)数据库 mysql 数据库名 db_oa3.项目目录结构4.注意:a)类、方法、变量需按规范命名,命名见名知意。