example handover / MANUAL.md

MANUAL — Job Board, Granite State Mechanical

This is an example from the demonstration project on this site. For a real build, this manual covers your real system, in this same plain language. It's written for the office, not for developers — the technical page for the next developer is at the end.

Opening the job board

Go to the job board's address (it's bookmarked on the office computer and listed in ACCOUNTS.md). It works on the shop floor tablet and on phones. No login is needed inside the shop network; the owner can change that any time.

Day to day

Find a job. Type any part of the job name, customer, or PO number in the search box. The list narrows as you type.

Add a job. Tap New job, fill in the customer, site, crew, and dates. Required boxes are marked; everything else can wait.

Change a job's status. Open the job, tap the status (Scheduled → In progress → Done → Invoiced). The board updates everywhere at once — there is no "other tab" to forget.

See a crew's week. Tap Schedule, pick the crew. Monday morning requires zero copying and zero pasting. The week is just there.

The recovered jobs. Six jobs carry a small recovered badge — they came out of a hidden tab in the old workbook ("Mike's copy") during the rebuild. The badge is there so nobody wonders where they came from. It can be removed once everyone's confident.

Things that used to go wrong, and can't now

  • Totals are computed from the jobs themselves. There is no "Total" cell that somebody typed in 2023 and nobody dares touch.
  • Dates are dates. They sort correctly no matter who typed them.
  • There is one copy of the truth. Nobody edits "Jobs 2025 (2)" by mistake, because there is no "Jobs 2025 (2)".

If something looks wrong

  1. Refresh the page. (Honestly, it fixes more than it should.)
  2. Check ACCOUNTS.md → "Hosting" — the status page link shows if the host is having a bad day.
  3. Within 60 days of delivery: call or text me, it's mine to fix, free, response within one business day. After that: the support plan if you have it, or hand the developer page below to anyone you trust.

For the next developer

It's a static web app: plain TypeScript, no server, no database, mainstream build tools, dependencies pinned. Clone the repo in ACCOUNTS.md, follow app/README, and read DECISIONS.md before changing data shapes. Test data and the data-loading seam are documented in the app README.


← Back to the folder