Production Ready Documentation
  • Introduction
  • Product
    • Description
    • Architecture Diagram
    • Endpoints, Flows, and Dependencies
    • Release Notes
  • Guides
    • User Guide
      • Getting Started
      • Core Concepts
    • Development Guide
      • Setup
      • Code Standards
      • Code Reviews
      • Testing
      • Deployment Pipeline
  • Troubleshooting
    • Contact Information
    • Runbooks
      • Order 66
  • Resources
    • References
    • FAQ
Powered by GitBook
On this page
  • Getting Started
  • Core Concepts

Was this helpful?

  1. Guides

User Guide

Describe how a user can use the product; whether this is a developer building something based on the product's API or an end user interacting with a UI.

Getting Started

Document how to setup and begin using the product in the getting started section. List any prerequisites needed and provide installation instructions. Write a tutorial or outline a workflow that illustrates the basic use of the product and ensures the product is installed correctly.

Core Concepts

Express the main ideas around using the product. Include conventions used, provide a glossary of terms. Detail major components of the product and how the product works in general terms.

PreviousRelease NotesNextGetting Started

Last updated 5 years ago

Was this helpful?