Warning

This document hasn't been checked for compatibility with current versions of Plone. Use at your own risk.

Creating Documentation for Plone.org

Best practices and tips for writing good documentation for plone.org

  1. Introduction A word on writing for plone.org
  2. What’s appropriate documentation? Identify the true goal of your documentation: is it marketing, or is it truly useful for the end user?
  3. Document Types What kind of document do you want to create?
  4. Writing Some helpful tips on writing documentation
  5. How to Submit a Document for Review Here are the steps needed to create a document to be included in the core plone.org docs section.

All content on one page (useful for printing, presentation mode etc.)

 

Contribute

Something wrong or out of date? Anybody can edit or create a new article in the knowledge base. Simply create an account on this site, log in, and click the Edit button to contribute.