总则

所有文档以在线文档系统(Online Documentation System,下文简称ODS)为中心进行管理,ODS不方便存放的东西才放到SVN(或Git)。因为ODS有URL链接可以点击直达,比起基于电脑文件系统的管理方便得多,且直接支持手机查看。

ODS规范

ODS通常以“空间”或者“目录”来区分项目,而“空间”会更独立。首先,由项目经理或产品经理为项目创建一个空间。空间内的目录规范如下:

(缩进代表子目录或子文件)

项目主页
  参考信息(也可以写在主页上。包括术语表、代码地址、SVN地址,各种服务器URL等)
  x.x.x(版本号)
    需求总表
    立项
    各个需求文档(以需求名称命名文档名。如果用Axure写的,在这里填写它的SVN预览地址。)
    测试文档(以作用命名文档名,主要是用例和报告)
    结项
  xx专项
    ...(专项文档,跨版本的需求统筹、跟版本无关联的运营活动需求等)
  通用文档...(包括第三方文档等,跟具体版本无关联)
  垃圾桶
    ...(废弃的运营活动需求、不再使用的第三方文档等移动到这里)

PS:项目组的IM公告栏只放置当前版本页的ODS链接和提测记录。

SVN规范

谁先需要上传就谁创建目录。目录示例如下:

根目录(项目文件)
  项目A
    微信支付接口文档.docx
    测试工具.exe
    ...(其它通用的版本无关文件)
    x.x.x(版本号)
      需求文档
        ...(Axure源文件和导出的HTML文件夹)
        ...(各个需求的word,以需求名字命名)
      设计文档
        ...(ps源文件,设计稿、标注、切图)
      测试文档
        ...(Xmind、Excel测试用例整理等)
  项目B
    ...

PS:SVN需要手动Update才能看到别人的修改,并且只能在资源管理器里打开,很不方便。可以请开发或运维同学做一个预览服务器,把目录结构映射成Web URL来供浏览器访问,并能通过SVN的hook功能实现实时更新。(Git也可以,具体方法请百度)

本系列文章的目录:https://hursing.blog.csdn.net/article/details/88025790

Logo

开放原子开发者工作坊旨在鼓励更多人参与开源活动,与志同道合的开发者们相互交流开发经验、分享开发心得、获取前沿技术趋势。工作坊有多种形式的开发者活动,如meetup、训练营等,主打技术交流,干货满满,真诚地邀请各位开发者共同参与!

更多推荐