Introduction

MPP wiki documentation consists from a big number of articles. Each article describes a separate aspect of a product. Described aspects are generaly related to each other. This relationship is reflected with links between articles. Documentation structure is a set of articles with links between them.

Main stakeholder for the documentation is Reader. Documentation structure must serve the following Reader's goals:

• Educational -- Reader little knows about a product and wants to learn how it works and how to use it going through basic concepts to each tiny detail.
• Referential -- Reader is educated at some extent about a product and wants to find out how to solve a specific problem with its help.

The following instruments may be used to support documentation structure:

• Link -- any kind of link supported by wiki software.
• Roadmap -- special article which main purpose is to provide a guidelines through a set of other articles. It contains brief description of what each article contains, what for it should be read and a link to it. It also may contain brief description of a common theme that makes these articles listed together.

Product- and feature-centric view

Natural center points around which documentation is organized are products and their features. Features belong to a product, products are described by a documentation. As so there is a three-level hierarchical documentation organization:

• All products roadmap.
• Product roadmap.
• Features description.

The following diagram illustrates this kind of documentation organization:

All products roadmap

All products roadmap lists all products covered by the documentation. For each product it has a brief description of a main purpose of a product, a few main use-cases and features and finaly a link to a product roadmap. This is the starting point for those who want to learn all products and it is a main page for the documentation.

The roadmap's article is organized as columns view. Each columns dedicated to a specific product. This is pretty like on sales site but with less graphics and with focus on the purpose of been a roadmap.

Product roadmap

Product roadmap contains more detailed description of a specific product. This may include concepts, detailed use-cases and features. Then the roadmap lists all features description articles related to a product along with guidelines of how to go through these articles for those who want to learn a product. For each article the roadmap has brief description of main purpose of an article, what for it should be read and finaly a link to an article. Documentation contains one product roadmap for each product.

The roadmap's article organized as TODO.

Features description

Features description contains detailed description of one or more features or solutions or configurations or any other aspects related to a product. While a roadmap is intended mainly to support documentation structure, main purpose of a feature description is to form a "bulk" content of the documentation. It provides final answer on how to use a feature, how to configure it, how it will work, etc.

The feature description article organized as TODO.

Access rights

Core documentation is available for editing only for stuff members. In perspective it may worth providing separate editable areas for partners and end-users.