編寫優(yōu)質(zhì)的API文檔的方法，怎么進(jìn)行API文檔的編寫，API文檔優(yōu)質(zhì)的編寫方法

編寫技術(shù)文檔，API文檔優(yōu)質(zhì)的編寫方法，是令眾多開發(fā)者望而生畏的任務(wù)之一。它本身是一件費(fèi)時(shí)費(fèi)力才能做好的工作?？墒谴蠖鄶?shù)時(shí)候，人們卻總是想抄抄捷徑，這樣做的結(jié)果往往非常令人遺憾的，因?yàn)閮?yōu)質(zhì)的技術(shù)文檔是決定你的項(xiàng)目是否引人關(guān)注的重要因素。無(wú)論開源產(chǎn)品或面向開發(fā)者的產(chǎn)品，均是如此。

使用API開發(fā)應(yīng)用，所能遭遇的最糟糕的情況，莫過于你發(fā)現(xiàn)了一個(gè)文檔中沒有提到的錯(cuò)誤?！禛itHub API參考》也經(jīng)由了良好的設(shè)計(jì)。

我們糊口在一個(gè)多語(yǔ)言的世界。

1. 支持多種編程語(yǔ)言

舉個(gè)例子，我們的快速指南能讓用戶下載SDK以及在平臺(tái)上存儲(chǔ)一個(gè)對(duì)象。

2. 減少點(diǎn)擊次數(shù)

在你的文檔中盡可能地舉現(xiàn)實(shí)中的例子吧。

參考索引：參考索引應(yīng)當(dāng)是一個(gè)事無(wú)巨細(xì)的列表，包含了所有功能函數(shù)的繁文縟節(jié)。

在學(xué)習(xí)結(jié)束的時(shí)候，開發(fā)者但愿能看到關(guān)于項(xiàng)目產(chǎn)品應(yīng)用的大致藍(lán)圖。它必需注明所有的數(shù)據(jù)類型和函數(shù)規(guī)格。我發(fā)現(xiàn)，應(yīng)用程序代碼是將API運(yùn)行機(jī)理和系統(tǒng)整合融會(huì)貫通最好的辦法。

3. 提供樣例應(yīng)用

因此，參考索引中必需包含每種假設(shè)可能造成的邊界情況，不論是顯示的仍是隱式的。然而，當(dāng)你在教會(huì)開發(fā)者如何使用的過程中，仍是能不抽象就不抽象比較好。

你的設(shè)計(jì)文檔不應(yīng)當(dāng)僅僅直白地列出所有的終端函數(shù)和其參數(shù)。它就仿佛是一篇更加具體的參考索引，闡明了如何使用各種API。目前我們正在努力編制更多的開發(fā)教程。假如能提供可編譯運(yùn)行的源代碼，那就再好不外了。

4. 毫不放過任何邊界情況

MailGun’s API為此做出了良好的榜樣。
閱讀技術(shù)文檔枯燥乏味，天然不像坐過山車那樣緊張刺激。僅此而已。

在Parse項(xiàng)目里，我們做到了上述所有三個(gè)部門。高級(jí)開發(fā)者要能夠拿著它整天當(dāng)參考書使用。對(duì)此，我們的網(wǎng)站里甚至給出一個(gè)代碼樣例加以解釋。

5. 加入人道化的因素

sample code in Apple’s iOS Developer Library 則是這方面做得很好的，它包含了詳盡的iOS樣例程序，并按主題逐一分類。給你的例子中的變量其一些好玩兒的名字吧，別總是把函數(shù)名稱叫什么foo之類的，好讓你的讀者有煥然一新的感覺。

快速指南的目的是讓用戶用最小的代價(jià)學(xué)習(xí)如何利用你提供的API干一些小事。

萬(wàn)事開頭難，開發(fā)者學(xué)習(xí)一套全新的API，不得不重新適應(yīng)其全新的思維方式，學(xué)習(xí)代價(jià)高昂。
你可以爭(zhēng)辯說，我的API本身就是個(gè)抽象體， 抽象就是它的特點(diǎn)。它提供了curl，Ruby，Python，Java，C#和PHP等多個(gè)版本供開發(fā)者選擇。要知道，真正成功的API文檔是需要用愛來悉心制作的藝術(shù)品。

至少，這可以保證你的讀者不會(huì)讀著讀著就睡過去。API文檔優(yōu)質(zhì)的編寫方法，實(shí)際上，這種做法能明顯地縮短開發(fā)者理解你產(chǎn)品的時(shí)間。千萬(wàn)別把你的文檔分散在數(shù)以萬(wàn)計(jì)的頁(yè)面當(dāng)中。為此，我們甚至做了一個(gè)按鈕，來讓用戶測(cè)試他們是否準(zhǔn)確地完成了快速指南。真正最重要的是產(chǎn)品的API文檔！假如沒人知道你的產(chǎn)品如何使用，縱使它巧奪天工，又有何用？

這能晉升用戶的決心信念，以鼓勵(lì)他們學(xué)習(xí)我們產(chǎn)品其他的部門。達(dá)到這一目的最好的辦法，莫過于提供可運(yùn)行的樣例應(yīng)用。多數(shù)時(shí)候，多語(yǔ)言的工作都是由客戶端庫(kù)來完成的。要知道，開發(fā)者要想把握一套API，離開他們認(rèn)識(shí)的編程語(yǔ)言，是很難想象的。盡量把相關(guān)的主題都放到一個(gè)頁(yè)面里。不外，你至少可以通過加入一些人道化的因素，或者開開玩笑。對(duì)于這個(gè)題目的解決辦法是：通過快速指南來引導(dǎo)開發(fā)者。一旦用戶完成了快速指南，他們就對(duì)自己有了決心信念，并能向更加深入的主題邁進(jìn)。在Parse產(chǎn)品項(xiàng)目里，我們就把自己奉獻(xiàn)給了這門藝術(shù)！

假如你是一個(gè)專門從事面向開發(fā)者產(chǎn)品設(shè)計(jì)的工程師，那么編寫完善的技術(shù)文檔，就跟你為終端用戶提供良好用戶體驗(yàn)一樣樞紐。假如你碰到這種情況，就意味著你不能確認(rèn)畢竟是你的程序出了錯(cuò)，仍是你對(duì)API的理解出了錯(cuò)?；c(diǎn)兒時(shí)間在這個(gè)上面，絕對(duì)能起到事半功倍的效果。

開發(fā)教程：開發(fā)教程會(huì)更加詳細(xì)地闡述如何使用API，并著重先容其中的一部門功能。

實(shí)際上，我想說明的是：對(duì)于面向開發(fā)者的產(chǎn)品來說，其用戶體驗(yàn)中最重要的一環(huán)并不是什么主頁(yè)設(shè)計(jì)、登錄過程、或者SDK下載。這個(gè)產(chǎn)品的文檔包括一個(gè)很棒的《hybrid guide and reference》，以及一套開發(fā)教程。

開發(fā)者痛恨點(diǎn)擊鼠標(biāo)，這已經(jīng)不是什么秘密了。

6. 包含適當(dāng)?shù)目焖僦改?/p>

在這個(gè)方面的一個(gè)優(yōu)秀范例是ckbone.js documentation，只要你有個(gè)鼠標(biāo)，一切盡在把握。沒有哪個(gè)開發(fā)者會(huì)訴苦你舉例太多的。好的文檔應(yīng)該是一整套有機(jī)的系統(tǒng)內(nèi)容，能指引用戶通過文檔與API進(jìn)行交互。退一萬(wàn)步說，你至少讓你的文檔包含以下幾個(gè)部門。

7. 不要在例子中包含抽象概念

另外一個(gè)此方面優(yōu)秀的范例是Stripe’s API（http://www.stripe.com） 。

開發(fā)指南：這是介于參考索引和開發(fā)教程中間程度的文檔。

8. 毫不吝惜使用層次

那么，什么才是制作優(yōu)秀API文檔的樞紐因素呢？

我見過很多類似的情況，一個(gè)項(xiàng)目被草率地扔到GitHub的頁(yè)面上，僅僅配有兩行的readme說明文件。

我們非常贊成使用“單頁(yè)面大指南”的組織形式（鏈接），這種形式不僅能讓用戶縱覽全局，僅僅通過一個(gè)導(dǎo)航欄就能進(jìn)入他們感愛好的任意主題，另外還有一個(gè)好處是：用戶在進(jìn)行搜索的時(shí)候，僅僅搜索當(dāng)前頁(yè)面，就能涵蓋查找所有的內(nèi)容。假如可能的話，為你的API提供各種編程語(yǔ)言版本的樣例程序，只要的API支持這些語(yǔ)言。

新聞標(biāo)題：編寫優(yōu)質(zhì)的API文檔的方法，怎么進(jìn)行API文檔的編寫，API文檔優(yōu)質(zhì)的編寫方法
文章網(wǎng)址：http://www.bm7419.com/news9/166209.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供域名注冊(cè)、網(wǎng)頁(yè)設(shè)計(jì)公司、手機(jī)網(wǎng)站建設(shè)、動(dòng)態(tài)網(wǎng)站、建站公司、定制開發(fā)

廣告

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請(qǐng)盡快告知，我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng)，如需處理請(qǐng)聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時(shí)需注明來源： 創(chuàng)新互聯(lián)