Skip to Content
Getting StartedOverview

Overview

Commercial Aquatics runs several internal tools that share the same operational backbone: Salesforce customers, divisions, branches, catalog mappings, pricebooks, proposals, inspections, service visits, preseason planning, and role-based user access. This portal exists because those concepts cross product boundaries, and users need a stable place to understand why a workflow behaves a certain way before they operate it in production.

This documentation site is a standalone portal for those tools. Each source application gets a first-class section under Product Docs, while shared operating rules live under Operations and stable definitions live under Reference.

Mental model

Audience

  • Field users need task walkthroughs with screenshots and short decision points.
  • Managers need role-specific guides, review procedures, and Salesforce reconciliation notes.
  • Administrators need catalog, pricebook, user, and mapping reference material.
  • Developers need architecture, environment, deployment, and integration notes.

Why this is separate from the app

A separate docs repo keeps documentation safe to update independently. It avoids coupling a training copy edit to a production field app deploy, and it gives us a single place to document multiple internal applications.

The app should link to this site, but the docs site should remain its own Git repository and NTM project.

Project separation rule

Put application-specific material under content/products/<project-slug>/. Put shared deployment, permission, governance, and Salesforce operating rules under content/operations/. Put vocabulary and source-project inventory under content/reference/.

For example, PoolTracker’s route planning workflow belongs under /products/preseason, but the rule that docs deploy independently at docs.ca-tools.io belongs under /operations/deployments.

Last updated on
Product Docs