Product Docs
Each internal tool gets its own product section under this page because users need to know which system owns a workflow before they follow an operating procedure or make a production change. That keeps user training, admin procedures, and developer notes tied to the system they operate, while shared concepts such as Salesforce, deployments, permissions, and glossary terms stay in global sections.
The rule is simple: if a page only makes sense for one application, place it under that product. If it applies across applications, place it under Operations or Reference and link to it from the relevant products.
Mental model
Current product sections
Inspection App
Mobile inspections, Review Mode, Expert Mode, proposals, product mappings, pricebooks, and Salesforce submission.
PoolTracker / Preseason
Preseason summerization board plus recurring service management for SCMG and Houston operations.
Proposal Tools
PDF/DOCX generation, proposal templates, customer documents, and Salesforce proposal attachments.
Folder model
Use this structure as more projects move into the portal:
content/
├── products/
│ ├── inspection-app/
│ ├── preseason/
│ └── proposal-tools/
├── operations/
└── reference/| Content path | Use it for |
|---|---|
content/products/<project-slug>/index.mdx | Project overview, audience, source repo, system boundaries, and links to project workflows. |
content/products/<project-slug>/<workflow>.mdx | Workflow-specific pages that only apply to that application. |
content/operations/*.mdx | Shared operating procedures, deployments, roles, access, governance, and release rules. |
content/reference/*.mdx | Glossary, source-project inventory, cross-product lookup material, and stable definitions. |
Add-a-project checklist
Before creating a new product section, identify:
- the source repository path;
- the primary audience;
- the operational owner;
- the production and preview deployment path;
- the systems it reads from or writes to;
- the workflows that deserve their own pages.
Do not copy a repository README wholesale into the docs portal. Start with an overview that explains what the tool does, who uses it, where it fits, and which pages the reader should open next.
Related pages
- Overview explains the portal model.
- Source Projects tracks which internal repositories are planned or started.
- Deployments explains the separation between application deploys and docs deploys.