Personal tools
You are here: Home Documentation Tutorials Listing Your Project in Plone Software Center Tips for a Successful Project
Support

Get Help

Join our chat rooms or support forums if you have more specific questions.

Plone Training
Learn how to design, build, and deploy a website in Plone through one of the numerous Plone training sessions around the world.
Find Plone training…
 
Document Actions

Tips for a Successful Project

Ideas for naming conventions, writing project descriptions, and other points for a succesful project.

pupq

Plone Software Center allows you to list your product on plone.org, show releases, manage your documentation, handle improvement plans, and more--all without forcing you into any particular development process or repository. We intend for this to become the canonical repository for Plone products. This tutorial walks through the benefits of PSC and demonstrates how to make the most of it.
Page 6 of 7.

Part of the goal of Plone Software Center is to make Plone's add-ons more friendly for integrators and end users. For these users, a good name for your product will be very helpful.

I'd recommend you steer away from names that:

  • contain implementation-level details
  • are excessively technical
  • are vague

For example, Plone Software Center itself was originally called "ArchPackage", which violated all three principles:

  • it contained the name "Arch", suggesting that it was Archetypes-based. This is not so critical or important feature for someone shopping for a useful software-listing-product that it's worth putting in the title.
  • The abbreviation for "Arch" as Archetypes is obscure enough that even some people that know what Archetypes is wouldn't have recognized it anyway.
  • The name "package" is too vague for people to understand that these are software products being managed.

With these ideas in mind, I'd steer clear of any of the "CMF*", "Plone*", "AT*" naming schemes. Better is to find a name that users can associate with your product, rather than one that tries to explain exactly what it does, or how it does it.

Good names:

  • Haystack (a product for extracting searchable information from data)
  • Archetypes
  • LinguaPlone

They're all suggestive and "product-y".

Similarly, when writing your project description, consider that people looking at your project may have no idea what is does. Focus on explaining what it is for rather than how it works (avoid the tendency to lead with "I used a BTree...", for example).

To help make sure the product repository is as helpful as possible for our community, the plone.org team may suggest edits your project description for clarity.

 
by pupq — last modified May 8, 2005 - 23:56
Contributors: Alexander Limi
All content is copyright Plone Foundation and the individual contributors.

For any issues with the web site functionality, please file a ticket.

Please consult the policy on plone.org content if you want your content published on this site.

Servers and hosting by