Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Want a Stellar Project? You Need to Document and Promote It

Want a Stellar Project? You Need to Document and Promote It

Do you have an awesome WordPress plugin, Drupal module, Zend Framework module, or PHP library that you want people to use, to be truly successful, perhaps one that people even rave about? Often, most of the effort expended on a project goes to development, with documentation and promotion considered afterthoughts. But these two steps are essential to a project's success. In this session, I'll show you key ways to document and promote your project, so it's easier to find out about, start using, maintain, and grow its reputation, using examples of real-world successes.

Matthew Setter

November 20, 2015
Tweet

More Decks by Matthew Setter

Other Decks in Technology

Transcript

  1. Want a Stellar Project?
    You NEED to Document & Promote it!

    View full-size slide

  2. Who Am I?
    • Software Developer, Technical Writer, 

    & Podcaster
    • Member of Roave
    • @settermjd
    [email protected]

    View full-size slide

  3. I Run This Blog

    View full-size slide

  4. Likely Options

    View full-size slide

  5. Anyone Use BeOS Today?

    View full-size slide

  6. So Why Did BeOS Fail?

    View full-size slide

  7. So What Makes a Project
    Successful?

    View full-size slide

  8. 2 Key Things
    Documentation Promotion

    View full-size slide

  9. Jenny Wong
    “Easy, It’s user focused. We know users don’t care how something is built. And we do
    our best to make it so they don’t have to worry.”

    View full-size slide

  10. Taylor Otwell
    “It makes it very easy to solve common problems using very little code. It provides
    support for very modern features with the same ease of use. It has good
    documentation and hundreds of video tutorials on Laracasts. This makes it very easy
    to adopt.”

    View full-size slide

  11. Oscar Merida
    “A successful project is much more than the technical aspects, it’s one that invests in
    building a community by not just providing a technical solution, but also making it easy
    for people to participate, which ends up marketing the project”

    View full-size slide

  12. Beth Tucker-Long
    “I think a successful open-source project needs an easy, clear way to contribute,
    contributions are appreciated, and the project has good marketing. I think it also helps
    if it's a project that a lot of people use often.”

    View full-size slide

  13. See Any Common Threads?

    View full-size slide

  14. User Focused
    Easy to solve common problems
    Good documentation and tutorials
    An easy, clear way to contribute
    A project that a lot of people use often

    View full-size slide

  15. People Need To
    • Know Your Project Exists
    • Know How To Use It

    View full-size slide

  16. Documentation

    View full-size slide

  17. 3 Types of Documentation
    1. Pure Promotion
    2. Technical Tutorials / Walk-Throughs
    3. API / SDK / Code Documentation

    View full-size slide

  18. Pure Promotion

    View full-size slide

  19. A Clear Statement & Promise

    View full-size slide

  20. Benefits & Features

    View full-size slide

  21. Benefits & Features

    View full-size slide

  22. Technical Tutorials

    View full-size slide

  23. Promotion
    “Something (such as advertising) that is done to make people aware of
    something and increase its sales or popularity”

    View full-size slide

  24. Screencasts
    “Use Video. Kids LOVE Video”

    View full-size slide

  25. 16:9 Resolution
    18pt Font
    Be Focused
    Screencast Tips

    View full-size slide

  26. Want Inspiration?

    View full-size slide

  27. The Laravel Podcast
    with Matt Stauffer
    http://www.laravelpodcast.com

    View full-size slide

  28. PHP Roundtable
    with Sammy K. Powers
    http://www.phproundtable.com

    View full-size slide

  29. /dev/hell
    with Ed Finkler and Chris Hartjes
    http://www.devhell.info

    View full-size slide

  30. Free the Geek
    with Me
    http://www.freethegeek.fm

    View full-size slide

  31. How Do You Build an Audience?

    View full-size slide

  32. How to Build an Audience
    • Be Factual
    • Be Interesting
    • Be Patient
    • Be Persistent
    • Be Consistent

    View full-size slide

  33. Presentations

    View full-size slide

  34. Presentations

    View full-size slide

  35. @settermjd or [email protected]
    Questions?
    https://joind.in/14795
    Please Rate the Talk

    View full-size slide