【酷玩集团】文档管理手册
A3_1 酷玩集团文档管理手册
酷玩集团
目录
1.文档管理者职责
2.文档说明
2.1文档编制标准和指南
2.2文档质量等级
2.3文档具体类型
3.文档修改记录规定
4.文档统一格式规定
5.文档内容规范
6.文档存储结构规范
1.文档管理者职责
确定项目文档管理人员:李欣源。
职责:
1) 监管项目中不同规格文档的分类保存工作:包括文本、图形、表格等
2) 执行项目文档的调取改动工作:即查询、登记是否有所改动
2.文档说明
2.1文档编制标准和指南
1)文档书写规范:
管理信息系统的文档资料涉及文本、图形和表格等多种规格,无论是哪种类型的文档都应该遵循统一的书写规范,包括标识符的使用、图标的含义、程序中注释行的使用、注明文档书写人及书写日期等。
2)图表编号规则:
管理信息系统的开发过程会用很多图表,对这些图表进行有规则的编号,便于查找图表。
3)文档目录编写标准:
为了及时存档并且方便未来使用,应当编写文档目录。管理信息系统的文档目录中应当包括文档编号、文档名称、格式或载体、份数、每份页数或件数、存储地点、存档时间、保管人等信息。
4)文档管理制度:
为了更好地进行信息系统的文档管理,应当建立相应的文档管理制度。文档管理制度需要根据组织实体的具体情况而定,主要包括确定文档的相关规范、文档借阅记录的登记制度、文档使用权限控制规则等。
2.2文档质量等级
1)【1级】最低限度文档:
适用于开发工作量低于1个月/人的开发者自用程序;应当包括程序清单、开发记录、测试数据和程序简介。
2)【2级】内部文档:
适用于没有与其他用户共享资源的专用程序。除1级文档提供的信息外,2级文档还应当包括程序清单内足够的注释,以便帮助用户安装和使用程序。
3)【3级】工作文档:
适用于由同一单位内若干人联合开发的程序,以及可被其他单位使用的程序。
4)【4级】正式文档:
适用于那些要正式发行供普遍使用的软件产品。关键性程序或具有重复管理应用性质(如工资计算)的程序也需要使用4级文档。
2.3文档具体类型
1)【A类】(公司内部管理文件):
如规章制度、工作流程等,用于规范领导层干部以及各层员工的行为和工作方式。
2)【B类】(合同协议):
如与客户、供应商、合作伙伴等干系人共同签订的合同协议,用于明确双方权利义务。
3)【C类】(报告材料):
如年度报告、财务报表、市场分析报告等,用于反映公司的经营状况和业务发展情况。
4)【D类】(产品文档):
如产品说明书、使用手册、安装指南等,用于向客户介绍公司的产品或服务。
5)【E类】(培训资料):
如培训课件、教材等,用于对员工进行技能培训,以实现专业知识传承。
3.文档修改记录规定
1)重视文档撰写与审核:
依据文档编制标准和指南撰写文档,并对文档内容进行仔细审核和审批,确保文档的质量和正确性。
2)记录文档修改历史:
对于重要文档,应当建立修改记录,记录文档的修改时间、修改人员、修改内容和修改原因等信息,以备查证。
3)强化沟通和协调:
在项目执行过程中,应当注重与相关人员之间的沟通和协调,及时了解各方需求和意见,避免文档出现较大偏差或错误。
4)实施文档版本控制:
为了确保文档的统一性和版本正确性,应当对文档实施版本控制,确保每个文档都有唯一的标识符、版号和版本说明等信息。
4.文档统一格式规定
注:制定文档统一格式的意义:统一项目文档格式可以帮助团队在整个项目周期中更好地组织,存储和访问项目文档;可以提高项目文档的可读性和一致性,简化团队沟通和协作,并帮助保持文档的易于访问和管理。
1)标题格式:
统一采用“文档具体类型 文档质量等级_顺序序号<空格>文档主题(含关键词)”格式。例如“D3_6 后端阿里云服务器搭建过程记录”中的“D3_6”表示“顺序编号为6的产品开发工作文档”。(注:具体编号规则见“2.2文档质量等级”和“2.3文档具体类型”)
2)页眉和页脚:
页眉:包括文档的章节名称(若有),记录者,记录日期(左对齐);
页脚:设置页码,统一采用“i/n”(i为当前页码,n为总页数)格式(居中对齐);不设脚注。
3)字体(中文/英文)和字号:
标题:总标题采用“黑体/Arial,二号”格式;一级标题采用“黑体/Arial,三号”格式,写作“1.xx”;二级标题采用“黑体/Arial,小三”格式,写作“1.1.xx”;三级标题采用“黑体/Arial,四号”格式,写作“1.1.1.xx”;不设置更低级标题。
正文:统一采用“宋体/Times New Roman,小四”格式;可适当加粗、标蓝、标红、高亮重点部分;“倾斜”表示说明注释内容。
尾注:统一于各章节篇末陈列该章节参考文献或说明性材料,正文部分的引用处须设置相应尾注,采用“①②③...”标识符。
4)段落格式:
缩进:对相同级别的段落设置相同缩进。
行间距:默认为1.25倍行间距。
对齐方式:文字统一采用“两端对齐”方式;图片、表格等均统一采用“居中对齐”方式。
索引:各级标题所在的段落需要分别设置“一级”“二级”“三级”索引,(注:word文件应当建立导航),方便定位检索。
5)图片和表格格式:
图片:尽量采用下面所示格式,设置相同的水平方向长度为“13厘米”(大图)或“5厘米”(小图);(注:保持默认图片比例,不进行拉伸)在图片下方放置图片命名,采用“图章节号-该章节内图序号 图片信息概括(含关键词)” 格式,如“图1-1 项目团队logo”
图1-1 项目团队logo
表格:尽量采用下面所示格式;在表格上方放置表格命名,采用“表章节号-该章节内表序号 表格信息概括(含关键词)”格式,如“表3-2 工作分解结构”。(注:表序号独立于图序号)
表3-2 工作分解结构
5.文档内容规范
1)项目计划:包括项目的目标、范围、进度、资源、风险等。
2)需求分析:包括项目的需求、用户需求、功能需求、验收标准等。
3)设计文档:包括项目的系统架构、设计方案、技术选型、编码规范等。
4)测试计划:包括测试用例、测试流程、测试工具、测试数据等。
5)编码文档:包括程序代码、注释、接口文档等。
6)部署文档:包括部署环境、配置信息、安装说明等。
7)维护文档:包括维护手册、故障排除指南、更新记录等。
8)项目总结报告:包括项目实施情况、成果评价、经验总结、改进建议等。
6.文档存储结构规范
1)按阶段存储:将文档按项目开发过程中的不同阶段进行划分与存储,参考项目生命期的各阶段划分,建立一级文件夹。(注:如有必要,还可按照子阶段、底层活动进行划分,建立相应文件夹)
2)按具体类型存储:在一级文件夹下,进一步按不同具体类型进行划分,应分别建立“A类、B类、C类、D类、E类”二级文件夹。
3)按质量等级存储:在二级文件夹下,进一步按不同质量等级进行划分,应分别建立“1级、2级、3级、4级”三级文件夹。
【酷玩集团】文档管理手册相关推荐
- 【干货集锦】如何轻松玩转文档管理工具?我们为你精心准备了一份学习大礼包...
文档管理(Document Management),文档是企业重要的智力资产.在企业中,文档一般都以电子文档的形式存在,比如微软.doc格式,xls格式,ppt格式,pdf格式,纯文本.txt格式等: ...
- 除了SVN,还可以使用的文档管理工具--TFS; 使用VS2010连接TFS的使用说明和简单操作手册
TFS(Taobao File System)是一个高可扩展.高可用.高性能.面向互联网服务的分布式文件系统,功能强大,可用于管理代码和文档,功能可粗暴视为git+svn,也可以简单用做文档管理,相当 ...
- 图书管理系统需求规格说明文档目录_一个已经超越普通设计素材管理范畴的文档管理软件—Eagle...
为什么我要使用Eagle?本篇文章是我第一次在知乎写的专栏文,我觉得我应该把我对这个软件的日常使用体会介绍给同样是产品汪的同学们,如果适合大家,是我的荣幸,如果不适合,那就略过.本文就以下几点来描述我 ...
- 云效知识库 Thoughts,企业文档管理工具
云效知识库 Thoughts,企业文档管理工具,云效知识库是一款企业 知识管理 工具,通过独立的知识库空间,结构化地组织在线协作文档,实现企业知识的积累和沉淀,促进知识的高度复用和流通. 云效知识库是 ...
- 知识管理、文档管理两手抓,全靠它!
知识管理和文档管理是两个相互关联的概念,两者之间的关系非常密切.知识管理是指对组织内外的知识资源进行收集.整理.存储.共享和应用的过程,旨在提高组织的绩效和创新能力.而文档管理是指对组织内外的文档资源 ...
- 文档管理对人力资源部门的重要影响
文档管理对人力资源部门的重要影响 当人力资源的管理功能是基于纸张或依赖于 Excel 电子表格.共享驱动器和其他无法与其他系统共享数据的软件等技术时,人力资源管理既耗时又耗费劳动力.用数字工作流程取代 ...
- 文档管理使人力资源部门受益的 7 种主要方式
文档管理使人力资源部门受益的 7 种主要方式 在 COVID-19 大流行期间,人力资源 (HR) 必须迅速调整工作重点,将其活动重点重新放在远程劳动力的需求上.尽管许多员工继续在家工作,但安全的工作 ...
- 软考-信息系统项目管理师-信息文档管理与配置管理
目录 14.1.信息系统项目相关信息(文档)及其管理 一.信息系统项目相关信息(文档)种类 二.信息系统项目相关信息(文档)管理的规则和方法 14.2.配置管理 一.配置管理的概念 1.配置项 2.配 ...
- 如何挑选文档管理软件?
21世纪,一个全新的信息化时代,从最初的传统办公到现在的信息化办公,一个世纪的跨越造就了各种大数据的诞生.然而在这个数据横行的时代,文档管理产品市场逐渐兴盛起来,文档作为企业的智慧信息的载体,在企业发 ...
最新文章
- leetcode 526. Beautiful Arrangement | 526. 优美的排列(回溯)
- AGC023D - Go Home
- 【CCF】 201604-1折点计数
- RGB to xml(labelimg应用)
- Machine Learning 务实----Applying deep learning to real-world problems
- 3.4选择性嵌入服务容器
- Oracle 官宣:腾讯 JDK 18 国内第一!
- 《FLUENT 14.0超级学习手册》—— 导读
- 分享:在微信公众平台做HTML5游戏经验谈
- 腾讯云神图·人脸识别(Face Recognition)常见问题的解答
- 影像信息提取之——多时相影像动态检测
- 泛微oa流程表单之取值弹窗
- 各种数据库中的dual表
- 导弹气动估算matlab,基于Fluent的导弹气动特性计算
- 5分钟摄像头抓拍一次,居家一天至少89次!尚德员工:连厕所都不敢上
- rpmbuild php,linux RPM打包时出错,求助!!!
- typora+pandoc:markdown文本转换成word(也可把word转换成markdown哦)
- 循环闹钟c语言,闹钟设置四天一个循环,自定义周期循环提醒便签
- 《图像处理实例》 之 二值图像分割
- 网络渗透作业202105110124郭静