Home
>
设计文档管理
>
软件文档管理规范
软件文档管理规范

time:2020-07-26 11:52:01

author:重庆佰鼎科技有限公司

【Font size: big medium smail

本文由重庆佰鼎科技有限公司提供,重点介绍了软件文档管理规范相关内容。重庆佰鼎科技有限公司专业提供设计文档管理,公司文档管理,文档管理器等多项产品服务。一直秉承诚信至上,产品优先,服务优先,客户优先原则,为您提供最优质的产品服务!

软件文档管理规范总结了自己这几年管理各种产品文档的经验,分享给大家。主要分为三大部分,本地文档如何管理,然后怎么管理同一版本的PRD,以及如何共享PRD给同事。一、本地文档如何管理项目通过文件夹管理经受过的项目比较多,我按照“开始月份~结束月份+项目名称”的方式来命名,方便后续回顾。按照职能设子目录比如我们是PM,那主要资料应该是需求文档,其次经常被传达的可能是用户需求、可能需要了解学习的技术资料、每个人都需要了解的公司资料。软件文档管理规范

产品文档按照平台不同设子目录这一步可能不是必须的,比如前端PM就可能跳过这一步。产品文档按照版本号设子目录文件夹命名格式为“版本号+核心模块名称”,比如客户端的详情如下。每个版本使用迭代记录记录该版本的所有内容,首先是PRD、其次是视觉稿、交互稿、以及相关技术资料。我的产出物是PRD,是用Axure画出原型,然后带交互和逻辑,含流程图。源文件就是rp文件,如上所述。

需要注意的是,对于涉及到前后端的版本,我一般放在客户端文件夹中。

分支版本请命名规范有时候一个大版本除了主线版本之外,还有分支版本,此时我会单独起一个新rp文件。

分支版本往往是某个模块,命名规则为“版本号+模块名称+期数”,这样命名的好处是可以搜索出该功能的所有版本,方便回顾复盘。

同一版本PRD在内部使用表格记录变化在axure中单独起个页面,用表格记录每次的修改记录。同时会批量发布到git。

二、同一版本如何管理原则是前后版本使用不同目录,同一版本使用SVN提交。

生成原型到git的本地目录让技术童鞋给你们分配一个git目录,然后安装smartgit,将生成后的axure原型文件夹放到该目录下。

注意你也可以同时把视觉稿和视觉规范以及标注放到这个文件夹里面。

提交的时候写上更新日志每次更新原型请写更新日志,然后批量将更新日志和文件夹更新到git服务器。

查看并回滚该PRD到任一历史版本最终生成了每一个文件夹的迭代记录,可在gitlab官网查看,并回滚到历史版本,方便团队复盘使用。

查看所有提交记录三、共享PRD给相关人员共享网址给项目组成员问负责搭建git的同事提供在线网址,然后将它给到对应的项目组成员即可。

更新原型到该目录以后每次用axure修改之后,先添加修改记录,然后生成原型到该目录,然后再提交日志即可。

最后说点额外的话,

本地文件请尽量使用Dropbox、坚果云、svn、git等云同步软件做备份。

虽然我主用axure,但其实justmind、mockplus这种客户端软件也是支持本文的管理方法。

另外命名规范了是为了方便后续搜索,当然你也可以按照目录查找资料。

作者:浪子,关注公众号langzisay查看全部文章,浪子PRD系列http://51prd.com。软件文档管理规范

Reprint please indicate:http://www.cnsoftweb.com/wdgl-3229.html