(完整word版)技术文档命名规则(全面完整的)要点
- 格式:doc
- 大小:20.51 KB
- 文档页数:10
1.编码:utf—82.统一缩进3.对于html文件和css必须统一大写或小写,禁止大小写混合。
4.注释风格必须统一,html文件为〈!--**行开始—->代码<!——**行结束-—〉样式表注释为/*********你的注释2010 07 28********/ 即注释修改写时间5.屏宽:980px1.各分屏宽:360px+10px+360px+245px=985px2.730px+10px+245 px=985 px3.425 px+10 px+295 px+10px+245 px =985 px4.243px*3+11 px+245px=985px5.245 px+10px+430 px+10px+290 px=985px6.命名规则(以下命名是现行的)1.文件栏目命名网站介绍about关于我们aboutus联系方式contactus招聘信息joinus版权声明copyrightQQ群合作外部链接爱逗客服kefu上网新手xinshou爱逗狗牌goupai爱逗奖品jiangpin爱逗会员member寻回系统find爱逗活动activities爱逗地图map爱逗论坛bbs爱逗原创wond人物专访visit爱逗杂志idzine特约商家idbusi论坛内容idesse 政策法规rule论坛精华bbsjh爱逗活动huodong 狗狗训练营xunlian 狗狗学堂school活动回顾huigu 走进社区活动回顾huigu社区风貌fengmao 线下出游chuyou 活动回顾huigu 线上活动online狗牌发放dogtag活动通知notice会员指南zhinan 爱逗规则guize爱逗教程jiaocheng入门知识rumen法律法规falvCNKC资料ziliao商家首页school商家产品shangpin 商家信息xinxi商家动态dongtaiK9首页k9K9动态dongtai关于K9 about展会资讯show 展会简介jj展会常识cs展会预告yugao美国西敏寺犬展xms往期回顾hg 英国克鲁弗兹犬展Crufts往期回顾hg CKU犬展cku往期回顾hg AKC-中国犬展akc往期回顾hg 亚洲宠物用品展apf往期回顾hg 中国国际宠物水族用品展cips往期回顾hg 其他展会qita往期回顾hg环球宠物global 国内idnews北美beimei日韩rihan欧洲ouzhou 世界名犬馆expodog 西安世园会概况shiyuanhui世界名犬馆mingquan场馆直通车zhinan场馆活动huodong最新资讯zixun精彩图片tupian精彩视频shipin赛事早知道zhidao名人访谈mingren产品product爱逗相册photo 狗狗相册dogpicture活动相册petxian宠物摄影petphoto 推荐作品tj合作摄影机构syhezuo摄影小知识zhishi作品精选jingxuan摄影器材qicai信息info医院.美容hospital犬舍。
项目文档命名规则编制: 日期:____/____/____审核:日期:____/____/____批准:日期:____/____/____XXXX公司二零一五年五月制历史记录目录1 目的 (4)2 适用范围 (4)3 术语和缩略词 (4)4 规程 (4)4。
1 文档命名规则 (4)4.2 配置项的版本标识 (8)4。
3 标签的命名 (8)1 目的本文的目的是定义各项目所有相关文档和CMM要求的过程文件的格式和规则,以及配置管理中对配置项和版本的标识。
2 适用范围本规则适用于所有需求、设计等文档和过程文件.3 术语和缩略词无4 规程4。
1 文档命名规则1组织标准软件过程文档编号(1)过程文件格式:XXX-P-××,初始编号为:XXX-P—01,最大编号为:XXX—P-99。
(2)指南文件编号:XXX—G—××××,前两位××为指南所对应的过程文件编号。
(3)模板文件编号:XXX—T—××××,前两位××为指南所对应的过程文件编号.2产品命名规范(1)中文命名规范:中文全称V产品版本号。
英文命名规范:首字母大写V产品版本号。
3项目文档编号(1)编号规则分三种:1)单个文档:首字母大写V产品版本号-阶段英文缩写-文档名称英文缩写。
2)多个子文档:首字母大写V产品版本号—阶段英文缩写—文档名称英文缩写—流水号.3)周期性:首字母大写V产品版本号-文档名称/英文名称—八位日期.(2)项目阶段及文档名称英文缩写,见下表:4文档版本(1)格式:V×××.×××,初始版本号为V0.1,最大版本号为:V999.999.其中,草稿状态的版本均为V0.×××,例如:V0。
1,V0。
2……V0.999;而经过评审通过的文档版本均从V1.0开始,例如:V1。
文档索引:NIAT-GF-MM-1213-04宁波东大智能文档命名规范宁波柴天佑院士工作室宁波东大自动化智能技术有限公司信息技术部2010年12月13日文档修订抄送人:项目经理、客户经理、客户代表、项目组成员、SCCB(在项目实际应用时最好写明抄送人的姓名)目录一、部门规范 (4)1.1数据库设计规范文档命名 (4)1.2代码编写规范文档命名 (4)1.3界面风格规范文档命名 (4)1.4文档编写规范命名 (4)1.4.1需求分析文档命名 (4)1.4.2编码设计文档命名 (5)1.4.3数据库设计文档命名 (5)1.4.4操作需求文档命名 (5)1.4.5功能设计文档命名 (5)1.4.6软件详细设计文档命名 (6)1.4.7软件测试文档命名 (6)1.5软件视频命名规范 (6)1.6用户手册文档命名 (6)二、部门管理规范 (7)2.1下厂任务单命名 (7)2.2下厂总结报告命名 (7)2.3软件功能验收文档命名 (7)一、部门规范1.1数据库设计规范文档命名软件功能开发过程中,要遵循公司的数据库设计规范文档。
数据库设计规范规范文档的命名,遵循以下格式:公司简称+规范编号+数据库代号+编写日期+举例:NIAT-GF-SJK-1213011.2代码编写规范文档命名软件功能开发过程中,要遵循公司的代码编写规范文档。
代码编写规范文档的命名,遵循以下格式:公司简称+规范编号+代码代号+编写日期+序列号,中举例:NIAT-GF-DM-1213011.3界面风格规范文档命名软件功能开发过程中,开发的软件要进行界面风格的统一,要遵循公司的界面风格规范文档。
界面风格规范文档的命名,遵循以下格式:公司简称+规范编举例:NIAT-GF-JM-1213011.4文档编写规范命名1.4.1需求分析文档命名软件功能开发之前,要对用户的要求进行需求分析,编写需求分析文档。
需求分析文档的命名,遵循以下格式:模块编号+需求代号+编写日期+序列号,中举例:M2-XQ-1208-011.4.2编码设计文档命名软件功能开发之前,要对数据库进行编码设计,编写数据库编码设计文档。
公司文档命名规定一、前言在公司日常运营过程中,文档管理是一个重要的环节。
为了方便员工对文档的查找和整理,统一的文件命名规定变得尤为必要。
本文将详细介绍公司文档命名规定,确保文档管理的规范性和高效性。
二、文件命名规则1. 文件名应简明扼要,能够准确反映文档的内容,避免使用过长或含糊不清的命名。
2. 下划线、连字符或驼峰命名法可以用于连接不同的关键词,便于阅读和识别。
3. 文件名中应包含日期信息以反映文档的版本或最后修改时间。
日期格式应为YYYYMMDD。
4. 对于同一个类别的文档,可以使用序号进行区分和排序。
序号应前置于文件名。
5. 特殊字符和非法字符(如:\/:*?"<>|)应避免使用在文件名中,确保命名的合法性。
6. 文件名应使用英文命名,避免使用中文或其他特殊字符,以兼容不同操作系统的文件系统。
三、分类命名规范为了更好地管理公司文档,我们将根据文档所属的类别,制定以下分类命名规范。
1. 公司政策相关文档文件命名格式:Policy_关键词_日期例如:Policy_EmployeeCodeofConduct_20220101.docx2. 合同和协议文档文件命名格式:Contract_合同名称_合同类型_日期例如:Contract_SupplierAgreement_Purchase_20220101.docx3. 客户文件文件命名格式:Customer_客户名称_日期例如:Customer_ABCCompany_20220101.docx4. 会议记录文件命名格式:Meeting_会议主题_日期例如:Meeting_MonthlyReview_20220101.docx5. 报告文档文件命名格式:Report_报告名称_日期例如:Report_MarketAnalysis_20220101.docx6. 培训资料文件命名格式:Training_培训主题_日期例如:Training_SalesTechniques_20220101.docx四、版本管理1. 在文档修改过程中,如果需要保存新的版本,应在文件名中添加版本号。
关于公司知识文档的命名规范第一条说明为了方便知识文档的管理、维护、分享,特制定此知识文档规范的命名方式。
此规范根据网络知识管理工具资料整理,主要适用于文档命名,文件夹命名可供参考,请参照执行。
公司所有人员沟通文档必须以此规范作为依据。
第二条文档基本类别文档按类别可分为三类:1.工作文档:包括与日常工作相关的各类文档,其特点在于工作文档多数属于周期性的内容,围绕各类业务或职能开展。
2.项目文档:包括以项目形式开展的工作相关的各类文档,其特点在于项目工作通常是一次性的,以临时性的项目组织为主体开展。
3.外部文档:包括通过各种渠道从外界收集、获取,未经过公司内部任何人员整理、加工的资料,其特点在于种类繁多,没有既定的分类标准,无法使用规范性的方式进行管理。
所以,针对这三类文档的不同特点制定了三种不同的命名规范标准。
第三条文档命名规范1.工作文档命名规范结合工作文档的特点,我们在命名时需要体现出开展工作的主体,即各个业务或职能部门,同时也需要体现出工作的周期(时间节点)或者是具体的时间点(日期)。
结合上述内容我们将工作文档命名划分成 4 个部分,各部分之间通常以下划线连接,这 4 个部分分别是:①文档来源:可以是公司、部门、人员等主体性实体。
如:张三_周工作总结_20160808;或研发部_周工作总结_20160808②文档内容说明:直接表明主题③文档类别:合同、总结、报告、方案等④时间节点、日期或版本说明(手工生成)。
工作文档命名规范XXX XXX XXX XXXXX下划线第四部分:文档时间节点、版本号或日期,为必填项。
第一部分:文档来第二部分:文档内容说第三部分:该文档的文档类别,源,必填项明,必填项。
为可选项,可与文档内容说明合并。
图表 1 工作文档命名规范文档命名规范(一):工作文档示例第一部分第二部分第三部分第四部分备注示例来源文档内容文档类别时间节点计划总结、报告报表等IT 部 _年度经营计划 _2011 年度1.(内部)说明来源文档内容信息技术部 _XXX 会议纪要2.说明文档类别日期会议纪要等_20110909(内部)来源文档内容信息技术部 _知识管理咨询服务合同3.说明文档类别日期合同协议等_20110912(外部)来源文档内容版本说明规范流程等人力资源部 _人员转正审批流程 _V2.0 4. 文档类别(内部)说明表格 1 工作文档命名规范2.项目文档命名规范结合项目文档的特点,我们在命名时需要体现文档所属的项目主体,同时也需要体现相应的时间点(日期)。
工作文档命名和存储规范工作文档的命名和存储规范对于提高工作效率和文件整理的重要性不言而喻。
一个好的命名和存储规范可以让我们在需要查找文件时事半功倍,避免不必要的浪费时间和精力。
本文将介绍一些常用的工作文档命名和存储规范,以帮助大家更好地管理和组织自己的工作文档。
一、命名规范1. 使用简洁明了的文件名:文件名应该能够准确地描述该文档所涵盖的内容,同时尽量保持简洁,避免使用过长或容易混淆的文件名。
2. 使用有意义的关键词:在文件名中使用一些有意义的关键词,以方便搜索和分类。
比如,在命名一个市场调研报告的文档时,可以使用类似“市场调研报告_2019_Q1”的格式,其中关键词包括“市场调研报告”、“2019”和“Q1”。
3. 采用统一的日期格式:在文件名中包含日期信息,可以使文件按时间排序,方便查找和追溯。
常见的日期格式有“YYYY-MM-DD”、“YYMMDD”等。
4. 使用连字符或下划线进行分隔:在文件名中使用连字符或下划线进行分隔,使文件名更易读和易懂。
避免使用空格或特殊字符,以免在不同操作系统或平台下出现兼容问题。
5. 按照分类进行命名:根据文档内容的不同类别,可以将相似的文件放在同一分类下,并在文件名中加入对应的标识,方便区分。
例如,“市场调研报告_2019_Q1”和“销售数据_2019_Q1”。
二、存储规范1. 建立清晰的文件目录结构:在存储文件时,建立清晰的目录结构可以有效地组织文件,使文件查找更加便捷。
可以根据不同的项目、文档类型或部门等进行分类,建立相应的文件夹或子文件夹。
2. 统一使用英文命名:为了避免操作系统或平台的兼容问题,文件夹和文件的命名最好统一使用英文。
3. 避免文件夹或文件名过长:过长的文件夹或文件名不利于文件查找和管理,在命名时尽量保持简洁明了。
4. 定期整理和清理工作文档:随着时间的推移,工作文档会越来越多,为了保持工作文档的整洁和高效,定期进行文件整理和清理是必要的。
文件命名规范
文件命名是现代文件管理存储技术中最重要的部分,它可以有效地分
类管理文件,帮助用户快速、准确地查找和使用文件。
给文件起名的之前,应该结合实际情况,选择一种简单合理的文件命名规范,以提高工作效率。
1.文件命名应具有辨识度,名称中的字符要尽量准确地描述文件内容,尽量不重复,以便于快速查找和识别文件。
2.文件名中不能包含特殊字符,不能使用过长的文件名,一般不超过255个字符。
3.文件名要尽量用英文或者数字组合,不要使用空格,注意不同类型
的文件名后缀,更好地区分文件,如:doc表示Word文档,xls表示
Excel表格等。
4.文件名应该根据文件结构制定一种类似的文件编号,这样可以便于
文件排序、查找、检索等,比如以日期进行编号,如:2008_1_15.doc。
5.要为文件夹和文件起一个恰当的名字,推荐使用描述式名称,方便
记忆。
6.若文件内容有较多的版本,应在文件名中标明版本号,以便日后对
文件进行查找和使用,比如work_v2.0.doc。
综上,文件命名规范应该具有明确、准确、有辨识度的特点,使得文
件命名更加严谨和规范。
1、合同编号规范HLC-HR-年月日/001(劳动合同)HLC-SL-年月日/001(销售合同)HLC-PC-年月日/001(采购合同)说明:HL为公司缩写C为Contract的缩写HR表示劳动合同范畴SL表示销售合同范畴PC表示采购合同范畴001开始为序列号2、固定资产编号HL-PA-RD/001(研发设备编号)HL-PA-IT/001(信息设备编号)HL-PA-TP/001(运输设备编号)HL-PA-RS/001(后勤设备编号)说明:HL为公司缩写PA为固定资产Permanent Assets的缩写RD表示研发设备IT表示电脑、打印机、交换机之类的信息设备TP表示汽车等运输设备RS表示行政后勤设备,如空调、办公家具等001开始为序列号3、表单编号HLT-HR/001-A1(人事表格)HLT-RD/001-A1(研发表格)HLT-MK/001-A1(市场表格)HLT-SL/001-A1(销售表格)HLT-AD/001-A1 (行政表格)HLT-FN/001-A1(财务表格)说明:HL为公司缩写T为表格Table的缩写HR表示人事部门、RD表示研发部门、MK表示市场部门、SL表示销售部门、AD表示行政部门、FN表示财务部门001开始为序列号A1表示版本号,如表格在原有基础上稍作调整则变动数字;如表格在原有基础上本质性调整则变动字母4、文件编号HLF-HR/001-A1(人事文件)HLF-RD/001-A1(研发文件)HLF-MK/001-A1(市场文件)HLF-SL/001-A1(销售文件)HLF-AD/001-A1 (行政文件)HLF-FN/001-A1(财务文件)说明:HL为公司缩写F为文件File的缩写HR表示人事部门、RD表示研发部门、MK表示市场部门、SL表示销售部门、AD表示行政部门、FN表示财务部门001开始为序列号A1表示版本号,如表格在原有基础上稍作调整则变动数字;如表格在原有基础上本质性调整则变动字母。
文档命名规则
文档的命名规则可以根据实际需求和个人习惯来定,以下是一些常见的文档命名规则:
1. 使用简洁明确的名称:文档名称应该能够准确地描述文档的内容和用途,避免使用模糊或含糊不清的名称。
2. 使用有意义的关键词:在文档名称中使用相关的关键词能够方便用户和搜索引擎理解文档的主题,提高文档的可发现性。
3. 采用统一的命名格式:为了方便组织和检索文档,可以采用统一的命名格式,如使用特定的前缀、日期、版本号等,例如"项目名称_文档名称_日期"。
4. 避免使用特殊字符和空格:文档名称中应避免使用特殊字符和空格,以免引起文件系统或操作系统的问题。
5. 使用文件扩展名:为了方便识别文件类型,应在文档名称后面添加合适的文件扩展名,例如.docx、.xlsx、.pdf等。
6. 适当缩短文档名称:为了方便阅读和管理,文档名称不宜过长,最好控制在一行内或者保持较短的长度。
7. 加入版本信息:如果文档需要经常更新或者存在多个版本,可以在文档名称中加入版本信息,以便区分和管理。
总之,文档命名应该简洁明了、具有描述性并且易于辨识和管理。
01 命名规范文件命名的原则:以最少的字母达到最轻易理解的意义。
0一般文件及目录命名规范:0每一个目录中应该包含一个缺省的html 文件,文件名同一用index.htm 0文件名称同一用小写的英文字母、数字和下划线的组合0尽量按单词的英语翻译为名称。
例如:feedback(信息反馈),aboutus(关于我们) 0多个同类型文件使用英文字母加数字命名,字母和数字之间用_分隔。
例如:news_01.htm。
留意,数字位数与文件个数成正比,不够的用0补齐。
例如共有200条新闻,其中第18条命名为news_018.htm0图片的命名规范:0名称分为头尾两两部分,用下划线隔开。
0头部分表示此图片的大类性质。
例如:放置在页面顶部的广告、装饰图案等长方形的图片我们取名:banner ;标志性的图片我们取名为:logo ;在页面上位置不固定并且带有链接的小图片我们取名为button ;在页面上某一个位置连续出现,电棍性质相同的链接栏目的图片我们取名:menu ;装饰用的照片我们取名:pic ;不带链接表示标题的图片我们取名:title 依照此原则类推。
0尾部分用来表示图片的具体含义,用英文字母表示。
例如:banner_sohu.gif banner_sina.gif menu_aboutus.gif menu_job.gif title_news.gif logo_police.gif logo_national.gif pic_people.jpg pic_hill.jpg. 0有onmouse效果的图片,两张分别在原有文件名后加"_on"和"_off"命名。
0其它文件命名规范0js的命名原则以功能的英语单词为名。
例如:广告条的js文件名为:ad.j s 0所有的CGI文件后缀为cgi。
所有CGI程序的配置文件为config.cgi002 目录结构规范0目录建立的原则:以最少的层次提供最清楚简便的访问结构。