Dev Portals Research

Goals

  • Explore principles behind the best dev portals in the fintech industry.
  • Find patterns that can be used to build a new dev portal or significantly improve the existing one.
  • Look for uncommon things to implement in a fresh dev portal.

Participants (66)

The participants of research include dev portals, API documentation, etc. of big companies and fintech/blockchain industries:

Documentation

Patterns

Binance Chain

  • Code samples in guides include Example output and explain What's happening in a short paragraph, instead of a step-by-step process. Sample: Dash, Libra.

Dash

MakerDAO

Kyber Network

Amazon AWS

Square

Uncommon/Cool Things

Binance Chain

Klaytn

Omise

  • A single page to explain the entire js library without compromising on an explanation of core features. Samples: Omise, Stripe.
  • Specific features of this particular blockchain/network (built-in governance, privacy, etc.). Samples: Dash.
  • A separate page for wallets that a network has. Samples: Dash.
  • A document on how the law applies to the network. Samples: Dash.
  • Integration guides for Android and iOS. Samples: TrustWallet.
  • Every function has a Logic explanation where it shows what happens if you execute this particular function. Sample: 0x.

0x

Kyber Network

  • A very neat table for network connections. Samples: Compound.

Compound

  • Security page with smart contract audits, formal verification, economic security, bug bounty program. Samples: Compound.

Compound

  • Code samples in Solidity and Web3. Samples: Aave.

Aave

  • Sequence Chart for payment flow. Samples: WeChat.

WeChat

  • If there are multiple ways to do the same thing (via APIs or Dashboard for instance), it is divided into tabs. Samples: Paytm.

Paytm

  • Cool landing page for SDK that explains the benefits of using this product. Samples: Square.
  • Integration Checklist. Samples: Google Pay.

Google Pay

  • A good way to explain lifecycles. Samples: Android.

Android

  • Getting Started guides for SDKs. Samples: Facebook.
  • A plugin that shows open and closed Github issues. Samples: Microsoft.

Microsoft

API

Patterns

Binance

Huobi

  • Clear examples of requests and response bodies. Samples: Coinbase Pro.

Coinbase Pro

Upbit

Uncommon/Cool Things

  • Upcoming changes. Samples: Coinbase Pro.
  • A guide on how to read API docs. Samples: Bitfinex.
  • API uptime. Samples: Blockchain.info.
  • All APIs and SDKs docs are in one place. Sample: imToken.
  • There are API endpoints for both mainnet and testnet. Samples: Binance Chain.
  • Each function explains the use cases where it can be implemented. Samples: Paytm.

Paytm

  • Embedded Swagger into dev portal website. Samples: Amazon.

Amazon