Brandon
West
SendGrid
Manager, Developer Relations

@bwest

Who am I ?

brandon@sendgrid.com
SendGrid
Documentation
& Open Source Projects
Why Documentation Matters
ProgrammableWeb.com API Survey Results

Copyright © KOZO KEIKAKU ENGINEERING Inc. All Rights
Res...
What Documentation Does

Developers Self Serve
Reduce Support Tickets

Establishes Credibility

Copyright © KOZO KEIKAKU E...
API Workshop
Test the API
from browser.
No code.

!
New version
coming soon!

Copyright © KOZO KEIKAKU ENGINEERING Inc. Al...
Documentation Is Not Easy
• We are on our third version of documentation. The first 2 were bad.	

• It’s a big job. We’re ...
What Makes Sustainable Documentation?
• Change tracking / version control	

• Ease of deploying changes	

• Maintainabilit...
!8
Open Source Libraries

PHP

C#

Node.js

Obj-C

Perl

Go

Python

Java
https://github.com/sendgrid/
Copyright © KOZO KEIKA...
Most Popular Libraries

PHP
C#

Based on views on Github
over the last 2 weeks

Python
Node.js

Copyright © KOZO KEIKAKU E...
Why Have Open Source Libraries?
• Reduce the amount of work it takes for new users to get started	

• Developers like pack...
Not Just API Wrappers

• Our documentation is open source! github.com/sendgrid/docs	

• New newsletter subscription widget...
Thank you !!
Upcoming SlideShare
Loading in...5
×

SendGrid documentation & open source projects

639

Published on

Published in: Technology
0 Comments
0 Likes
Statistics
Notes
  • Be the first to comment

  • Be the first to like this

No Downloads
Views
Total Views
639
On Slideshare
0
From Embeds
0
Number of Embeds
4
Actions
Shares
0
Downloads
8
Comments
0
Likes
0
Embeds 0
No embeds

No notes for slide

SendGrid documentation & open source projects

  1. 1. Brandon West SendGrid Manager, Developer Relations @bwest Who am I ? brandon@sendgrid.com
  2. 2. SendGrid Documentation & Open Source Projects
  3. 3. Why Documentation Matters ProgrammableWeb.com API Survey Results Copyright © KOZO KEIKAKU ENGINEERING Inc. All Rights Reserved
  4. 4. What Documentation Does Developers Self Serve Reduce Support Tickets Establishes Credibility Copyright © KOZO KEIKAKU ENGINEERING Inc. All Rights Reserved
  5. 5. API Workshop Test the API from browser. No code. ! New version coming soon! Copyright © KOZO KEIKAKU ENGINEERING Inc. All Rights Reserved
  6. 6. Documentation Is Not Easy • We are on our third version of documentation. The first 2 were bad. • It’s a big job. We’re now hiring a person to manage it full time. • Things are constantly changing Copyright © KOZO KEIKAKU ENGINEERING Inc. All Rights Reserved
  7. 7. What Makes Sustainable Documentation? • Change tracking / version control • Ease of deploying changes • Maintainability of platform • Smart constraints • Smart defaults • Ease of editing content • Defined structure • These are a lot of the same things that make code sustainable. ! Copyright © KOZO KEIKAKU ENGINEERING Inc. All Rights Reserved
  8. 8. !8
  9. 9. Open Source Libraries PHP C# Node.js Obj-C Perl Go Python Java https://github.com/sendgrid/ Copyright © KOZO KEIKAKU ENGINEERING Inc. All Rights Reserved
  10. 10. Most Popular Libraries PHP C# Based on views on Github over the last 2 weeks Python Node.js Copyright © KOZO KEIKAKU ENGINEERING Inc. All Rights Reserved
  11. 11. Why Have Open Source Libraries? • Reduce the amount of work it takes for new users to get started • Developers like package managers such as npm, nuget, rubygems • Provides example implementations even if devs don’t use them • Lets us provide smart defaults — e.g. Web API instead of SMTP • If we don’t build them, someone will. But we get the questions! • It’s fun 😊 Copyright © KOZO KEIKAKU ENGINEERING Inc. All Rights Reserved
  12. 12. Not Just API Wrappers • Our documentation is open source! github.com/sendgrid/docs • New newsletter subscription widget is also open source • We’re trying to open source more projects as well Copyright © KOZO KEIKAKU ENGINEERING Inc. All Rights Reserved
  13. 13. Thank you !!
  1. A particular slide catching your eye?

    Clipping is a handy way to collect important slides you want to go back to later.

×