Skip to content

Instantly share code, notes, and snippets.

Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save settermjd/8ede675f2a27a99d8624 to your computer and use it in GitHub Desktop.
Save settermjd/8ede675f2a27a99d8624 to your computer and use it in GitHub Desktop.
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, one that you want people to use, to be truly successful, perhaps one people even rave about? Often, most of the effort expended on a project goes in to development, with documentation and promotion considered after-thoughts. 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, to start using, to maintain, and to grow its reputation, using examples of real world successes.

@jaytaph
Copy link

jaytaph commented Jun 5, 2015

Abstract seems ok. One point I have by reading it: will the focus be on "how to document" or more on "how to promote"? The title focusses more on promotion, while the abstract focuses more on documentation.

I can imagine when people are expecting (from the title) that it's about all the neat promo tools and tips but end up listening to mostly on how to document will end up disappointed (and vice versa).

@settermjd
Copy link
Author

Good point. I'd not thought of that. I'll rework it to talk about both equally.

@omerida
Copy link

omerida commented Jun 5, 2015

What joshua said. To make it play to a wider community you could include something like "Do you have an awesome new WordPress plugin, Drupal module, ZF module, or PHP library that you want to share?"

@settermjd
Copy link
Author

Good point. I wasn't sure how wide a net to cast, tbh.

@settermjd
Copy link
Author

Ok, updated to take your comment in to account omerida.

@e3betht
Copy link

e3betht commented Jun 6, 2015

Wording seems a bit fragmented, and I think it needs more of a hook to say why this is important.

@settermjd
Copy link
Author

Ah ok. thanks.

@settermjd
Copy link
Author

I'm finding it tough to say it better, as I have a 600 char limit

@lornajane
Copy link

I would start stronger and snappier if possible.

"Got a great open source project or module that you want people to find, use and love? It's not just about the code; this session will teach you how to ..." you get the idea. At least those events with 600 char limits are honest about how much abstract they are prepared to read before they give up and move on .... think of it as a feature :)

@settermjd
Copy link
Author

Yeah, I see what you're saying. I think I was too broad in this, and perhaps the other two Gists tbh. I'll see what I can come up with.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment