夏眠鱼

Jul 20, 2016

App 项目文档管理

前言

一个 App 从需求到部署上线,会有产品组、项目组、开发组等的参与,每个阶段各组都会产生相应的文档,将他们整理起来也就形成项目文档,方便以后项目的维护和交接。考虑到其他组的学习使用成本,我们使用SVN来管理。

SVN 工具

  • Windows: TortoiseSVN、SmartSVN 等
  • Mac: Cornerstone、SmartSVN 等

各组职能

产品组

负责产品设计和 UI。

项目组

负责进度把控和 QC。

开发组

Android、iOS 和后台。

目录和权限说明

根据各组职能分配的目录结构和权限如下:
svn-app-achieve

上图给到的只有三级目录,下面是所有层级目录的详细说明:

设计

存放产品组产出的文档

需求分析

需求分析文档。

原型设计

包含灰度原型、交互原型、高保真图、切图和标注。

功能流程图

对于复杂的功能,画出流程图,方便开发和测试达成共识。

产品结构图

用思维导图画出 App 的整体结构,按功能模块划分。

开发

存放 Android、iOS 和 后台产出的文档。

源码说明

描述项目的目录结构、开发架构(MVC/MVP等)、使用的第三方SDK等 。

接口文档

接口文档包含请求类型、请求URL、请求参数、返回值、返回值示例等,最好使用自动化工具生成接口文档,如 Swagger 等。

部署

应用商店

存放 Android 或 iOS 应用商店申请上线的相关资料。

安装包

存放 Android 或 iOS 在测试阶段(alpha)、公测阶段(beta) 和正式发布阶段(release)的安装包。

OLDER > < NEWER