Document Actions
Creating a Good Documentation Section
Plone Software Center can contain all the documentation types of Plone Help Center, giving you an easy way to manage your documentation needs.
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
3
of
7.
From your software project, you can add all the types from Plone Help Center. These include:
- FAQs: Frequently asked questions about your product
- HowTos: explanations of concepts and procedures
- Tutorials: longer, step-by-step explanations (like this one)
- Error Messages: Explanations of common error messages
- Glossary: Glossary of terms
- Videos: Video clips explaining your application
- Reference Documentation
Of course, not all projects will need all of these types — smaller projects may just benefit from a FAQ section and a HowTo section. You can add these at any time, so this grow with your project.
by
Joel Burton
—
last modified
May 8, 2005 - 23:56
Contributors:
Alexander Limi
All content is copyright Plone Foundation and the individual contributors.
