Writing guidelines for module project descriptions

This is an ancient issue, but one relevant to what I'm working on now. When I get the contrib page cleaned up, I'll take a stab at writing up docs so it doesn't get so messy again.

Michelle

I'll think it would really help if a brief "Explanation or submission guidelines" were added to the project content type (this is a feature in Drupal). Some short, important tips (e.g "please please please use <!--break..>...") and a link to the upcoming handbook page at the top of the create/edit page would have a potential to make a huge different to the quality of the descriptions.

Michelle, this is different than "embedded documentation"? http://drupal.org/about/authoring/writing (/node/24268)

Changed the component to reflect the new component categorization. See http://drupal.org/node/301443
-nielsbom

Wow, I'd forgotten about this issue. Not something I'm likely to have time to do so unassigning.

Michelle

To me this is not only ancient but unclear! What needs to be done?

Sounds like a module standards guide (which we have)...

I think what is being asked for is for more guidance on creating a good module page for your project (i.e. pages like drupal.org/project/cck).

Right now, what we have is (as part of the Contributing Code handbook):

Step by step guide: http://drupal.org/node/100748 - no real guidance on what to put on the page, just a description of the fields on the submission form.

Best Practices: http://drupal.org/node/188986 - "This is a succinct description of what your module offers and does. Remember this will probably be your first opportunity to "sell" your module to the potential user. There are many pages on the web on writing good copy, so I will not go into much of that here. If you need to put more stuff on the page than makes a good teaser, you should use a teaser end tag ("

"> because this will be listed on the Downloads pages."

I think the best thing is to add a bit more information to "best practices", and link there from Step by Step. I don't think we need a full-blown page explaining what to put there... do you?

OK, I've done this: added to Best Practices and linked from Step by Step. I think this is enough; if you disagree, please feel free to open this issue back up again, and comment on what needs to be done (or edit the pages).