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

Want a Stellar Project? You Need to Document an...

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. Who Am I? • Software Developer, Technical Writer, 
 &

    Podcaster • Member of Roave • @settermjd • [email protected]
  2. 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.”
  3. 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.”
  4. 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”
  5. 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.”
  6. 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
  7. 3 Types of Documentation 1. Pure Promotion 2. Technical Tutorials

    / Walk-Throughs 3. API / SDK / Code Documentation
  8. Promotion “Something (such as advertising) that is done to make

    people aware of something and increase its sales or popularity”
  9. How to Build an Audience • Be Factual • Be

    Interesting • Be Patient • Be Persistent • Be Consistent