Tag Archives: documentation

Creating Sustainable Documentation with Jekyll

Posted on (0 Comments)

I’ve spent a big part of the last year working on documentation for SendGrid. I’ve learned a lot of things. You can read about how we broke down the problem of documentation at a high level and why documentation is critical for success in Cheat Codes for Good Documentation. Below you’ll find the path we took, from the early days through last November’s switch to the current system, based on Jekyll. Most of what I’ll recommend applies to documenting an abstraction layer, e.g. an API. Scope of SendGrid’s Docs Just for context of what SendGrid’s docs look like, here is

READ MORE »

Cheat Codes for Good Documentation

Posted on (4 Comments)

Everybody, especially developers, loves working on documentation. They understand the importance of docs and its impact on customer adoption and customer experience, and they always consider docs when planning and releasing code. Wait, why are you laughing? Many companies have some kind of trouble with documentation. Lots of common problems make docs difficult to wrangle; information gets out of date or lacks completeness, the content is poorly organized or inconsistent, readers can’t find what they’re looking for, and code samples might be broken. If you walk through most engineering departments and ask for volunteers to help update docs, you’ll be

READ MORE »

New SendGrid Documentation Launched

Posted on (1 Comment)

Today SendGrid is excited to announce our new and improved documentation! Some of the highlights of the new system are: Quicker load times Improved navigation and organization More relevant search results Increased legibility Cleaner presentation of code samples Ability to toggle between JSON and XML examples The new system will allow us to collaborate on updates and changes much more quickly, and we hope that the changes will allow developers to find what they need quicker than before. We’d love to hear your feedback on how you like the changes or what we can do to make things better, so

READ MORE »

SendGrid’s API Workshop – Interactive API Documentation

Posted on (0 Comments)

Sometimes it’s easier to understand how something works by seeing it in action rather than by reading about it. To make it easier to explore what our API is capable of and let customers try out API calls without having to write code, we’ve created our API Workshop. Ready to take it for a spin? Start by putting in your SendGrid credentials: Related PostsStartup Resources Delivering Beers Hand Over Wrist! Simulating Pokemon with SendGrid (and an Audience) Oh, Cardless: My Business Card Email App Join the Queues Using Messaging and SendGrid

READ MORE »