最近日本中文字幕免费完整,曰韩伦理福利在线观看,国产欧美一区二区精品性色,中文人妻视频

實際上，我想說明的是：對于面向開發(fā)者的產(chǎn)品來說，其用戶體驗中最重要的一環(huán)并不是什么主頁設計、登錄過程、或者SDK下載。真正最重要的是產(chǎn)品的API文檔！如果沒人知道你的產(chǎn)品如何使用，縱使它巧奪天工，又有何用？

如果你是一個專門從事面向開發(fā)者產(chǎn)品設計的工程師，那么編寫完善的技術文檔，就跟你為終端用戶提供良好用戶體驗一樣關鍵。

我見過許多類似的情況，一個項目被草率地扔到GitHub的頁面上，僅僅配有兩行的readme說明文件。要知道，真正成功的API文檔是需要用愛來悉心制作的藝術品。在Parse產(chǎn)品項目里，我們就把自己奉獻給了這門藝術！

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

0. 絕不吝惜使用層次

你的設計文檔不應當僅僅直白地列出所有的終端函數(shù)和其參數(shù)。好的文檔應該是一整套有機的系統(tǒng)內(nèi)容，能指引用戶通過文檔與API進行交互。退一萬步說，你至少讓你的文檔包含以下幾個部分。

參考索引：參考索引應當是一個事無巨細的列表，包含了所有功能函數(shù)的繁文縟節(jié)。它必須注明所有的數(shù)據(jù)類型和函數(shù)規(guī)格。高級開發(fā)者要能夠拿著它整天當參考書使用。

開發(fā)指南：這是介于參考索引和開發(fā)教程中間程度的文檔。它就仿佛是一篇更加詳細的參考索引，闡明了如何使用各種API。

開發(fā)教程：開發(fā)教程會更加具體地闡述如何使用API，并著重介紹其中的一部分功能。如果能提供可編譯運行的源代碼，那就再好不過了。

在Parse項目里，我們做到了上述所有三個部分。目前我們正在努力編制更多的開發(fā)教程。

另外一個此方面優(yōu)秀的范例是Stripe’s API（http://www.stripe.com） 。這個產(chǎn)品的文檔包括一個很棒的《hybrid guide and reference》，以及一套開發(fā)教程�！禛itHub API參考》也經(jīng)過了良好的設計。

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

你可以爭辯說，我的API本身就是個抽象體， 抽象就是它的特點。然而，當你在教會開發(fā)者如何使用的過程中，還是能不抽象就不抽象比較好。

在你的文檔中盡可能地舉現(xiàn)實中的例子吧。沒有哪個開發(fā)者會抱怨你舉例太多的。實際上，這種做法能顯著地縮短開發(fā)者理解你產(chǎn)品的時間。對此，我們的網(wǎng)站里甚至給出一個代碼樣例加以解釋。

3. 減少點擊次數(shù)

開發(fā)者痛恨點擊鼠標，這已經(jīng)不是什么秘密了。千萬別把你的文檔分散在數(shù)以萬計的頁面當中。盡量把相關的主題都放到一個頁面里。

我們非常贊成使用“單頁面大指南”的組織形式（鏈接），這種形式不僅能讓用戶縱覽全局，僅僅通過一個導航欄就能進入他們感興趣的任意主題，另外還有一個好處是：用戶在進行搜索的時候，僅僅搜索當前頁面，就能涵蓋查找所有的內(nèi)容。

在這個方面的一個優(yōu)秀范例是ckbone.js documentation，只要你有個鼠標，一切盡在掌握。

4. 包含適當?shù)目焖僦改?/strong>