Child pages
  • Product Documentation

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Document Properties Marker
overridefalse


Short DescriptionProvide information on how users work with your product. This includes information for users of all roles that interact with the product. 
Doctypebusiness-use-casehide
NameProduct Documentation 
Parent
Parent Property
property-nameName
 
Audience
Name List
doctyperole
propertyAudience
 
Subject
Name List
doctypesubject
propertySubject
 
Categories
Name List
doctypecategory
names/ Document / EntityProduct
space-keys@all
propertyCategories
 
Tags
Tag List
propertyTags
 
Iteration

Iteration
value

facade

production

hide
Sort Keyhide



Section
titleDescription


Section
show-titlefalse
titleSummary

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 PDAC1 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.

 


Section
required-permissionswrite-access
titleNotes

...

Section
titleReferences


Section
titleResources


Section
titleInformation Material

The following list of resources provides background information on creating and working with product documentation based on the PDAC1 for Confluence.

Tour
header-translationsName=Resource, Doctype=Type
replace-title-with-nametrue



Related doctype add-ons are

Tour
header-translationsName=Resource, Doctype=Type
replace-title-with-nametrue





Section
titleDoctypes

The following doctypes (blueprints with additional metadata based on the PDAC1) provided page blueprints to create and maintain a product documentation.

Tour
header-translationsName=Resource, Doctype=Type, Set=Suite
replace-title-with-nametrue





Section
titleMacros

The following macros of the PDAC1 support creating or working with a product documentation.

Tour
header-translationsName=Resource, Doctype=Type
replace-title-with-nametrue