软件功能设计文档 后端开发完接口才给出接口文档,合理吗?你怎么看?
后端开发完接口才给出接口文档,合理吗?你怎么看?
一个非常好的问题。我是一个web应用程序架构师,多年来一直致力于回答这个问题。欢迎跟我来了解更多。
后端提供接口文档为时已晚,这是合理和不合理的。根据具体情况,总有解决办法。让我谈谈我的观点。
不合理:成熟的技术团队重视功能设计,在编写代码之前有完整的技术文档和功能定义。即使在TDD测试驱动的开发模式下,测试数据已经准备好了,那么接口逻辑就已经确定了接口文档是否编写好了,理清它们是很自然的。
-第一,主观原因。原因是多方面的,比如赶进度,没有时间,不懒得写,甚至在开发前没有仔细设计,在做的时候也有变化。真的没有好办法。
-客观原因:需求在变化,功能在变化,接口也在变化。所以,如果你写了一个文件,它的自然更新和维护?天哪?
有解决方案吗?建议尝试:[1]swagger接口文档,将文档集成到代码中,集成维护文档和修改代码,在修改代码逻辑的同时方便修改文档描述。
2、邮递员界面测试工具,导入导出JSON文件,高效的团队合作。Postman支持各种请求方法和配置环境变量,对返回的结果进行测试和验证,支持批量自动操作,可与自动构建系统集成。
word设计功能在哪里找?
1. 打开word并单击左上角的文件。
2. 进入“文件”页面,然后单击“选项”。
3. 单击“选项”以输入word选项,然后单击“自定义功能区”。
4. 在“自定义功能区”页面上,选择“工具”选项卡。
5. 选择“工具”选项卡后,可以看到每个工具下都有一个设置。单击“添加”将此工具的设置添加到工具栏。
6. 如果要开发工具,请选中右侧的“开发工具”,然后单击“确定”。
7. 单击确认后,工具栏将显示开发工具。
怎么写设计文档?
首先,让我们谈谈开发人员不编写设计文档来开发产品的缺点。80%的程序员开发没有设计文档的产品。最终的结果是自己的设计无法实现。如果将来有两组程序员,一组是产品功能设计师,一组是代码搬运工,那么我想他们的工资可能是8:2,或者根本不需要后者,后者会被机器直接杀死。
软件开发,架构第一,优秀的设计文档可以让开发人员少走弯路,设计文档越详细,考虑越全面。首先,它可以大大减少bug在自己设计的程序中所占的比例,帮助程序员理清思路,同时让别人很快理解你的程序。
如何编写一个好的设计文档?在设计文件的开头,要说明设计的实际背景、编写本设计文件的要求、要解决的问题、要达到的效果、要完成的功能。这里一定要一目了然,避免模棱两可,语言表达不清,误导他人或使他人找不到方向,要把实际需求描述清楚,可以配合渲染,使需求描述更生动到位。下一步是代码步骤的实现。
为保证源代码的正确性,避免一步一步错,从后端数据库操作到前端风格设计,始终遵循代码开发和命名规则,避免重复查询数据库造成产品性能低下的局面。最后,我们需要和领导同事一起进行设计评审,这样每个人都可以表达自己的一些观点,从而使最终的开发少走弯路,减少bug的发生。
版权声明:本文内容由互联网用户自发贡献,本站不承担相关法律责任.如有侵权/违法内容,本站将立刻删除。