API接口文档的编写已不是什么新鲜事,但文档的编写有时还需针对看文档的人,有所侧重。大多数时候我编写API文档都是针对前台开发、或是后台开发,简单明了就好。比如这两种:1、wiz笔记中示例image.png2、showdoc中的示例image.png记得有次公司商务说让我给写几个接口的文档,他给我几点要求:有几个接口,分别是什么?(例如XX信息下发接口、XX信息更新接口、XX信息反馈接口)每个接口……
API接口文档的编写已不是什么新鲜事,但文档的编写有时还需针对看文档的人,有所侧重。大多数时候我编写API文档都是针对前台开发、或是后台开发,简单明了就好。比如这两种:1、wiz笔记中示例image.png2、showdoc中的示例image.png记得有次公司商务说让我给写几个接口的文档,他给我几点要求:有几个接口,分别是什么?(例如XX信息下发接口、XX信息更新接口、XX信息反馈接口)每个接口……