A Balanced Diet of Documentation

by Nathaniel Okenwa

Embed

Start on current slide

Slide 1

Slide 1 text

@ChatterboxCoder A Balanced Diet of Documentation

Slide 2

Slide 2 text

@ChatterboxCoder Who am I? Nathaniel Okenwa (He/Him) Developer Evangelist @ChatterboxCoder

Slide 3

Slide 3 text

@ChatterboxCoder

Slide 4

Slide 4 text

@ChatterboxCoder “Equip”

Slide 5

Slide 5 text

@ChatterboxCoder Documentation

Slide 6

Slide 6 text

@ChatterboxCoder Documentation API Reference Quickstarts Tutorials Sample Code Blog Posts FAQs Code Snippets Endpoint Deﬁnitions Example Responses Authentication Guide

Slide 7

Slide 7 text

@ChatterboxCoder A Balanced Diet of Documentation

Slide 8

Slide 8 text

@ChatterboxCoder

Slide 9

Slide 9 text

@ChatterboxCoder People

Slide 10

Slide 10 text

@ChatterboxCoder Why?

Slide 11

Slide 11 text

@ChatterboxCoder Audience Goals We’re New We’re Stuck We Forgot

Slide 12

Slide 12 text

@ChatterboxCoder

Slide 13

Slide 13 text

@ChatterboxCoder Audience Goals We’re New We’re Stuck We Forgot

Slide 14

Slide 14 text

@ChatterboxCoder Balance

Slide 15

Slide 15 text

@ChatterboxCoder Food Pyramid

Slide 16

Slide 16 text

@ChatterboxCoder Documentation Pyramid

Slide 17

Slide 17 text

@ChatterboxCoder Documentation Pyramid Minimum Viable Documentation

Slide 18

Slide 18 text

@ChatterboxCoder Reference Manuals Deﬁnitions Forms the Foundation Dictionary Comprehensive

Slide 19

Slide 19 text

@ChatterboxCoder developer.twitter.com/en/docs

Slide 20

Slide 20 text

@ChatterboxCoder Quickstart Assume Zero Knowledge Basic Isolated Use Case Step by Step Aim for Hackathon Attendees

Slide 21

Slide 21 text

@ChatterboxCoder twilio.com/docs

Slide 22

Slide 22 text

@ChatterboxCoder Tutorials, Guides & Samples Extra Guidance Solve Common Issues Developers already building

Slide 23

Slide 23 text

@ChatterboxCoder stripe.com/docs

Slide 24

Slide 24 text

@ChatterboxCoder

Slide 25

Slide 25 text

@ChatterboxCoder Documentation Pyramid Key Pillars

Slide 26

Slide 26 text

@ChatterboxCoder FAQs Driven by Feedback Concise Link to other Documentation

Slide 27

Slide 27 text

@ChatterboxCoder stackoverﬂow.com

Slide 28

Slide 28 text

@ChatterboxCoder API Explorer Mirrors Live Product Experimentation Tool Quick Feedback Cycle

Slide 29

Slide 29 text

@ChatterboxCoder developer.marvel.com/docs

Slide 30

Slide 30 text

@ChatterboxCoder Communication Channels Manned and Unmanned Transparency Iterates faster than your Docs

Slide 31

Slide 31 text

@ChatterboxCoder

Slide 32

Slide 32 text

@ChatterboxCoder Documentation Pyramid Engaging Oﬀerings

Slide 33

Slide 33 text

@ChatterboxCoder Developer Blog Personal Voice Source of Inspiration Not limited to your product

Slide 34

Slide 34 text

@ChatterboxCoder Video Content Content not Ads Multiple Formats Call to Action

Slide 35

Slide 35 text

@ChatterboxCoder youtu.be/yr8F2S3Amas

Slide 36

Slide 36 text

@ChatterboxCoder

Slide 37

Slide 37 text

@ChatterboxCoder Documentation Pyramid The Cherries on Top

Slide 38

Slide 38 text

@ChatterboxCoder Cherries on Top

Slide 39

Slide 39 text

@ChatterboxCoder twilio.com/quest

Slide 40

Slide 40 text

@ChatterboxCoder

Slide 41

Slide 41 text

@ChatterboxCoder

Slide 42

Slide 42 text

@ChatterboxCoder

Slide 43

Slide 43 text

@ChatterboxCoder Food Pyramid

Slide 44

Slide 44 text

@ChatterboxCoder Food Pyramid

Slide 45

Slide 45 text

@ChatterboxCoder Food Pyramid

Slide 46

Slide 46 text

@ChatterboxCoder Food Pyramid

Slide 47

Slide 47 text

@ChatterboxCoder

Slide 48

Slide 48 text

@ChatterboxCoder

Slide 49

Slide 49 text

@ChatterboxCoder Personalise

Slide 50

Slide 50 text

@ChatterboxCoder

Slide 51

Slide 51 text

@ChatterboxCoder

Slide 52

Slide 52 text

@ChatterboxCoder Measures ● Blind Testing Outcomes ● Website Analytics ● Feedback ● Monitor Support Requests

Slide 53

Slide 53 text

@ChatterboxCoder Balance

Slide 54

Slide 54 text

@ChatterboxCoder CREDITS: This presentation template was created by Slidesgo, including icons by Flaticon, and infographics & images by Freepik. THANKS! Nathaniel Okenwa (He/Him) @ChatterboxCoder