沃支付SVN版知识库管理办法
(试行版)
2012-5-13
修改历史
修改时间 修改内容 文档版本号 2013-3-18 创建 2013-3-28 调整内容 2013-4-3 调整文档目的 V0.1 V0.7 V1.0 V1.0 编写/修改人 崔莹峰 崔莹峰 徐云飞 崔莹峰 审核人 2013-5-13 1、删除wiki管理部分; 2、调整知识库内容范围、svn搭建方案和权限管理内容
目 录
目录
第一条. 第二条. 第三条. 第四条.
目标和职责 ........................................................................................................ 4 知识库内容范围 ................................................................................................ 4 svn搭建方案 ...................................................................................................... 5 权限管理 ............................................................................................................ 7
第一条. 目标和职责
1、 为确保公司产品和平台建设过程透明化,使得产品建设团队能够有效把控平台建设状况,
同时,也为持续提升平台质量,持续积累业务方案和技术知识,特建立沃支付知识库。除此之外,沃支付知识库也可作为全公司流程制度,规范、规划、公告等文档的共享平台。
2、 全公司各部门或业务单元对知识库的持续建设承担职责。其中,产品建设知识内容由产
品团队和技术团队各业务单元分别维护,各部门或业务单元的公开性文档各自分别维护。 3、 为了保证知识库的建设有序、知识合理组织、有效运行,特设立知识库管理岗(兼职),
负责知识库建设方案制定和维护、知识库安全运行保障、知识库用户和权限管理、知识库使用说明和帮助等工作。
第二条. 知识库内容范围
1、 业务及技术规范:包括支付公司系统的业务规范、业务模型、总体架构和技术规范。其
中:
业务规范根据产品线架构分别描述产品线以及产品的功能要求、业务流程、规则以
及相关非功能需求;
业务模型是在业务规范的基础上形成的业务实体描述以及实体之间的关系描述,例
如:客户模型,用户模型,账户模型,产品模型,安全模型等等;
总体架构是为了实现业务规范和业务模型相关要求,从平台建设维度对IT设施的规
划、平台及系统职能界定和分配、平台及系统之间关系描述、数据分布及物理部署规划要求。
技术规范根据产品线和平台架构分别描述各子平台的技术实现要求,其中包含业务
模型、架构以及各功能的技术实现要求等。
2、 产品需求:包括产品/业务需求文档、产品/业务需求分析文档。在此需要说明一下产品
需求和业务规范的的关系,由于支付公司产品具有互联网特色,产品需求文档先行发布,后期业务逐渐稳定后再形成业务规范,为了便于后期业务规范的整理,建议产品需求文档在编写时向业务规范的编写要求靠近。
3、 产品总体设计,包括平台总体设计说明文档以及相关参考资料,以架构版本为纬度分别
组织目录结构,每个架构的版本下可按照划应用层、标准产品层和能力支撑层平台分类组织为三个目录,属于某个平台分类的所有平台再以平台为单位划分目录维护在分数平台分类目录,每个平台下再以版本组织目录结构进行管理。
4、 系统详细设计,包括数据库设计文档、系统详细设计说明文档、接口清单以及相关参考
资料,以数据库设计和系统设计两个纬度组织目录结构。
5、 产品指南,包括技术或业务、运营文档、培训资料;以及用户手册、运营方案和运营数
据、工程部署方案和数据信息等。
6、 流程制度,贯穿所有产品和平台建设过程中产生的各种流程和制度文件,如上线流程、
系统变更流程、svn账号申请流程、厂商管理办法等。
7、 软件工程规范,贯穿所有产品和平台建设过程中产生的各种示范性文档,如项目立项、
设计、实施、验收、运维等阶段的模板和示例文档。
公司同时采用svn和confluence两种技术方案对知识库进行管理,其中svn可用于对知识库文档的版本管理,confluence则主要用来对知识库文档进行展示并进行必要的组织。svn和confluence都支持良好的权限分配管理机制。本管理方法只限于SVN。
第三条. svn搭建方案
1、svn目录组织结构如下图所示:
01-业务规范沃支付知识库02-业务模型00-业务及技术规范03-总体架构01-产品需求04-技术规范架构0.8架构2.001-逻辑架构02-信息架构03-数据架构04-物理架构总体设计说明书01-话费托收资金归集应用平台01-应用层02-产品总体设计架构0.8架构2.003-能力支撑层内部定制收单应用平台---电渠前置系统详细设计说明书客户端平台---系统详细设计说明书公共事业缴费平台--公缴WEB展现系统详细设计说明书……02-标准产品层02-内部定制收单应用平台V0.8V2.0…………………………00-数据库设计03-系统详细设计01-系统设计04-产品指南05-流程制度01-文档模版99-软件工程规范02-文档示例
4、 搭建方法
方案:在现有公司svn服务器,创建Repository “知识库”。 存储容量:100G
操作权限:请参见权限管理章节。
A、 svn管理员具有整个系统的管理权限,包括增删改等。 B、 svn管理员可管理系统所有用户,并负责分配用户权限;
C、 知识库管理员拥有整个沃支付知识库内容的管理权限,包括增删改等。
D、 知识库管理员对知识库所有目录的权限根据平台建设团队现状进行分配,然后通过
svn管理员进行系统权限分配。
访问入口:http://10.192.14.157/svn/architect/知识库
第四条. 权限管理
1、 为保证信息的安全和管理性,知识库实行分级管理。
2、 知识库管理员负责制定知识库的管理制度和相关流程规范,进行总体知识库的积累和管
理,并对业务及技术规范、软件工程规范、流程制度等通用信息进行管理; 3、 支付公司所有成员可以查看知识库所有内容,监督知识库的合理和安全使用。 知识库文分类 业务及技术规范 业务规范 业务模型 总体架构 技术规范 产品需求 需求说明书、需求分析说明书、产品需求规格说明书等 逻辑架构图、系统概要表、信息架构图、接口概要表、数据架构图、数据库概要表、物理架构图、物理部署概要表等 知识库具体文档 使用者权限 备注 admin:RW ALL-PAY:R 产品总体设计 系统详细设计 产品指南 总体设计说明书 其他参考资料等。 系统详细设计说明书 其他设计相关资料和记录等。 需求说明书、需求分析说明书、产品需求规格说明书等 流程制度 软件工程规范 文档模板和范例等 4、 权限分配和明细:
admin:知识库管理员,由架构组同事担任 ALL-PAY:表示公司全体成员 R:表示读权限 W:表示写权限 RW:表示读写权限
因篇幅问题不能全部显示,请点此查看更多更全内容