Android开发项目管理7宗罪之五——项目组个性文档文件的管理

你这里提到的文档，主要包括：接口开发文档、技术框架说明文档、新框架踩坑文档、第三方SDK开发说明文档、工作交接文档等等。

接口开发文档，这个好理解，基本上稍大点的项目，后台开发都会提供，但大多数项目管理，都存在一个通病，那就是原始文档能够提供，但正确率不敢保证；后续开发、维护、增删引发的内容变动并不会及时的更新到接口文档中去，很不方便项目的维护。所以接口文档要及时更新。内容应该是要细化到每个入参，每个返回字段的作用内容说明，数据格式等等。
另外，开发中我发现，后很多接口，即便是某个入口参数传错了，也能够成功的拿到数据。这给后面的调试和排查问题带来很大的干扰，后开和前端、移动端都不知道有没有出错，错在哪里。这种情况应该杜绝，参数错了就访问-失败，没什么好说的，很快就能够定位到问题在哪里，是谁的问题。
/
第三方SDK开发文档，主要是项目中采用第三方公司提供的服务SDK时的文档，他能够指导开发人员完成开发工作，当对应部分功能出现问题时，能够从中找到解决方案，因此这种文档也颇为重要，不容有失，越详细越好。

工作交接文档，这个很好理解，想必也是大家最头疼的文档，因为十回有九回半拿到的这个文档都是死然并卯的，毛用没得还落人口实，看，我离开时是留有很详细的交接文档的。有问题怪我咯？心里总是万马奔腾，而且还是满身草的那种。。。扯远了。该文档应该包含如下内容：该员工负责了那些功能模块，目前这些功能模块的开发进度，各模块的功能说明，各模块所在的分包packge，各功能模块的入口，完成情况，是否有遗留的问题，重点注意事项等等。
这份文档相当重要，它能有效的帮助接替者快速且全方位的掌握对应功能模块的现状，了解现状的实际情况，掌握重点难点，不需要花费太多的时间和精力去完全踩一遍项目的坑就能上手高效地开展工作。这里以上一篇《Android开发项目管理7宗罪之四——开发任务的分派》的内容为例，前任开发中离岗时，对所负责的功能模块完成情况只字不提，存在的问题只字不提，重点难点只字不提，只是大概说了下各子功能所在的包，笔者无奈之下接手后，不得不从头到尾的reView一遍他的代码，理解开发思路，同时结合流程图，接口文档，需求文档确定功能模块的现状，最后惊讶的发现，其实该功能只是完成了总工作量的30%。后面花了接近3周的时间才完善该功能，单单是掌握该功能模块的现状，梳理逻辑就花了一周。最后感叹，将近3周，还不如我自己从 0 开始开发来得好，这样虽然工作量多了些，但不必如此劳心劳神劳力。

最后我们说说新技术/新框架的踩坑文档。

踩坑文档：主要是记录在使用新技术/新框架过程中遇到的各种问题以及解决这些问题所经历的惨烈过程所形成的的文案。

以笔者曾经所在的一个项目为例，该项目为了节约开发时间和成本，快速集成项目，采用了蚂蚁金服出品的mpass框架，该框架被用于名声极响的支付宝等项目上。但不是开源框架，若要使用，是需要蚂蚁金服收费授权的，所以市场上鲜有相关资料介绍，对其很是陌生。这不，在该项目集成mpass框架初期，遇到了各种各样的坑，以至于团队不相信蚂蚁金服的官方文档的真实性。而蚂蚁金服派出来的售后服务伙伴能够提供的帮助比较有限，往往不能有效的解决问题。若要蚂蚁方面派出高级专家支援的话，对方人员的一切开销级补贴都需要项目组一力承担，成本压力巨大。而不得不咬着牙关参考着官方文档自己研究，直接导致了不少员工不得不开启9-10-6/7的工作模式而项目组规定21:00之后打出租车报销费用，这样一算下来，项目组近20号人打车费用都高的吓人了。

经过数月的攻坚，框架集成成功，前端开发也成功集成进来，项目能够得以推进。但很遗憾的是数月的攻坚工作并没有留下任何一篇有关踩坑mpass框架集成的文档，开发者离岗后，后续接手的人对mpass矿机一无所知，一脸懵逼，工作无法尽快开展。这时不得不向项目负责人咨询，但项目负责人更喜欢的是这时候你能够加班加点的看代码，看官方文档研究出问题来。这时候，我真想说——研究NMDNGB，加个CZ的班，加班你这也叫项目管理，球技术文档都没留下一个，你这不是逼人再去踩一次前面的坑么？你就这么管理的啊？算了，得过且过，将就用着吧！！！……

所以，一定要记住，重要的新技术/新框架的技术文档、踩坑文档一定要写好，越详细越好，越有利于后面工作的开展，省时省力省成本……尤其是作为项目的直接管理者，一定要大力推动这件事情，一旦项目团队出现成员变动，这些资料就将大显神威！！！

Android开发项目管理7宗罪之五——项目组个性文档文件的管理相关推荐

产品开发的 11 宗罪
题图 | created by freepik 最近图灵君在翻看一本比较小众的书:<硬件产品设计与开发:从原型到交付>,没成想翻开前言和第 1 章都很惊艳,尤其是第 1 章总结的<产 ...
计算机毕业设计Java智慧社区信息管理系统开发（源码+系统+mysql数据库+lw文档）
计算机毕业设计Java智慧社区信息管理系统开发(源码+系统+mysql数据库+lw文档) 计算机毕业设计Java智慧社区信息管理系统开发(源码+系统+mysql数据库+lw文档) 本源码技术栈: 项目 ...
android在线预览excel文件格式,Android打开doc、xlsx、ppt等office文档解决方案
原标题:Android打开doc.xlsx.ppt等office文档解决方案 1.Android端有什么控件可以直接显示office文档吗? 很抱歉没有,对于ios而言想要显示office文档,直接调 ...
太牛了！我把阿里、腾讯、字节跳动、美团等Android性能优化实战整合成了一个PDF文档
安卓开发大军浩浩荡荡,经过近十年的发展,Android技术优化日异月新,如今Android 11.0 已经发布,Android系统性能也已经非常流畅,可以在体验上完全媲美iOS. 但是,到了各大厂商手 ...
【信息系统项目管理师】第十四章文档与配置管理思维导图
[信息系统项目管理师]第十四章文档与配置管理思维导图文档管理和配置管理是第十四章总两大知识板块. 文档管理信息系统中的文档按质量分级可以分为1-4级分别是最低限度文档,内部文档,工作文档,正式文 ...
基于JAVA大学生创新创业项目管理计算机毕业设计源码+系统+lw文档+部署
基于JAVA大学生创新创业项目管理计算机毕业设计源码+系统+lw文档+部署基于JAVA大学生创新创业项目管理计算机毕业设计源码+系统+lw文档+部署本源码技术栈: 项目架构:B/S架构开发语言: ...
2009年下半年信息系统项目管理师上午试题分析与解答文档
2009年下半年信息系统项目管理师上午试题分析与解答文档转载于:https://www.cnblogs.com/cody/archive/2010/05/20/1739948.html
开发人员，请不要抱怨项目没有文档
每当我们切入一个新项目时,我们发现项目中的文档总是少的可怜,而且里面的设计与当前的系统设计严重不符,有些甚至在架构上出现了严重的偏离.于是我们问待交接人,为什么项目中只有这么点文档,而且文档的内容也不 ...
计算机毕业设计Java校园便利店信息系统开发（源码+系统+mysql数据库+Lw文档）
计算机毕业设计Java校园便利店信息系统开发(源码+系统+mysql数据库+Lw文档) 计算机毕业设计Java校园便利店信息系统开发(源码+系统+mysql数据库+Lw文档) 开发语言:Java语言 ...
java计算机毕业设计个人连锁民宿信息管理系统设计与开发系统（修改）MyBatis+系统+LW文档+源码+调试部署
java计算机毕业设计个人连锁民宿信息管理系统设计与开发系统(修改)MyBatis+系统+LW文档+源码+调试部署 java计算机毕业设计个人连锁民宿信息管理系统设计与开发系统(修改)MyBatis+ ...

Android开发项目管理7宗罪之五——项目组个性文档文件的管理

Android开发项目管理7宗罪之五——项目组个性文档文件的管理相关推荐

最新文章

热门文章