July 13, 2018

Ask IH: What differentiates an excellent doc site from a terrible doc site?

Actively working on our doc site for our beta launch. Any pro tips on what users want from a doc site? Here is what we have so far: https://dev.cott.io/docs/


  1. 2
    • Well built examples of API calls in multiple languages (SDKs if you have them, don't forget CURL examples) - and POSTMAN.

    • I love stripe's dynamic insertion of your own data in their docs, makes it super easy to run test calls.

    • Nice color scheme

    1. 1

      Thanks Scottie! I will take a look at Stripe's documentation today.

  2. 1

    Smart and fast searches like Laravel's Documentation

    1. 1

      Thank you for sending me there. Laravel's documentation is simple and straightforward.