API接口文檔的編寫已不是什么新鮮事，但文檔的編寫有時(shí)還需針對(duì)看文檔的人匀奏，有所側(cè)重鞭衩。大多數(shù)時(shí)候我編寫API文檔都是針對(duì)前臺(tái)開發(fā)、或是后臺(tái)開發(fā)，簡(jiǎn)單明了就好论衍。比如這兩種：
1瑞佩、wiz筆記中示例
image.png
2、showdoc中的示例
image.png
記得有次公司商務(wù)說(shuō)讓我給寫幾個(gè)接口的文檔坯台，他給我?guī)c(diǎn)要求：
- 有幾個(gè)接口炬丸，分別是什么？（例如XX信息下發(fā)接口捂人、XX信息更新接口御雕、XX信息反饋接口）
- 每個(gè)接口的作用是什么，傳遞了哪些信息滥搭？（例如XX信息反饋接口傳遞的具體信息內(nèi)容主要包括：信息 ID 號(hào)酸纲、信息接收時(shí)間、信息展示時(shí)間瑟匆、信息發(fā)布情況…….闽坡。）
-
參考以下格式，每個(gè)接口按此編寫
image.png
照葫蘆畫瓢愁溜，我編寫的如下
image.png
對(duì)比上面兩種不同的類型疾嗅，一個(gè)關(guān)注技術(shù)參數(shù)，一個(gè)關(guān)注業(yè)務(wù)示意冕象〈校看來(lái)很多時(shí)候文檔還是需要根據(jù)受眾而變。
