Product documentation

The product documentation, at account.products.product.documentation, should contain complete user documentation for the product. It can be built as a hierarchy of pages using the Page type, augmented by pictures and screen shots as necessary. Documentation-only files should be held in the documentation area, not in the public folder.

See Gadgets in the sample product for an example of product documentation.

The documentation should include:

  • A general introduction to the product.
  • An explanation of any concepts on which the product is based.
  • An illustrated guide on how to use the product. Show a screen shot of each significant screen and a description of how to use it.
  • If the product may be suitable for further extension, or incorporation into another product, the documentation should also contain suitable details of the technical implementation, sufficient to allow a developer to build extensions.