Beyond Docs - Lessons learned rebuilding the PAYMILL documentation - Speaker Deck

Tweet

Tweet

Slide 1

Slide 1 text

BEYOND DOCS LESSONS LEARNED REBUILDING THE PAYMILL DOCUMENTATION YANN IRBAH @yannirbah Dev Evangelist

Slide 2

Slide 2 text

Yann IRBAH Developer Evangelist @yannirbah l0ck3

Slide 3

Slide 3 text

DEV EVANGELISM An Inconvenient Truth

Slide 4

Slide 4 text

DEV RELATIONS The Big Picture

Slide 5

Slide 5 text

DEV RELATIONS Keeper Of User Resources

Slide 6

Slide 6 text

SOME FACTS ABOUT DEVELOPER RELATIONS

Slide 7

Slide 7 text

API PROVIDER ? MANDATORY !!!!!

Slide 8

Slide 8 text

DEVELOPERS Diﬃcult Crowd

Slide 9

Slide 9 text

DEVELOPERS Don’t care about packaging?

Slide 10

Slide 10 text

DEVELOPERS They do but suck at it!

Slide 11

Slide 11 text

DEV RELATIONS TO THE RESCUE Marketing by tech people for tech people

Slide 12

Slide 12 text

SO WHAT IS A DOCUMENTATION MADE FOR ???

Slide 13

Slide 13 text

DOCUMENTATION Product usage information

Slide 14

Slide 14 text

DOCUMENTATION Marketing tool

Slide 15

Slide 15 text

DOCUMENTATION Builds trust

Slide 16

Slide 16 text

OK BUT HOW TO DO IT?

Slide 17

Slide 17 text

BUILD A RESOURCES CENTER a.k.a. Dev Center

Slide 18

Slide 18 text

No content

Slide 19

Slide 19 text

No content

Slide 20

Slide 20 text

No content

Slide 21

Slide 21 text

MAKE IT EASY TO MAINTAIN Never be outdated

Slide 22

Slide 22 text

OPEN ITS SOURCE !!! That’s the magic trick

Slide 23

Slide 23 text

WORTH IT? I think so!

Slide 24

Slide 24 text

PICK THE RIGHT TOOL No silver bullet

Slide 25

Slide 25 text

PICK THE RIGHT TOOL You’ve got the choice CUSTOM STUFF

Slide 26

Slide 26 text

THE PAYMILL CASE

Slide 27

Slide 27 text

DOCPAD Static pages generator

Slide 28

Slide 28 text

SLATE TEMPLATES Converted and customized

Slide 29

Slide 29 text

GITHUB Database, authoring tool, version control

Slide 30

Slide 30 text

User pushes content to GitHub STEP 1

Slide 31

Slide 31 text

GitHub calls generator WebHook STEP 2

Slide 32

Slide 32 text

Generator pulls content from repositories STEP 3

Slide 33

Slide 33 text

Generator builds static pages STEP 4

Slide 34

Slide 34 text

Generator deploys pages on the server STEP 5

Slide 35

Slide 35 text

WRAPPING UP

Slide 36

Slide 36 text

[email protected] @yannirbah