User flows
This section walks through every user journey in your contribute app: what producers do, what contributors see, what emails get sent, and — most importantly for customers customising a deployment — where every piece of visible text comes from and how to change it.
Who this section is for
Section titled “Who this section is for”The flow pages assume no technical familiarity. They describe what users see, what they can do, and what you can change for your branded deployment. They’re written for:
- People configuring translations for a new locale or client
- People customising email templates and branding
- People deciding what to enable/disable in their deployment
- Anyone who needs to understand “what does the app actually do, in plain English”
If you’re a developer looking for code paths, source files, or implementation detail, see the engineering reference.
How a flow page is structured
Section titled “How a flow page is structured”Each flow page follows the same shape:
- What happens — a simple diagram of the user journey
- Step-by-step — what each person sees at each step, with the text they see
- What you can customise — translation files, email templates, URL configs, branding
- Variations for your deployment — how things differ for CDN, NZ, Omni, TEP, or specific survey variants
Contributor journeys
Section titled “Contributor journeys”- Inviting a contributor — the canonical end-to-end flow: a producer adds a contributor, who receives an email, opens the link, answers the survey, and sees a confirmation.
- Self-service QR sign-up — contributor scans a QR code on set (no email needed) and goes straight to the survey
- Unsubscribing from project emails — contributor clicks the unsubscribe link in an email and stops receiving messages about that project
Producer (organisation user) journeys
Section titled “Producer (organisation user) journeys”- Inviting a team member — admin adds a new user to their company, who receives an invitation email and joins
- Editing your organisation — admin updates the company’s name, website, and contact details
- Creating a project — a producer starts a new project from the projects list
- Submitting a project for approval — producer sends a finished project to a funder for verification
- Approving or rejecting a project — funder reviews a submitted project and verifies or rejects it
- Editing episodes — manage the episode list on a multi-episode project
- Editing contributors — bulk-upload, edit, delete, and QR-code-sign-up flows for the contributors list
- Transferring a project to another company — initiate, accept, or reject a project transfer (TEP-only feature)
Authentication and account journeys
Section titled “Authentication and account journeys”- Logging in — sign in with email + password (org users) or email + one-time code (contributors)
- Recovering a password — request a recovery code by email, enter it, set a new password
- Creating an account — a new producer creates an account and a production company at the same time
- Completing your profile — for users with a sign-in but no company; pick “create new”, “join existing”, or “contact support”
- Registering via an invitation link — open an invitation email link and create an account pre-associated with the inviting context
- Joining a company — accept an invitation to join an existing company as a user
- Becoming a company admin — accept an invitation to take ownership of an orphaned production company
- Logging out — sign out, plus the Diamond Code display for contributors who’ve just submitted a survey
User profile
Section titled “User profile”- Editing your profile — name, email, Diamond Code (where enabled), and account deletion
- Your privacy rights — informational page explaining GDPR-style rights and pointing at where in the app each one can be exercised
Reports
Section titled “Reports”- Viewing reports — diversity reports across projects, with filters, demographics, benchmarks, and exports
Where the text comes from
Section titled “Where the text comes from”The text users see on screen and in emails comes from a few places:
| Where | What it controls |
|---|---|
tep-configuration/translations/{locale}/main/ | The global defaults across all clients and locales |
tep-configuration/clients/{client}/translations/{locale}/overrides.json | Your client’s overrides — anything here wins over the global defaults |
tep-configuration/clients/{client}/surveys/{variant}/translations/{locale}/variant-overrides.json | Per-survey-variant overrides (e.g. NZ-specific wording for the NZ standard variant) |
tep-api/.../emailTemplates/{client}-*.mjml | The email templates for your client — supply your own to override the default |
Each flow page calls out the specific translation keys it touches, so you can find them quickly in tep-configuration.
Status
Section titled “Status”This section is being built out in stages, tracked under TEP-527.
- ✅ Inventory — the engineering reference now includes auto-generated tables of every page, every modal/dialog/toast, and every email template in the app. See engineering reference → inventory.
- ✅ Pilot flow — “Inviting a contributor” (the page above) establishes the structure that all remaining flows will follow.
- ✅ Auth flows (8) — login, recover password, create account, complete profile, register via invitation, joining a company, becoming a company admin, logout.
- ✅ Org admin (2) — inviting a team member (consolidates “invite admin” + “invite user” which are the same UI today), editing your organisation.
- ✅ Project lifecycle (6) — creating a project, submitting for approval, approving/rejecting (super-admin / funder), editing episodes, editing contributors, transferring a project (combines invite / accept / reject sub-flows).
- ✅ Contributor (rest) (2) — self-service QR sign-up, unsubscribing. (Token entry, success and error pages are part of the pilot.)
- ✅ Profile (2) — editing your profile, your privacy rights.
- ✅ Reports (1) — viewing reports.
All flows now documented. Phase 3 complete.