前端开发工作中对于一些非技术问题经验总结

1.按时归档接口文档或在接口内完整注释接口文档

很多时候开发流程都是不完美的,比如会存在接口对接只给到部分文档,只能边写边开发,这时候由于后端持续更新文档(doc/swagger/甚至是通过聊天),接口文档会散布的到处都是,这时必须在一个统一的地方归档所有接口的文档,以备不时之需

我的做法是在每个项目中,维护一个文件夹/service,所有的接口按页面功能划分为功能名Service.js,并在接口的注释中同步该完整的接口文档

当后续有修改,或者项目需交接时,无需另外起文档,直接看代码注释就可以,十分之方便

2.后端不提供接口及接口文档的自闭开发流程

项目中经常碰到的一个情况是,后端接了几个项目,来不及做,产品上线时间又超级肝,对接联调只有1,2天时间,但到联调之前你都是拿不到后端接口的

这时候可以无视后端接口返回数据,直接根据业务逻辑先把交互做好,所有需要接口数据的地方全部自己模拟一套数据结构出来,可以把流程走通,到对接时候只要调用接口并把接口返回的数据和模拟的数据结构匹配即可

这样至少可以独立完成70%左右的开发量,剩下一些比如提前不知道后端需要前端自己接口校验用户提交数据是否有效,否则不能提交等需求,就没有什么特别好的办法了(顺便吐槽一下把校验和提交分开写的后端也是真的只配crud)

3.跨项目间断开发

我们先举个简单的例子,本来你在开发一个A项目,项目体量不小,做了一个月后,突然有个B项目的需求进来,优先级还比A高,这时,你必须先去完成B项目直到上线后才能继续开发A项目,但B项目也要一个月左右的开发

这时候坑就出现了,如果你不在开发B项目之前先记录A项目的工作进度,待开发功能,开发注释等,等你B项目上线后,回头再开发A项目,会发现仿佛在接手别人的二手半成品项目一样.

这时候连之前A项目做到什么进度,可能自己都有点搞不清楚了

如果抽象出来看,B项目后,还有C,D,E项目穿插在中间,怎么办呢?

目前我是这样做的:

1.在没有特殊要求的开发过程中,为了追求速度,代码是基于语义化书写,并辅助少量业务流程逻辑的注释
2.维护一个README文档,里面写清楚了该项目的背景,编译方法,发布环境
3.维护一个PROGRESS文档,列出所有要开发的功能模块,当前还有多少模块没完成,可以等项目开发完要上线再删掉
4.文档需求等记录文档最好跟着项目走,可以不放到git里,但至少在项目里,找起来也方便

维护项目的README文档很重要!!!
维护项目的README文档很重要!!!
维护项目的README文档很重要!!!

以后有新的心得了会继续补充,欢迎理性讨论