Structure for Product Documentation

Foundation: Product Overview article

The "base" document that provides a high level overview.

  • What it "is"
  • Its features and the problems it solves
  • Highlight core sections / functionality / topics

Building Blocks: Product Detail articles

Articles focused on "breaking out" the specific sections / functionality / topics mentioned in the high level overview.

  • Linked FROM Product Overview article

Finishing Touches: Product FAQ

These articles focus on specific use-cases and are typically formatted as “How To” or “Ask & Answer."

  • We can create some of these, and seed the section
  • Most of these will get created as a result of interactions with end users
  • These are linked FROM relevant Product Detail articles