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

Was this helpful?

  1. Product

Architecture Diagram

PreviousDescriptionNextEndpoints, Flows, and Dependencies

Last updated 5 years ago

Was this helpful?

Include a single core diagram of the product. Detail the product's components, endpoints, request flows, dependencies (upstream and downstream), and data stores (databases or caches).

The architecture diagram is a visual representation that summarizes the complexity of the product. It helps developers reason about adding new features and identify potential issues or points of failure.

Example

Architecture Diagram