Content Guidelines for Plone Sites and Providers

by Alex Limi last modified Nov 22, 2011 05:22 PM
Some editorial guidelines for adding content to the listings of providers and sites.
Language
All plone.org site and provider listings should be in English. It is supposed to be an international overview. This also ensures that customers from Austria can look for Italian companies, for instance. (And if something's written in Icelandic, none of the reviewers can see if it is a proper description or a recipe for cooking baby unicorns!)

Provider and Site Listings

Submitting a provider
Unless you're purely a Plone hosting provider, please only submit yourself if you've also added a site. It is a prerequisite as it proves that you're a genuine Plone company. Please don't submit your company's site itself in the site listing. We assume you're probably using Plone for your own site, so the link from your company's page is enough.
Avoid buzzwords
Don't use the word "leading", "best", "biggest", "most innovative" or any other hard-to-quantify qualification. We don't have a "leading Plone company of the galaxy."
URLs of sites
Make sure the link points to the real site, not to some portfolio page on your own company website. If it is an intranet (which is fine), leave out the link, and clicking on the small screenshot image will show the full size screenshot (instead of following the link as happens otherwise). An elaborate intranet is a perfect candidate for a case study!
Title and URL of providers
The title of your provider listing should be the name of your firm. Period. We will reject or modify listings that appear to be attempts at Google-juicing e.g. "Your Firm - Plone Hosting" with a shortname of "your-firm-plone-hosting". Please avoid leading punctuation such as ".: My Site Name :." - this messes up our alphabetical sorting.

Case Study Guidelines

Our vision for the case studies section is to have a limited selection of high quality case studies, targeted at people deciding whether or not to use Plone, that showcase the ways in which Plone can help solve real-world web publishing problems.

If you've done a project that makes Plone look good, we enthusiastically encourage you write up a case study that has as many of the following qualities as possible:

  • Written in standard business English, free from grammatical and typographic errors.
  • ~1000-2500 words in length
  • Covers a specific project that has reached a successful conclusion
  • Feature a well-known client
  • Includes the following sections:
    • The specific business or technical problem(s) the client faced
    • How you used Plone to solve the problem(s)
    • The positive business results the client has experienced as a result of using Plone.
  • Includes specific and appropriate metrics of success
  • Includes appropriate quotes from the client/user of Plone
  • Includes appropriate screenshots of the project
  • Describe the resources necessary to execute the project (labor, cost, etc.).
  • Allows prospective users of Plone to see themselves in the story
  • Show how Plone allows repeatable success
  • Follow Jakob Nielsen's guidelines for writing on the web, including:
    • Short paragraphs
    • Descriptive headings and subheadings
    • Highlight key phrases / scannable text
    • No superfluous words
  • Make Plone the hero of the story, not your consulting firm.

The Plone.org editorial team reserves the right to edit case studies for length and for content. We'll let you know if we want to make non-trivial changes. We may or may not publish all case studies that are submitted.

By making sure you conform to the above, this makes our job much easier. Thanks!