(技术规范标准)信息技术部各类文档命名规范

合集下载

数据库设计规范与命名规则

数据库设计规范与命名规则

数据库设计规范、技巧与命名规范一、数据库设计过程数据库技术是信息资源管理最有效的手段。

数据库设计是指:对于一个给定的应用环境,构造最优的数据库模式,建立数据库及其应用系统,有效存储数据,满足用户信息要求和处理要求。

数据库设计的各阶段:A、需求分析阶段:综合各个用户的应用需求(现实世界的需求)。

B、在概念设计阶段:形成独立于机器和各DBMS产品的概念模式(信息世界模型),用E-R图来描述。

C、在逻辑设计阶段:将E-R图转换成具体的数据库产品支持的数据模型,如关系模型,形成数据库逻辑模式。

然后根据用户处理的要求,安全性的考虑,在基本表的基础上再建立必要的视图(VIEW)形成数据的外模式。

D、在物理设计阶段:根据DBMS特点和处理的需要,进行物理存储安排,设计索引,形成数据库内模式。

1. 需求分析阶段需求收集和分析,结果得到数据字典描述的数据需求(和数据流图描述的处理需求)。

需求分析的重点:调查、收集与分析用户在数据管理中的信息要求、处理要求、安全性与完整性要求。

需求分析的方法:调查组织机构情况、各部门的业务活动情况、协助用户明确对新系统的各种要求、确定新系统的边界。

常用的调查方法有:跟班作业、开调查会、请专人介绍、询问、设计调查表请用户填写、查阅记录。

分析和表达用户需求的方法主要包括自顶向下和自底向上两类方法。

自顶向下的结构化分析方法(Structured Analysis,简称SA方法)从最上层的系统组织机构入手,采用逐层分解的方式分析系统,并把每一层用数据流图和数据字典描述。

数据流图表达了数据和处理过程的关系。

系统中的数据则借助数据字典(Data Dictionary,简称DD)来描述。

2. 概念结构设计阶段通过对用户需求进行综合、归纳与抽象,形成一个独立于具体DBMS的概念模型,可以用E-R图表示。

概念模型用于信息世界的建模。

概念模型不依赖于某一个DBMS支持的数据模型。

概念模型可以转换为计算机上某一DBMS 支持的特定数据模型。

公司知识的命名规范

公司知识的命名规范

公司知识文档的命名规范第一条说明为了方便知识文档的管理、维护、分享,特制定此知识文档规范的命名方式.此规范根据网络知识管理工具资料整理,主要适用于文档命名,文件夹命名可供参考,请参照执行.公司所有人员沟通文档必须以此规范作为依据.第二条文档基本类别文档按类别可分为三类:1.工作文档:包括与日常工作相关的各类文档,其特点在于工作文档多数属于周期性的内容,围绕各类业务或职能开展.2.项目文档:包括以项目形式开展的工作相关的各类文档,其特点在于项目工作通常是一次性的,以临时性的项目组织为主体开展.3.外部文档:包括通过各种渠道从外界收集、获取,未经过公司内部任何人员整理、加工的资料,其特点在于种类繁多,没有既定的分类标准,无法使用规范性的方式进行管理.所以,针对这三类文档的不同特点制定了三种不同的命名规范标准.第三条文档命名规范1.工作文档命名规范结合工作文档的特点,我们在命名时需要体现出开展工作的主体,即各个业务或职能部门,同时也需要体现出工作的周期时间节点或者是具体的时间点日期.结合上述内容我们将工作文档命名划分成4个部分,各部分之间通常以下划线连接,这4个部分分别是:①文档来源: 可以是公司、部门、人员等主体性实体.如:张三_周工作总结_;或研发部_周工作总结_②文档内容说明:直接表明主题③文档类别:合同、总结、报告、方案等④时间节点、日期或版本说明手工生成.图表错误!未定义书签。

工作文档命名规范表格 错误!未定义书签。

工作文档命名规范2.项目文档命名规范结合项目文档的特点,我们在命名时需要体现文档所属的项目主体,同时也需要体现相应的时间点日期.结合上述内容我们将工作文档命名划分成4个部分,各部分之间通常以下划线连接,这4个部分是:① 具体项目 :宏观② 文档内容说明:主题说明 ③ 文档类别:计划或方案等④间节点、日期或版本说明手工生成,也可以通过日期表示版本.下面分别通过图示与表格的方式具体说明项目文档的命名规范:图表 2项目文档命名规范表格错误!未定义书签。

技术资料磁盘文件命名规则

技术资料磁盘文件命名规则

技术资料磁盘文件命名规则
1所有技术资料磁盘文件名称可参考本规则命名,无法按此规则命名的遵照原命名规则。

2 技术资料磁盘文件应分类存储。

同一项目的技术资料磁盘文件可分磁
盘或子目录存储。

不同项目的技术资料磁盘文件不得存储在同一磁盘
介质的同一子目录内。

3 每一种技术资料或每一张图纸文件存储在独立的一个磁盘文件中。

4 磁盘文件按如下格式命名:AAAA NN MM.EXT
其中,AAAA为工程代号中用户缩写字母,2~4位。

NN 为文件资料或图纸资料目录文件或图纸的序号,必须是2位数字。

MM 为同一文件资料或图纸资料的页号,必须是2位数字。

EXT 为磁盘文件扩展名,由工具软件自动确定。

5 磁盘子目录按如下格式命名:AAAA NN XX.MMM
其中,AAAA为工程代号中用户缩写字母,2~4位。

NN 为同一用户的工程序号,必须是2位数字。

XX 为专业代号,必须是2位数字。

MMM 为同一专业不同类型资料的子目录序号,当只有一个子
目录时可不写。

6 所有技术资料磁盘介质必须粘贴标签,格式见附件。

还应附磁盘文件
清单,格式见附件。

清单上必须注明用户名称,工程名称,工程代号,
磁盘片数,文件总数,磁盘序号,子目录名,文件名,生产日期,制
造人。

7 附件
磁盘文件清单,磁盘样贴。

工程公司科技文件材料(电子版)归档填写要求

工程公司科技文件材料(电子版)归档填写要求

工程公司科技文件材料(电子版)归档填写要求工程公司的科技文件包括了各种技术资料、相关技术报告、技术标准、技术规范等等,这些材料的收集、整理、归档对于公司的科技管理至关重要。

良好的归档过程可以使文件的查找更加方便快捷,也可以防止信息的丢失和泄漏。

下面将为大家介绍工程公司科技文件材料归档填写的要求。

一、文件分门别类公司在进行文件归档的时候,需要将文件进行分门别类按照不同的类别进行归档。

例如,可以将文件归为技术资料类、技术报告类、技术标准类、技术规范类、科研成果类等。

二、文件编号规范对于公司的各种科技文件资料,需要对其进行规范的编号,以防止文件混乱和遗漏。

编号格式可以根据公司的实际情况来制定。

一般来说,编号的格式包括了类别、年度、月份、序号。

例如,技术资料类编号格式为“T202201001”。

三、文件归档时间对于公司获得的各种科技文件资料,需要及时进行归档和存储。

应该确定归档的具体时间和归档的周期。

一般来说,归档的时间周期应该不超过1个月,以免遗漏重要的资料。

四、文件归档环节文件归档环节包括了文件整理、文件分类、文件编号、文件打印、文件装订、文件存储装置等等。

在进行文件归档的时候,需要对每一个环节做好把控和管控。

五、文件档案管理对于公司归档的文件,需要进行档案管理,保障文件的完整性、保密性和安全性。

建立归档登记表格,记录每次归档的时间、文件名称、文件编号等。

并建立文件保管制度,对文件进行保密和安全管理。

六、文件查询系统为了方便文件的查询和使用,可以建立文件查询系统。

查询系统可以是电脑版的,也可以是纸质版的。

建立文件查询系统可以方便查找和使用文件,节约时间和成本。

以上就是工程公司科技文件材料归档填写要求的基本内容。

在实际的工作中,每个公司的要求可能会有所不同,针对实际情况进行修改和调整。

在工程公司的科技文件归档过程中,需要遵循规范的流程并注意细节,以保障文件的安全完整,为公司的发展提供支持和保障。

文件的技术规范要求

文件的技术规范要求

文件的技术规范要求在现代人们的日常生活和工作中,文件的使用频率越来越高,不论是电子化的文件还是纸质文件,都离不开一些技术规范的要求。

本文将就文件的技术规范要求进行探讨。

一、文件格式规范要求不同的文件有着不同的格式要求,比如在办公场景中,常见的文件格式包括Word、Excel、PDF等。

对于电子化的文件,我们应该遵循以下技术规范要求:1. 使用常见的文件格式:选择广泛应用的文件格式,以确保文件的可读性和兼容性。

常见的文件格式包括.doc/.docx(Word文档)、.xls/.xlsx(Excel电子表格)和.pdf(可移植文档格式)等。

2. 注意文件的文件名格式:文件名应简洁明了,能够准确地反映出文件的内容,并且避免使用特殊字符或者过长的命名方式,以方便他人查找和识别。

3. 统一字体和字号:在编辑文件时,应选择常见的字体,如宋体、微软雅黑等,并统一字号以保证整体文档的一致性和美观度。

4. 规范文档布局:良好的文档布局能够使得文件内容的阅读更加清晰明了。

合理使用标题、字体加粗、居中等格式功能,对文本进行适当的分段和换行,以及插入表格、图片等元素,使得整个文档具备良好的可读性。

二、文件安全规范要求文件的安全性是保护信息安全的重要环节,必须严格遵守以下规范要求:1. 合理设置文件的访问权限:对于电子文件,应尽量设置访问权限,限制文件的访问范围,以防止未经授权的人员查看、修改或删除文件。

2. 定期备份文件:无论是纸质文件还是电子文件,定期进行备份可以防止文件丢失和损坏情况的发生,并在需要时快速恢复到最新的版本。

3. 加密敏感信息:对于包含敏感信息的文件,在存储和传输过程中,可以采用加密技术对文件内容进行保护,以提高信息的安全性。

4. 严格控制文件的传输渠道:在电子文件传输过程中,应使用安全可靠的网络传输方式,并采取相关加密措施,以防止文件在传输过程中被非法截获、篡改或丢失。

三、文件命名规范要求良好的文件命名规范有助于提高文件的组织性和可管理性,以下是一些建议:1. 使用有意义的文件名:文件名应简明扼要地反映出文件的内容和用途,不要使用含糊不清的名字,以避免给他人带来困惑。

命名规范

命名规范
表 1-1 不同类型的标识符的大小写规则
标识符
大小写
样例
名字空间
Pascal
namespace System.Security { … }
类型
Pascal
public class StreamReader { … }
接口
Pascal
public interface IEnumerable { … }
虽然运行于 CLR 之上的一些编程语言的确区分大小写,但这并不是必需的。即使你使用的语言区分大小写,可能会使 用框架的其他语言却并不一定会区分。因此,任何外部可访问的 API 不应该仅通过大小写来区分位于同一个上下文中的 两个名字。 实际上是否区分大小写只有以下一条规范,但是很重要。 × 不要以为所有的编程语言都是区分大小写的,实际情况并非如此。不应该仅仅通过大小写来区分名字。
命名规范
1 大小写约定
因为 CLR 支持许多编程语言,这些语言有的区分大小写,有的不区分,所以不应该只用大小写来区分名字。但是,大 小写对增强名字可读性的重要性怎么强调也不过分。以下的规范展示了一种使用大小写的简单方法,如果一致地使用, 那么会使类型、成员以及参数的标识符更易于阅读。
1.1 标志符的大小写规则
字段(静态)
Pascal
public MessageQueue { public static readonly TimeSpan InfiniteTimeout; }
枚举值
Pascal
FileMode { Append, … }
参数
Camel
public class Convert { public static int ToInt32(string value); }

文件的技术规范与验收要求

文件的技术规范与验收要求

文件的技术规范与验收要求1.引言文件作为信息传递和保存的重要工具,在现代社会中具有不可替代的作用。

为了保证文件的质量和可靠性,制定文件的技术规范和验收要求变得至关重要。

本文将探讨文件的技术规范和验收要求的必要性以及如何制定和执行这些规范和要求。

2.文件的技术规范2.1 文件格式规范为了确保文件的兼容性和可读性,制定文件格式规范是必要的。

在选择文件格式时,应考虑到文件的用途和传输方式。

常见的文件格式包括.docx、.pdf、.xlsx等。

文件格式规范应包括文件扩展名的定义、文件结构的要求、字体和样式的规定等。

2.2 文件命名规范文件命名规范是为了方便文件的管理和查找。

合理的文件命名规范可以使文件命名规范统一、易于识别和排序。

例如,可以按照日期加上关键字或者项目名称进行文件命名。

2.3 文件存储规范文件存储规范是为了保证文件的安全性和可靠性。

合理的文件存储规范可以避免文件丢失或损坏。

制定文件存储规范时,应考虑到备份方式、存储设备的选择和定期检查等。

3.文件的验收要求3.1 文件完整性的验证文件完整性是指文件内容是否完全,没有丢失或损坏的部分。

文件的接收方可以通过比对文件的哈希值或者使用数字签名等方式对文件的完整性进行验证。

3.2 文件格式的兼容性测试文件格式兼容性的测试是为了验证文件能否被不同的软件或系统正确打开和阅读。

在验收过程中,应使用不同的软件或系统来打开文件,确保文件能够正常显示和运行。

3.3 文件存储的可靠性检查文件存储的可靠性检查是为了验证文件存储设备是否能够正常读取和写入文件。

这可以通过读写测试和设备健康状态检查来实现。

4.文件技术规范和验收要求的执行4.1 文件技术规范的制定文件技术规范应由相关部门或专业人员制定,并与相关人员共同讨论和确认。

规范的制定应考虑到实际情况和需求,并定期进行评估和更新。

4.2 文件验收的目的和方法说明文件验收的目的是为了确保文件符合规定的技术规范和验收要求。

技术文件管理规范

技术文件管理规范

技术文件管理规范引言概述:技术文件是组织和管理技术信息的重要工具,对于保证项目的顺利进行和技术工作的高效性具有重要意义。

因此,建立和遵守技术文件管理规范是必不可少的。

本文将详细阐述技术文件管理规范的五个部分,包括文件命名规范、文件存储规范、版本控制规范、文件备份规范和文件权限管理规范。

一、文件命名规范:1.1 采用有意义的文件名:文件名应能够准确描述文件的内容,避免使用无意义的编号或日期作为文件名。

1.2 使用统一的命名规则:制定统一的命名规则,包括使用大写字母、下划线或短横线分隔单词等,以保证文件名的一致性。

1.3 避免特殊字符和空格:文件名中不应包含特殊字符和空格,以免引起文件读取或识别问题。

二、文件存储规范:2.1 设立统一的文件存储位置:建立一个专门的文件存储目录,将所有技术文件集中存放,便于管理和查找。

2.2 分类存储文件:根据文件的类型或内容,将文件进行分类存储,如将设计文件、测试文件等分别存放在相应的文件夹中。

2.3 建立文件索引:为了方便快速查找文件,可以建立文件索引,记录文件的名称、位置和相关信息,并定期更新。

三、版本控制规范:3.1 使用版本控制工具:选择适合的版本控制工具,如Git或SVN等,用于管理文件的版本变更和追踪。

3.2 规定版本命名规则:制定统一的版本命名规则,包括主版本号、次版本号和修订号等,以便于识别和管理不同版本的文件。

3.3 记录版本变更信息:在每次文件版本变更时,记录变更的内容、原因和日期等信息,以便于追溯和回滚。

四、文件备份规范:4.1 定期备份文件:制定定期备份文件的计划,确保文件的安全性和可恢复性。

4.2 存储备份文件:将备份文件存储在独立的位置或设备中,避免与原始文件存放在同一处,以防止意外损坏或丢失。

4.3 测试备份文件的可恢复性:定期测试备份文件的可恢复性,确保备份文件的完整性和有效性。

五、文件权限管理规范:5.1 分配合适的权限:根据不同的角色和职责,分配合适的文件访问权限,确保只有授权人员可以查看、编辑或删除文件。

  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

文档索引:NIAT-GF-MM-1213-04
宁波东大智能
文档命名规范
宁波柴天佑院士工作室
宁波东大自动化智能技术有限公司
信息技术部2010年12月13日
文档修订
抄送人:项目经理、客户经理、客户代表、项目组成员、SCCB(在项目实际应用时最好写明抄送人的姓名)
目录
一、部门规范 (5)
1.1数据库设计规范文档命名 (5)
1.2代码编写规范文档命名 (5)
1.3界面风格规范文档命名 (5)
1.4文档编写规范命名 (6)
1.4.1需求分析文档命名 (6)
1.4.2编码设计文档命名 (6)
1.4.3数据库设计文档命名 (6)
1.4.4操作需求文档命名 (7)
1.4.5功能设计文档命名 (7)
1.4.6软件详细设计文档命名 (7)
1.4.7软件测试文档命名 (8)
1.5软件视频命名规范 (8)
1.6用户手册文档命名 (9)
二、部门管理规范 (9)
2.1下厂任务单命名 (9)
2.2下厂总结报告命名 (10)
2.3软件功能验收文档命名 (10)
一、部门规范
1.1数据库设计规范文档命名
软件功能开发过程中,要遵循公司的数据库设计规范文档。

数据库设计规范规范文档的命名,遵循以下格式:公司简称+规范编号+数据库代号+编写日期+
举例:NIAT-GF-SJK-121301
1.2代码编写规范文档命名
软件功能开发过程中,要遵循公司的代码编写规范文档。

代码编写规范文档的命名,遵循以下格式:公司简称+规范编号+代码代号+编写日期+序列号,中
举例:NIAT-GF-DM-121301
1.3界面风格规范文档命名
软件功能开发过程中,开发的软件要进行界面风格的统一,要遵循公司的界面风格规范文档。

界面风格规范文档的命名,遵循以下格式:公司简称+规范编
举例:NIAT-GF-JM-121301
1.4文档编写规范命名
1.4.1需求分析文档命名
软件功能开发之前,要对用户的要求进行需求分析,编写需求分析文档。

需求分析文档的命名,遵循以下格式:模块编号+需求代号+编写日期+序列号,中
举例:M2-XQ-1208-01
1.4.2编码设计文档命名
软件功能开发之前,要对数据库进行编码设计,编写数据库编码设计文档。

数据库编码设计文档的命名,遵循以下格式:模块编号+编码需求代号+编写日期+
举例:M2-BM-1208-01
1.4.3数据库设计文档命名
软件功能开发之前,要对数据库进行设计,编写数据库设计文档。

数据库设计文档的命名,遵循以下格式:模块编号+数据库需求代号+编写日期+序列号,
举例:M2-SJK-1208-01
1.4.4操作需求文档命名
软件功能开发之前,要了解用户对软件的操作需求,编写软件操作需求文档。

软件操作需求文档的命名,遵循以下格式:模块编号+操作需求代号+编写日期+
举例:M2-CZ-1208-01
1.4.5功能设计文档命名
软件功能开发之前,要编写软件功能设计文档。

软件功能设计文档的命名,遵循以下格式:模块编号+功能设计代号+编写日期+序列号,中间用减号隔开,
举例:M2-GN-1208-01
1.4.6软件详细设计文档命名
软件功能开发之前,要编写软件详细设计文档。

软件详细设计文档的命名,遵循以下格式:模块编号+详细设计代号+编写日期+序列号,中间用减号隔开,
举例:M2-XX-1208-01
1.4.7软件测试文档命名
软件功能开发出来之后,要及时进行软件测试,并提交软件测试文档。

软件测试文档的命名,遵循以下格式:模块编号+测试代号+测试日期+序列号,中间
举例:M2-CS-1208-01
1.5软件视频命名规范
软件开发完毕后,进行软件打包。

同时模块负责人录制操作视频,填写用户
使用手册。

视频统一放置在服务器的培训视频文件夹,视频名称统一命名。

名称
为(模块编号+视频代号+录制日期+序列号),中间用减号隔开,说明如下:
举例:M4-SP-1206-01
1.6用户手册文档命名
软件功能开发出来之后,要及时书写用户使用手册,与视频一起交与用户使用。

用户使用手册的命名,遵循以下格式:模块编号+手册代号+手册书写日期+
举例:M2-SC-1208-01
二、部门管理规范
文件管理,文件需要编号,编号规则如下:NIAT-GF-XC-M1-120801。

文件类型:XC代表下厂任务单,YS代表模块功能验收,ZJ代表下厂总结
报告。

模块:M1代表销售管理,M2代表计划管理,M3代表物料管理,M4代表指标管理,M5代表财务管理,M6代表标准管理。

日期4位代表月份和天,序列号是日期当天的序列号。

日期改变序列号重新从01开始。

2.1下厂任务单命名
举例:NIAT-GF-XC-M1-121301:
文档类型:规范文档;
文件类型:下厂;
模块名:M1;
日期及序列号:121301;
2.2下厂总结报告命名
举例:NIAT-GF-ZJ-M1-121301:
文档类型:规范文档;
文件类型:总结;
模块名:M1;
日期及序列号:121301;
2.3软件功能验收文档命名
举例:NIAT-GF-YS-M1-121301:
文档类型:规范文档;
文件类型:验收;
模块名:M1;
日期及序列号:121301;。

相关文档
最新文档