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

Description

Briefly identify the purpose of the product, so anyone who reads the documentation will be able to quickly understand the role of product.

Keep It Short and Sweet

Simply state what the product does and why in no more than three sentences. If you are having trouble coming up with a description consider this question: "What problem does the product solve?"

Example

Production ready documentation increases developer productivity, helps resolve issues faster, and creates a shared understanding of the product. As a result, production ready documentation can be trusted to support a product running production traffic.

PreviousIntroductionNextArchitecture Diagram

Last updated 5 years ago

Was this helpful?