2018-07-19

#欧那产品协作使用帮助

打算试用通过aliyun的git服务器管理产品文档和设计资源，使用方式如下：

## 加入项目组

1. 注册一个aliyun个人账号

2. 使用sshkeys 工具，生成你的ssh keys

2. 在 https://code.aliyun.com/profile 找到 sshkeys ，添加自己的 ssh key

3. 把你在阿里云的 username发给Eric,等等添加到项目

4. 通过git 工具，获得文档和素材的同步## 获取项目资源- 推荐产品和设计部门使用Sourcetree管理文档和素材，这个软件能支持mac和win；下载链接 https://www.sourcetreeapp.com- 在sourcetree“新建”项目，填写 源url（登录code.aliyun获得），目标路径（本地保存路径）和项目名称，选择“克隆”项目。克隆完成，你会获得项目当前所有信息。- 每个项目组，共享一个文档和资源项目。- 善用markdown，win设备下推荐 markdownpad，mac下推荐Haroopad，也可以自选其他markdown工具- markdown 语法说明 https://www.jianshu.com/p/b03a8d7b1719## 项目结构和命名规范### 目录结构- 第一级 项目 - 第二级 版本 - 第三级 资源类型 - 第四级 资源和资源版本### 命名规范##### **项目** 的命名年月+项目名称> 例如 **1806-消息通知模块**##### **版本** 的命名年月+项目名称+版本号> 例如 **1806-消息通知模块-V1.0**注意这里的版本号是指项目版本号，不是文档版本号，年月指项目开始的年月##### **资源类型** 的命名资源类型包含以下类型，如有需要会再增加 - **ProjectPlan（项目立项说明项目计划）** - **UI（设计资源）** - **PRD（产品需求文档）** - **DRD（交互说明文档）** - **WBS（工作分解结构-开发负责人/项目负责人撰写）** - **TestCase（测试用例）** - **开发设计文档** - **周报** - ##### **资源和资源版本号** 的命名年月日+资源类型+资源版本号+资源版本类型> 例如 **180712-UI-V0.34-Alpha**- 年月日指上传的年月日- 资源类型包含以下类型，如有需要会再增加， - **ProjectPlan（项目立项说明项目计划）** - **UI（设计资源）** - **PRD（产品需求文档）** - **DRD（交互说明文档）** - **WBS（工作分解结构-开发负责人/项目负责人撰写）** - **TestCase（测试用例）**- 资源的版本号是资源的更新迭代的版本号，和项目版本号不同- 资源版本号类型 分为以下类型 - **alpha**（未评审认定的版本） - **RC**（经过评审，具备进入开发条件，但可能还有瑕疵的版本） - **release**（最终确认版本）### 文档类型的要求##### PRD/DRD支持以下三种方式撰写PRD文档，不再接受word/pdf/图片等棒棒更新文档- **markdown + 更新日志**- **石墨文档 + markdown更新日志**- **google doc + markdowm更新日志**##### UI支持以下几种方式提交UI设计稿- **Normalize.css**- **蓝湖**- **zeplin**- **psd（仅限简单项目）**- 欢迎大家推荐其他好的工具UI设计师需要保留原始psd/sketch/ai文件，方便后续修改，但原始文件可以不上传到项目。##### TestCase- **excel + markdown更新日志**- **google 表格 + markdown更新日志**- **石墨表格 markdowm更新日志**##### 更新日志的撰写要求- 请遵循markdown的语法规范（很简单的）- 每次版本号更新需要写更新说明- 更新说明包含更新人/更新时间/更新内容描述### 把修改推送到服务器