- Created by Robert Reiner, last modified on 31. Dec 2017
Provide information on how users work with your product. This includes information for users of all roles that interact with the product.
- Categories
Employing a wiki to add product information is a quick an easy way to allow each stakeholder to work on presenting information that is relevant for customers and users.
Customer facing information is required to follow the principle of least astonishment. That is a customer needs to find the required information quickly and in an expected format. This expected format allows the customer to find the relevant information quickly in a page.
For open source software products, especially plugins for Maven, the Maven Site Plugin provided a way to generate a product site based on information checked in with the source code. The result is that those pages share a common navigation structure. This helps users of plugins for Maven to find information quickly despite the fact that the creators of plugins are working for different organisations or do many of their work in their spare time.
Th projectdoc Toolbox provides doctypes to support a common structure for open source projects. projectdoc for Maven Developers create pages for plugins by reading information from the POM and plugin descriptor (see User Documentation for Maven Plugin). projectdoc for Java Developers also reads information from a POM to create spaces to document libraries for Java (see User Documentation for Java Library). The Doctypes for App Manuals provide doctypes to document apps for Confluence or projectdoc.
Resources
Information Material
The following list of resources provides background information on creating and working with product documentation based on the projectdoc Toolbox for Confluence.
| Resource | Short Description |
|---|---|
Document macros, page blueprints, space blueprints, and components of your Confluence add-on. | |
A collection of blueprints for Confluence to create and work with documentation for Maven projects. | |
A collection of blueprints for Confluence to create and work with documentation for Java projects. | |
Get started with the projectdoc Toolbox: learning by doing | |
A gentle introduction to page blueprints provided by doctype add-ons. The page blueprints are grouped semantically to make it easier for users to build a conceptual mind map for them. | |
Concepts central to projectdoc. Things users have to understand to get the most out of using projectdoc. |
Related doctype add-ons are
| Resource | Short Description |
|---|---|
Provides doctypes to create documentation in software development projects. The focus is on documenting the architecture of the product, but it includes templates for other software development documentation requirements as well. | |
Provides doctypes to document services and systems for IT service management (ITSM). | |
Use products (templates) from the V-Modell®XT in your Confluence wiki as blueprints! |
Doctypes
The following doctypes (blueprints with additional metadata based on the projectdoc Toolbox) provided page blueprints to create and maintain a product documentation.
| Resource | Short Description | Suite | Categories |
|---|---|---|---|
Provide more detailed information about a component of a tool. | |||
Document the purpose and usage of the macro. | |||
Document a service provided by an app. | |||
Document the purpose and usage of a page blueprint. | |||
Document the usage of a doctype for your users. | |||
Document the usage of a document property for your users. | |||
Document the usage of a document section for your users. | |||
Metadata documents provide tables of simple key/value pairs. This information can be used as an aspect or as additional space properties to be available for reference on your wiki. | |||
Document a version of a product or service. |
Macros
The following macros of the projectdoc Toolbox support creating or working with a product documentation.
| Resource | Short Description | Categories |
|---|---|---|
Renders a template with property references. | ||
Lists references to projectdoc documents in a table. Allows to select document properties for columns. Also non-list representations are provided. | ||
Renders a predefined list of documents in a table. | ||
Transclude text content from a remote server. | ||
Transclude content from a resource from a remote system. | ||
Renders an image transcluded from a remote server. | ||
Renders an image transcluded from a remote server. |
