Skip to content

Implementation Playbooks

Standardized process for delivering client projects — from discovery to handoff. Every client engagement should follow this skeleton; adapt depth per project size.

Delivery lifecycle

flowchart LR
    A[Discovery] --> B[Solution design]
    B --> C[Scoping & quote]
    C --> D[Setup / development]
    D --> E[QA & UAT]
    E --> F[Go-live]
    F --> G[Handoff & support]

1. Discovery

  • Understand the client's operation: sales channels, fiscal obligations (NFSe!), payment flows, shipping.
  • Identify which CloudXM products apply (see Products).
  • Record decisions in the project notes; get client sign-off.

2. Solution design

  • Map the integration surface: WordPress/WooCommerce, ERP, marketplaces.
  • Define environments: staging for UAT, production for go-live.
  • Confirm fiscal requirements per municipality (NFSe rules vary) — engage ShopXM owner early.

3. Scoping & quote

  • Itemize: licenses, implementation effort, integrations, support plan.
  • Flag dependencies and risks (deadlines, client-side blockers).

4. Setup & development

  • Create staging environment (see Operations runbooks).
  • Implement per product runbooks; keep code in GitLab emcloud.
  • No secrets in code — CI variables or vault.

5. QA & UAT

  • Test fiscal emission end-to-end (staging NFSe environment).
  • Client sign-off on acceptance criteria.

6. Go-live

  • Freeze window, deploy production, verify smoke tests.
  • Rollback plan ready (previous release / docker compose rollback).

7. Handoff & support

  • Hand over credentials via secure channel (never chat).
  • Document client-specific config in the client's folder of this wiki [TODO: create per-client section or external drive].
  • Start support rotation.

Template checklist

[TODO: link a checklist template file (e.g. implementation/checklist.md) once created]