Topic guide documentation outline

documentation-outline.md

Introduction

A short bit about what this guide is and why its important

Overview

Should explain the goal of the document, and generally these should be included

• details
• cross-references
• next steps
• notes
• warnings

Section

Each section should have:

• overview
• Tasks & examples
• Detailed descriptions
• Common pitfalls, and warnings

Section Example

Each section should have one or more of these with the following:

• Code / request examples
• Detailed instructions
• Relevant API documentation links
• Potential and or common problems or pitfalls
  • Links or docs for troubleshooting