信息技术部各类文档命名规范.docx

资源描述

文档索引： NIAT-GF-MM-1213-04 宁波东大智能文档命名规范宁波柴天佑院士工作室宁波东大自动化智能技术有限公司信息技术部 2010年12月13日名称磁业生产管理系统文档编号 NIAT-GF-MM-1213-04 文档名称文档命名规范文档类型文档规范项目编号 NIAT10001 保密级别机密文档编制刘业峰版本 V1.0 编写人员刘业峰编写日期 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 1213 01 举例：NIAT-GF-SJK-121301 1.2代码编写规范文档命名软件功能开发过程中，要遵循公司的代码编写规范文档。代码编写规范文档的命名，遵循以下格式：公司简称+规范编号+代码代号+编写日期+序列号，中间用减号隔开，说明如下：公司简称文档类型文件类型编写日期序列号 NIAT GF DM 1213 01 举例：NIAT-GF-DM-121301 1.3界面风格规范文档命名软件功能开发过程中，开发的软件要进行界面风格的统一，要遵循公司的界面风格规范文档。界面风格规范文档的命名，遵循以下格式：公司简称+规范编号+界面代号+编写日期+序列号，中间用减号隔开，说明如下：公司简称文档类型文件类型编写日期序列号 NIAT GF JM 1213 01 举例：NIAT-GF-JM-121301 1.4文档编写规范命名 1.4.1需求分析文档命名软件功能开发之前，要对用户的要求进行需求分析，编写需求分析文档。需求分析文档的命名，遵循以下格式：模块编号+需求代号+编写日期+序列号，中间用减号隔开，说明如下：模块编号需求代号编写日期序列号 2位 2位 4位 2位（从1自增） M4 XQ（需求拼音第一个字母） 1208 01 举例：M2-XQ-1208-01 1.4.2编码设计文档命名软件功能开发之前，要对数据库进行编码设计，编写数据库编码设计文档。数据库编码设计文档的命名，遵循以下格式：模块编号+编码需求代号+编写日期+序列号，中间用减号隔开，说明如下：模块编号编码设计代号编写日期序列号 2位 2位 4位 2位（从1自增） M4 BM（编码拼音第一个字母） 1208 01 举例：M2-BM-1208-01 1.4.3数据库设计文档命名软件功能开发之前，要对数据库进行设计，编写数据库设计文档。数据库设计文档的命名，遵循以下格式：模块编号+数据库需求代号+编写日期+序列号，中间用减号隔开，说明如下：模块编号数据库设计代号编写日期序列号 2位 3位 4位 2位（从1自增） M4 SJK（数据库拼音第一个字母） 1208 01 举例：M2-SJK-1208-01 1.4.4操作需求文档命名软件功能开发之前，要了解用户对软件的操作需求，编写软件操作需求文档。软件操作需求文档的命名，遵循以下格式：模块编号+操作需求代号+编写日期+序列号，中间用减号隔开，说明如下：模块编号操作需求代号编写日期序列号 2位 2位 4位 2位（从1自增） M4 CZ（操作拼音第一个字母） 1208 01 举例：M2-CZ-1208-01 1.4.5功能设计文档命名软件功能开发之前，要编写软件功能设计文档。软件功能设计文档的命名，遵循以下格式：模块编号+功能设计代号+编写日期+序列号，中间用减号隔开，说明如下：模块编号详细设计代号编写日期序列号 2位 2位 4位 2位（从1自增） M4 GN（功能拼音第一个字母） 1208 01 举例：M2-GN-1208-01 1.4.6软件详细设计文档命名软件功能开发之前，要编写软件详细设计文档。软件详细设计文档的命名，遵循以下格式：模块编号+详细设计代号+编写日期+序列号，中间用减号隔开，说明如下：模块编号详细设计代号编写日期序列号 2位 2位 4位 2位（从1自增） M4 XX（详细拼音第一个字母） 1208 01 举例：M2-XX-1208-01 1.4.7软件测试文档命名软件功能开发出来之后，要及时进行软件测试，并提交软件测试文档。软件测试文档的命名，遵循以下格式：模块编号+测试代号+测试日期+序列号，中间用减号隔开，说明如下：模块编号测试代号编写日期序列号 2位 2位 4位 2位（从1自增） M4 CS（测试拼音第一个字母） 1208 01 举例：M2-CS-1208-01 1.5软件视频命名规范软件开发完毕后，进行软件打包。同时模块负责人录制操作视频，填写用户使用手册。视频统一放置在服务器的培训视频文件夹，视频名称统一命名。名称为（模块编号+视频代号+录制日期+序列号），中间用减号隔开，说明如下：模块编号视频代号录制日期序列号 2位 2位 4位 2位（从1自增） M4 SP（视频拼音第一个字母） 1208 01 举例：M4-SP-1206-01 1.6用户手册文档命名软件功能开发出来之后，要及时书写用户使用手册，与视频一起交与用户使用。用户使用手册的命名，遵循以下格式：模块编号+手册代号+手册书写日期+序列号，中间用减号隔开，说明如下：模块编号手册代号编写日期序列号 2位 2位 4位 2位（从1自增） M4 SC（手册拼音第一个字母） 1208 01 举例：M2-SC-1208-01 二、部门管理规范文件管理，文件需要编号，编号规则如下：NIAT-GF-XC-M1-120801。公司简称文档类型文件类型模块日期序列号 NIAT GF XC，YS，ZJ， M1 1208 01 文档类型：GF代表公司文档；文件类型：XC代表下厂任务单，YS代表模块功能验收，ZJ代表下厂总结报告。模块：M1代表销售管理，M2代表计划管理，M3代表物料管理，M4代表指标管理，M5代表财务管理，M6代表标准管理。日期4位代表月份和天，序列号是日期当天的序列号。日期改变序列号重新从01开始。 2.1下厂任务单命名公司简称文档类型文件类型模块日期序列号 NIAT GF XC M1 1213 01 举例：NIAT-GF-XC-M1-121301：文档类型：规范文档；文件类型：下厂；模块名：M1；日期及序列号：121301； 2.2下厂总结报告命名公司简称文档类型文件类型模块日期序列号 NIAT GF ZJ M1 1213 01 举例：NIAT-GF-ZJ-M1-121301：文档类型：规范文档；文件类型：总结；模块名：M1；日期及序列号：121301； 2.3软件功能验收文档命名公司简称文档类型文件类型模块日期序列号 NIAT GF YS M1 1213 01 举例：NIAT-GF-YS-M1-121301：文档类型：规范文档；文件类型：验收；模块名：M1；日期及序列号：121301；

展开阅读全文