Template Organization

The organization of most documentation systems is first by product. This is a sensible structure in general, because there are different types of documentation that are applicable to different products.

For example, if you examine the current templates you'll find that there is currently a mix of two different product types in the main directory: API's and UI's. We might also support physical products. It would be nice to have a SME from the community to support that and give us some requirements.

Templates

For example, we have api-overview, api-quickstart, and logging, which are api/developer focused documentation. On the other hand we have reference material for UI products, like explanation and reference. There may be some grey areas in here, where explanation documents are also applicable to api's. Regardless, we should divide the top level structure into products, and structure the templates like this:

• Product Type
  • Template Type

In practice, for the existing templates:

• API Documentation
  • api-overview
  • api-quickstart
  • api-reference
  • logging
• UI Documentation/Basic? These are the templates from diataxis
  • explanation
  • how-to
  • reference
  • tutorial
• Physical Product Documentation
  • Templates TBD
• Documentation Guidelines
  • style-guides

Currently uncategorized templates, pending discussion with @cameron:

• base https://github.com/thegooddocsproject/templates/tree/dev/base
• incubator https://github.com/thegooddocsproject/templates/tree/dev/incubator
• ia-guide https://github.com/thegooddocsproject/templates/tree/dev/incubator