最近公司开发项目需要前后端分离，这样话就设计到后端接口设计。复杂功能需要提供各种各样的接口供前端调用，因此编写API文档非常有必要了 网上查了很多资料，发现基于Markdown编写文档是一种比较流行而且成熟的方案了，话不多说，我也搞一搞试试。 电脑操作系统：deepin深度 Linux64位 ...

https://www.showdoc.cc ...

0. 前言 近期忙于和各个银行的代收接口联调，根据遇到的问题，对之前编写的接口进行了修改，需求收集和设计接口时想到了方方面面，生产环境下还是会遇到意想不到的问题，好在基本的执行逻辑已确定，因此只是对接口进行了一些微调，但是收钱无小事，之前在代码编写时对参数进行了很多的校验，代码修改之后一个参数 ...

软件开发中文档的编写是一个不可缺少的环节，常见的如《需求分析》、《概要分析》、《数据库设计》等。在“软件人”的阵营里向来存在两种观点，注重文档还是关心代码。一直争论多少年了，好像都没有一个真正的定乱。如果大项目且开发周期相对合理，很多时候项目组一定会安排进行相关开发文档的编写；但对于周期短 ...

每个系统都包含一系列架构决策，定义了设计和实现的边界和限制， 架构设计文档的核心是以某种方式的选型决策，而开发团队可能不太清楚这个决策背后的假设和思考。 对于这些决策，由于我们缺少当时的上下文，只能盲目的接受 ...

参考自网友的链接： https://www.jianshu.com/p/8da35d1f987a ...