项目文档怎么写(项目文档管理规范-记得收藏)

前言:听曲一首

周杰伦-兰亭序 (纯音乐).mp34:09
来自软件开发从业者

1. 引言

1.1 文档目的

为加强文件的管理,确保文件管理的规范化、合理化,避免信息机密的泄露,便于各种文件合理有效地保存与利用,便于对文档的查阅和文档版本的控制,起到对技术文档编写者的指导性原则,特制定本规范。

1.2 适用范围

适用对于软件开发的各种技术资料、代码,各种项目管理过程全过程产生的文档。

2. 技术文档管理规范

2.1 配置管理库目录结构

目前使用SVN(Git)配置管理工具进行对项目文档、代码的版本管理,项目开发过程中所有项目文档和代码必须全部存放到SVN(Git)配置库中。SVN(Git)配置库分为开发域、管理域【我.爱.线.报.网.】52xbw .cn 每日持.续更新.可.实操.的副.业.、基线域和产品域。开发域对项目开发过程中的文档、代码的版本管理;管理域是项目管理过程中产生的文档版本管理;基线域是项目在各阶段形成基线后文档、代码的管理;产品域是存放已经发布并交付客户后的产品及相关文档。

配置库目录结构参见:《配置库目录结构》文件包。

2.2 文档命名规范

2.2.1 文件在配置库中的命名规范

项目中的文件包括两大类:技术文档、管理文档;该两类文档以及过程域相关文档都纳入配置库中管理。

技术文档:属于产品组成部分的工作成果,如项目计划书、需求相关文档、设计相关文档、源代码、测试用例等。

管理文档:项目管理和机构支撑过程域中产生的文档。这些文档虽然不是产品的组成部分,但是值得保存。比如:项【我.爱.线.报.网.】52xbw .cn 每日持.续更新.可.实操.的副.业.目周例会、项目周报、项目日志、用户需求跟踪矩阵、风险识别等。

2.2.1.1 过程域文件命名规范

过程域文件是指过程定义文档、各种规程及相关模板等,文档保存在SVN配置管理库中。

过程文件命名为“XXX过程”,“XXX”为过程域全称。如:技术解决方案过程域的过程文件为“技术解决方案过程”。

规程文档以实际的内容为标识,如:XXX规范、XXX规程、XXX指南等。

模板文档的名称与实际在项目运用过程中用到的名称保持一致,统一为已定义的模板文档名。

2.2.1.2 技术文件命名规范

技术文件是指项目开发过程中产生的技术文档,文档保存在SVN(Git)配置管理库中的文件命名规范格式为:“YYYZZZ”。其中:

“YY【我.爱.线.报.网.】52xbw .cn 每日持.续更新.可.实操.的副.业.Y”为技术文档名称。

“ZZZ”为自定义项。一般为文档版本号;也可为版本号+日期。其格式如下图:

2.2.1.2技术文件命名规范

示例:

XXX项目的“用户需求说明书”文档,在SVN(Git)配置库中的标识为:“用户需求说明书V1.0”。

2.2.1.3 管理文件命名规范

管理文件是指项目管理过程中产生的文档,文档保存在VSS配置管理库中的文件命名规范格式为:“YYY_ZZZ”。其中:

“YY…Y”为管理文件名称。

“ZZZ”为自定义项,如果没有,则该项可以缺省。

示例:

示例1:“个人周报_小王”表明:此文档为小王的个人周报。

2.3 文档标识规范

文档标识规范指文档的唯一标识,对于文档均有一个文档标识。

2.3.1【我.爱.线.报.网.】52xbw .cn 每日持.续更新.可.实操.的副.业. 过程域文档标识

对于过程域的文档标使用中文全称命名。

2.3.2 项目文档标识

项目文档均存放在项目指定的文件夹下,文件夹名称命名为项目中文名称。

对于项目中的文档标识格式为:“YYY_ZZZ”。其中:

“YYY”为技术文档名称。

“ZZZ”为自定义项。一般为文档版本号;

示例:

XXXX项目的“用户需求说明书”文档中文档标识为:” 用户需求说明书V1.0”。

2.3.3 配置项标识

为了管理配置项,在配置管理过程中,配置员需对每个配置项进行标识;

XXX-YYYY-ZZZZ_XXXX

XXX:公司简称

YYYY:年份

ZZZZ:文档编号

XXXX:文档名称拼音首字母

2.4 版本标识

项目文件一般包括技术文件和管理文件两种【我.爱.线.报.网.】52xbw .cn 每日持.续更新.可.实操.的副.业.,其中技术文件如:软件需求规格说明书、概要设计、详细设计和代码等。管理文档包括项目计划书、系统测试计划书等,下面对这些文档的版本标识应遵循以下规范:

版本的基准格式为:Vx.y:

1、新起草的文件版本定为V0.1版。

2、逐步完善的文件但还没有通过评审的,版本升级为V0.1~0.9版。

3、通过正式评审的文件版本升级为V1.0版,可对外发布。

4、经过一级、二级变更的文件,可升级为V1.y版,“y”可根据次数依次递增。

3. 文档安全管理

项目在研发过程中,所以的技术资料(包括:技术文档、管理文档、代码)都保存在部门内部的配置管理库SVN中;配置库根据人员的岗位进行权限分配。

配置管理库SVN的权限管理:

角色【我.爱.线.报.网.】52xbw .cn 每日持.续更新.可.实操.的副.业.

操作文档项

操作权限

部门经理

SVN配置库中的所有权限

所有权限

项目经理

所负责项目的文档所有权限

所有权限

需求分析员

用户需求说明书、软件需求说明书、界面原型、需求跟踪矩阵等。

文档的增、删、改、查的操作,其它文档可查看

开发主管

软件概要设计、数据库设计、详细设计、代码等

文档的增、删、改、查的操作。(其它文档可查看)

程序员

详细设计、代码等

文档或负责的模块增、删、改、查的操作。(其它文档可查看)

配置管理员

所负责项目的文档所有权限

所有权限

美工

界面原型。

界面原型的增、删、改、查的操作。需求文档查阅功能

测试工程师

系统测试用例、系统测试报告

系统测试用例、系统测试报告的增、删、改、查的操作。需求文档查阅功能

4. 知识产【我.爱.线.报.网.】52xbw .cn 每日持.续更新.可.实操.的副.业.

为确保公司的知识产权得以良好的保护,避免因知识产权流失或泄漏造成公司的重大损失,制定本办法,本办法适用于研发部门,并遵循公司的保密政策。

4.1 知识产权的范围:

技术秘密和商业秘密:指公司研制开发的与知识产权相关的各种技术文档、技术资料、代码、电脑光盘、荣誉实物、证件等不同形式的体现或隐含知识产权的历史记录或实物。还包括保存有知识产权信息的计算机硬盘、软盘、移动式存储设备和录音带、录像带等磁介质载体。

4.2 知识产权的内容:

软件技术资料(是指正式启动的项目在其生命周期内产生的、经审核通过后的所有文档),源程序、数据库、技术方案、软件产品、技术发展规划等。

员工在职期间编制出来的与工作相关的各类技【我.爱.线.报.网.】52xbw .cn 每日持.续更新.可.实操.的副.业.术知识文件

4.3 知识产权的秘密等级

知识产权的秘密等级一般分三个级别:绝密级,机密级,秘密级。

下表是知识产权保密等级

密级

范围

备注

绝密

系统验收(或发布)后的源代码、通过审核的技术文档(包括:需求文档、设计文档、测试报告、验收报告等)

保存在公司的“企业文档(或知识)管理系统”中

机密

各种技术规划、编码规范、设计规范、以及正在研发的相关技术文档技术方案

保存在部门的SVN配置管理库中

秘密

项目管理过程中的各种资料:项目周报、项目日志、项目质量记录、评审记录、项目档案、用户手册、项目

保存在部门的SVN配置管理库中

推荐阅读

给力项目线报网会员可免费下载 加入会员
友情提醒: 请尽量登录购买,防止付款了不发货!
QQ交流群:226333560 站长微信:qgzmt2
温馨提示:本站提供的一切软件、教程和内容信息都来自网络收集整理,仅限用于学习和研究目的;不得将上述内容用于商业或者非法用途,否则,一切后果请用户自负,版权争议与本站无关。用户必须在下载后的24个小时之内,从您的电脑或手机中彻底删除上述内容。如果您喜欢该程序和内容,请支持正版,购买注册,得到更好的正版服务。我们非常重视版权问题,如有侵权请邮件与我们联系处理。敬请谅解!

给TA打赏
共{{data.count}}人
人已打赏
行业资讯

快递能不能传播病毒(快递能传播病毒吗?潜伏期多长?与一般感冒区别?)

2024-8-27 18:39:48

行业资讯

电脑软件是什么东西(什么是电脑的软件系统?)

2024-8-27 19:00:18

0 条回复 A文章作者 M管理员
    暂无讨论,说说你的看法吧
个人中心
购物车
优惠劵
今日签到
有新私信 私信列表
搜索