
App功能文档

前言

目前App小有规模了，面临的问题也严峻了。具体问题是”没有文档”，我们一般都是面向测试开发，什么意思呢？就是有一个idea直接开始开发，快速出一个Demo。然后就开始了面向测试开发。测试，提问题，开发；测试，提需求，开发。小公司小团队，这也不算特别说不过去的，为了快嘛。这样投资人也能很快看到东西，以及看得到你在做东西，公司团队就能活下去。

问题

那我的问题是什么呢？就是如果一个App开发个1、2年就直接永远不更新了，或者是丢弃了，有没有文档也就无所谓了（前些年净做这个App了）。但是现在最后做的这个表现不错，准备一直扩展下去，将它当成唯一的App。使用插件方式(React Native或者Flutter)扩展，也就是类似国民App微信。

那么问题来了，两年前的代码如果部分功能需要重构的时候就看不懂了，特别是服务器配合Android重构了一些功能之后，苹果同事去做的时候完全没有文档，只靠测试来测到这个功能不能用了，然后查到接口出错，再找服务器人员，服务器开发再告知这个接口参数或者流程变了。

苹果程序员就会比较恼火，因为他的效率不高。那么到底需要一个什么样的文档能把目前暴露的问题都解决呢？

文档需要满足：

每个UI界面的所有可能，每个按钮所有可能？
功能点描述，接口参数讲解，调用流程都要描述吗？
达到换程序员完全看得懂。
部分功能踩过的坑？
Android/iOS如何保证底层逻辑设计一致呢？

谁有这方面经验，可以告知。

油管查看视频版问题描述。

网友建议

文档可细分为产品文档 产品说明 接口文档 代码文档。经过网友建议和一夜思考，得知文档改革无法一蹴而就。只能在每个阶段分别加强，形成合拢。

过程	现状	改进
需求诞生	一段口语化的文字或者一个讲解录屏	留底备查
需求整理	简单整理成文档	考虑更全面、覆盖所有可能性、特别模块需要整理出流程图
UI设计	出图	生成原型图、添加逻辑标注
后端接口开发	注释、口头告知、postman自测	标准的RESTful接口、。。。
Android前端	根据后端接口和UI图开发功能	添加更加丰富代码注释、抽出共用模块、每个模块文档注释充分
测试岗位	听后端和Android端讲功能来手动测试	生成测试用例文档，方便后期回归测试；尽可能自动化
iOS前端	手拿Android进行对比开发	根据文档开发，添加更加丰富代码注释、抽出公用模块、每个模块文档注释充分、尽可能和Android共用模块、同版本库

H5界面		同理Android
RN界面		同理Android

其他

再次得益于用心把问题描述清楚，答案自动找上门，我觉得经过一个小时写文章，录制视频。把这个问题抛出去的时候，内心已经开始有答案了。或许我应该报一个项目经理的课程来解决，这个岗位应该能解决我目前的问题。