New And Improved Developer Documentation

By John Riney,

Let's talk about developer documentation, shall we? If you're anything like me as a coder, when you're scoping out a new API or technology, you want to know the following things:

  1. Does it do what I need?
  2. Is the documentation any good?
  3. How much does it cost?
  4. Is anyone else using it?

If I can't find those four things out in a few minutes, and without having to hear a sales pitch, your API isn't getting any further consideration. That's why, as PokitDok's technical evangelist, I've continually fought to maintain and improve our developer experience. Everything we do is plainly laid out on our Platform site, along with documentation, pricing, and sample code. This doesn't sound like all that big of a deal - any API should work that way - but the world of health is the last bastion for some pretty gruesome business practices. For example, some companies charge for access to their documentation. That's just not how we work.

Anyway, back on the topic of documentation - we've got new and improved docs! We saw some sites making really good use of the TripIt Slate framework, and decided to move to that. The content has been reorganized to put what you need to get started first, and they're searchable! We've also greatly expanded the documentation in the areas of Benefits Enrollment and Claims, providing complete coverage of these more complicated request types for those of us who aren't X12 experts. We'll be progressively adding more details and code examples for all our endpoints. Also, the source for our documentation is now publically hosted on our public GitHub repo. If you find an error, or something you think could be improved, send us a pull request! Here's a quick screenshot:

New PokitDok API docs

I'm really proud of the new docs. Check them out, and let me know what you think!

The opinions expressed in this blog are of the authors and not of PokitDok's. The posts on this blog are for information only, and are not intended to substitute for a doctor-patient or other healthcare professional-patient relationship nor do they constitute medical or healthcare advice.

  Tags: Dev