Mission & scope

Mission

Example Retail Energy Provider exists to design, build, and operate software and integrations that support retail energy operations — from customer and account lifecycle to billing, usage, and the integrations that connect us to markets and utilities.

Scope of this documentation site

This site documents how we work and how the platform is organized:

• Repository layout and naming conventions.
• High-level architecture and boundaries between services.
• Pointers to engineering standards (build tools, security, observability).
• Operational practices that apply across repositories (for example, GitOps layout on OpenShift).

It does not replace:

• Runbooks that live next to a specific service.
• Vendor or regulator documentation.
• Customer-facing help or legal disclosures.

Principles

Principle	Description
Clear ownership	Each deployable service or app has a home repository with an obvious name and prefix.
Security by default	No secrets in git; authentication uses industry-standard patterns (OIDC / JWT).
Observable systems	Services are built so they can be monitored and traced in production.

As the platform grows, this section should evolve into a short north star paragraph and links to architecture decision records (ADRs) where they exist.