Documentation

Written for the person doing the job

Two bodies of documentation. One ships inside the product and is organised by role, because a bus driver and a registrar need different pages. The other is the operator runbook, and it assumes you are the person holding the root password.

In the product

Help, organised by job rather than by feature

Every install ships with these articles at /Help, in English and Spanish. They are deliberately opinionated: each one says not just how a screen works but what habit makes it worth using.

Where to start, by job

What to open if you teach, drive a bus, run a building or work a front office — and the one habit that makes the rest work.

Your access

Why you can see what you can see, and how to ask for more.

Finding things

Global search, saved views and the difference between them.

IT helpdesk

Filing a ticket that is resolvable on the first pass, filing on behalf of a colleague, and the walk-up kiosk.

Assets and devices

Check-out, audits, labels and what an asset record is actually for.

Facilities work orders

Queues, QR scanning equipment, and what belongs in a work order versus a phone call.

Safety

Reporting incidents as evidence rather than conclusion, drill logs, plans, rosters and the SDS register.

Security and footage

Requesting camera footage, and why the approval chain is what it is.

Transportation

Conduct write-ups, field trips and daycare transportation.

Reservations

Booking spaces, outside organisations, blackouts and insurance.

Custodial supply

Ordering, the reorder queue, warehouses, receiving and cycle counts.

HR and seniority

Requests, onboarding ownership, and why an adjustment carries a reason.

Payroll

Raising a pay inquiry, the off-cycle queue, and the controls you will meet.

Professional development

Requests, approvals, expense claims and per-diem.

Student records

The seven-step inbound chain, whose turn it is, and how due dates are counted.

Public records

APRA intake, the statutory clock, and annual reporting.

Contracts

Renewal terms, CFO and Board review, and COI compliance.

Badging

Issuing cards, batch printing, templates and credentials.

Projects

When a board beats a ticket, and the two habits that make one worth keeping.

Finance

Where the numbers come from, and how to follow one back to its source.

"File it rather than mentioning it. A hallway conversation is not a record, and in March nobody can find it."

— from the teacher section of Where to start, by job

For whoever runs it

Operator runbooks

These ship with the source. They assume competence and do not pad — the deployment guide, for instance, tells you to read it top to bottom once before running anything, and means it.

Deployment guide

The full install runbook — scripted, manual and Proxmox paths, nginx and TLS, PM2, database setup, and the worked IdP examples.

SAML how-to

Wiring Entra, Okta or Google Workspace, attribute names, and writing claim-to-role mapping rules.

Backup & disaster recovery

The three stores to protect, recommended cadence, and what a restore actually looks like.

Retention policies

Configuring per-data-class retention, and how the footage scrub is enforced by the worker.

API & tokens

Issuing scoped tokens, the permission cap, and the REST surface.

Webhooks

Outbound HMAC signing and verification, inbound endpoints, and reading the delivery log.

Workflows

Building approval chains and onboarding fan-outs without touching code.

Notifications

The event registry, per-user delivery preferences, and web push setup.

Performance

What to look at when something is slow, and the indexes that matter.

FERPA summary

The compliance write-up General Counsel will want before signing off.

Accessibility

The WCAG 2.1 AA commitments and how they are verified.

Sentinel bridge

The signed directory bridge to the Algo intercom platform, request signing and projections.

Onboarding a customer

How a district becomes a profile rather than a fork — the document that keeps the upgrade path intact.

Architecture decisions

The decision log: what was chosen, what was rejected, and why.

Getting the docs

They come with the licence

Licensed districts get the full set — staff help is in the product from day one, and the operator runbooks come with the deployment.

Evaluating rather than licensed? Ask, and we will send the documents a review actually turns on: the deployment requirements, the FERPA compliance summary, the accessibility statement and a completed copy of your own security questionnaire. Those go out before anything is signed.

A customer documentation portal is on the roadmap. CampusLink is proprietary software and the source is not distributed, so documentation is delivered as a bundle rather than as repository access.

Also included

  • Changelog Every release, what changed and why — written in plain language rather than commit subjects.
  • Upgrade notes What each release needs from an operator: migrations, config changes, and anything that wants a maintenance window.
  • Support model What each tier covers, response commitments, and how to escalate — stated plainly before you rely on it.
  • Data dictionary What each module stores and where, for districts writing their own reports against the database.

Reviewing us on paper first?

Send the questionnaire, the accessibility conformance request, or the security assessment. We would rather do the paperwork early than discover a blocker late.