Beyond Docs - Lessons learned rebuilding the PAYMILL documentation

Beyond Docs - Lessons learned rebuilding the PAYMILL documentation

Talk about the importance of integrating documentation into the technical marketing process for API companies based on personal experience at PAYMILL.

E9f3d5a1d4f7a8d99ab3a563fde48d6e?s=128

Yann IRBAH

May 06, 2015
Tweet

Transcript

  1. BEYOND DOCS LESSONS LEARNED REBUILDING THE PAYMILL DOCUMENTATION YANN IRBAH

    @yannirbah Dev Evangelist
  2. Yann IRBAH Developer Evangelist @yannirbah l0ck3

  3. DEV EVANGELISM An Inconvenient Truth

  4. DEV RELATIONS The Big Picture

  5. DEV RELATIONS Keeper Of User Resources

  6. SOME FACTS ABOUT DEVELOPER RELATIONS

  7. API PROVIDER ? MANDATORY !!!!!

  8. DEVELOPERS Difficult Crowd

  9. DEVELOPERS Don’t care about packaging?

  10. DEVELOPERS They do but suck at it!

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

    tech people
  12. SO WHAT IS A DOCUMENTATION MADE FOR ???

  13. DOCUMENTATION Product usage information

  14. DOCUMENTATION Marketing tool

  15. DOCUMENTATION Builds trust

  16. OK BUT HOW TO DO IT?

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

  18. None
  19. None
  20. None
  21. MAKE IT EASY TO MAINTAIN Never be outdated

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

  23. WORTH IT? I think so!

  24. PICK THE RIGHT TOOL No silver bullet

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

  26. THE PAYMILL CASE

  27. DOCPAD Static pages generator

  28. SLATE TEMPLATES Converted and customized

  29. GITHUB Database, authoring tool, version control

  30. User pushes content to GitHub STEP 1

  31. GitHub calls generator WebHook STEP 2

  32. Generator pulls content from repositories STEP 3

  33. Generator builds static pages STEP 4

  34. Generator deploys pages on the server STEP 5

  35. WRAPPING UP

  36. yann.irbah@paymill.com @yannirbah