Add README.md
This commit is contained in:
parent
9054413fd3
commit
46ca54a831
350
README.md
Normal file
350
README.md
Normal file
@ -0,0 +1,350 @@
|
||||
# Arbeidspuls
|
||||
|
||||
[Read this README in English](README.en.md)
|
||||
|
||||
**Arbeidspuls** er en lett, personvernvennlig webapp for egenrapportering av arbeidsevne, funksjon, energi, symptomer og belastning over tid.
|
||||
|
||||
Tjenesten er laget for praktiske situasjoner der en person skal dokumentere faktisk funksjon i en arbeidssituasjon, for eksempel ved arbeidsutprøving, gradvis tilbakeføring, langvarig sykdom, utmattelse eller andre forhold som påvirker kort- og langtidskapasitet.
|
||||
|
||||
Arbeidspuls er rask å bruke fra telefonen, men gir samtidig veiledere en ryddig måte å gjennomgå trender, rapportdetaljer, oppfølginger og notater på.
|
||||
|
||||
> Arbeidspuls er et verktøy for strukturert egenrapportering og gjennomgang. Det erstatter ikke medisinsk vurdering, arbeidsmedisinsk utredning eller formelle vedtak.
|
||||
|
||||
---
|
||||
|
||||
## Hvorfor hoste Arbeidspuls?
|
||||
|
||||
Arbeidspuls passer for aktører som ønsker en enkel og lavterskel løsning for arbeidsevnerelatert egenrapportering uten å måtte drifte et tungt fagsystem eller en sentral database.
|
||||
|
||||
Tjenesten er særlig relevant for:
|
||||
|
||||
- arbeidsutprøving
|
||||
- oppfølging over tid
|
||||
- gradvis tilbakeføring til arbeid
|
||||
- dokumentasjon av funksjon, belastning og restitusjon
|
||||
- veiledere, rådgivere eller fagpersoner som skal gjennomgå rapporter
|
||||
- miljøer der dataminimering og lokal lagring er viktig
|
||||
|
||||
Arbeidspuls er bygget som en statisk webapp/PWA. Det betyr at den normalt kan hostes som vanlige statiske filer.
|
||||
|
||||
Den krever normalt ikke:
|
||||
|
||||
- serverdatabase
|
||||
- innlogging
|
||||
- backend-API
|
||||
- Node-prosess i produksjon
|
||||
- sentral lagring av sensitive rapporter
|
||||
|
||||
Brukeren eier dataene sine lokalt i nettleseren og deler dem aktivt ved å eksportere en JSON-fil.
|
||||
|
||||
---
|
||||
|
||||
## Hovedfunksjoner
|
||||
|
||||
- rask egenrapportering fra telefon
|
||||
- 1–5-skalaer for sentrale funksjonsområder
|
||||
- valgfrie detaljer for arbeidssted, arbeidstid, oppgavetype, begrensninger og tilrettelegging
|
||||
- oppfølging etter arbeidsøkt for å fange forsinket forverring/restitusjon
|
||||
- oversikt med tidsbasert trendgraf
|
||||
- lokal import/eksport av JSON
|
||||
- veiledervisning for gjennomgang av eksporterte rapporter
|
||||
- veiledernotater per bruker, rapport og oppfølging
|
||||
- fullskjerm grafanalyse for veileder
|
||||
- lokal integritetskontroll av rapporter
|
||||
- norsk og engelsk brukergrensesnitt
|
||||
- kan installeres som PWA/WebApp på telefon og nettbrett
|
||||
|
||||
---
|
||||
|
||||
## Skjermbilder
|
||||
|
||||
Skjermbildene ligger i [`screenshots/`](screenshots/).
|
||||
|
||||
### Registrer rapport
|
||||
|
||||
|
||||
|
||||
Brukeren kan registrere en rapport med få trykk. Hovedfeltene er raske 1–5-valg, mens valgfrie detaljer kan åpnes ved behov.
|
||||
|
||||
### Oppfølging
|
||||
|
||||
|
||||
|
||||
Oppfølging brukes etter en arbeidsøkt, for eksempel samme dag, dagen etter eller senere. Dette kan være nyttig når symptomer eller utmattelse kommer forsinket.
|
||||
|
||||
### Oversikt og trend
|
||||
|
||||
|
||||
|
||||
Oversikten viser rapporter, oppfølginger, totalscore, kategoriscore og trend over tid. Grafen bruker faktisk tidsavstand mellom rapporter.
|
||||
|
||||
### Rapportdetaljer
|
||||
|
||||
|
||||
|
||||
Brukeren kan åpne en rapport for å se detaljer og eventuelt slette lokale rapporter.
|
||||
|
||||
### Personvern og datahåndtering
|
||||
|
||||
|
||||
|
||||
Personvernsiden forklarer lokal lagring, eksport/import, deling med veileder og sletting av lokale data.
|
||||
|
||||
### Veiledergjennomgang
|
||||
|
||||
|
||||
|
||||
Veiledervisningen lar en veileder importere JSON-filer fra brukere, se rapporter, lese detaljer, legge inn egne notater og sammenligne utvikling over tid.
|
||||
|
||||
### Fullskjerm grafanalyse
|
||||
|
||||
|
||||
|
||||
I veiledervisning kan grafen åpnes i fullskjerm for mer presis gjennomgang, tidsfiltrering og inspeksjon av konkrete datapunkter.
|
||||
|
||||
---
|
||||
|
||||
## For brukere
|
||||
|
||||
### Åpne tjenesten
|
||||
|
||||
Gå til:
|
||||
|
||||
```text
|
||||
https://arbeidspuls.rolfsvaag.no
|
||||
```
|
||||
|
||||
Arbeidspuls fungerer på telefon, nettbrett og PC. Den er laget phone-first, slik at rapportering skal være raskt og lite belastende.
|
||||
|
||||
### Installer som app på telefon eller nettbrett
|
||||
|
||||
Arbeidspuls kan installeres som en PWA/WebApp.
|
||||
|
||||
På Android/Chrome:
|
||||
|
||||
1. åpne Arbeidspuls i Chrome
|
||||
2. trykk på menyen
|
||||
3. velg **Installer app** eller **Legg til på startsiden**
|
||||
|
||||
På iPhone/iPad/Safari:
|
||||
|
||||
1. åpne Arbeidspuls i Safari
|
||||
2. trykk på delingsknappen
|
||||
3. velg **Legg til på Hjem-skjerm**
|
||||
|
||||
Etterpå kan Arbeidspuls åpnes som en vanlig app fra startskjermen.
|
||||
|
||||
### Lagre en rapport
|
||||
|
||||
Velg **Registrer**, fyll ut hovedfeltene og trykk **Lagre rapport**.
|
||||
|
||||
Hovedfeltene er:
|
||||
|
||||
- arbeidsevne akkurat nå
|
||||
- energinivå
|
||||
- mental klarhet / konsentrasjon
|
||||
- symptombelastning
|
||||
- anstrengelse / belastning
|
||||
- om du kan fortsette, trenger pause, trenger enklere oppgave eller ønsker å stoppe
|
||||
|
||||
Valgfrie detaljer kan brukes hvis du vil legge til mer kontekst, for eksempel arbeidssted, arbeidstid, fysisk/mental energi, oppgavetype, begrensninger, hva som hjalp og kort kommentar.
|
||||
|
||||
### Lagre en oppfølging
|
||||
|
||||
Velg **Oppfølging** for å registrere hvordan du har det etter en arbeidsøkt.
|
||||
|
||||
Dette kan brukes for å dokumentere:
|
||||
|
||||
- om du er verre enn før arbeidsøkten
|
||||
- forsinkede symptomer
|
||||
- restitusjon
|
||||
- kort kommentar
|
||||
|
||||
Oppfølging er særlig nyttig dersom reaksjonen kommer senere enn selve arbeidsøkten.
|
||||
|
||||
### Se oversikt
|
||||
|
||||
Velg **Oversikt** for å se tidligere rapporter, oppfølginger og trendgraf.
|
||||
|
||||
Oversikten viser blant annet:
|
||||
|
||||
- totalscore
|
||||
- arbeidsevne
|
||||
- energi
|
||||
- mental klarhet
|
||||
- symptomer
|
||||
- belastning
|
||||
- oppfølginger knyttet til rapporter
|
||||
|
||||
### Eksporter data til veileder
|
||||
|
||||
Hvis en veileder eller annen person skal gjennomgå rapportene dine:
|
||||
|
||||
1. gå til **Personvern**
|
||||
2. velg **Eksporter JSON**
|
||||
3. send JSON-filen til veilederen, for eksempel via e-post eller annen avtalt kanal
|
||||
|
||||
JSON-filen kan inneholde sensitive helse- og funksjonsrelaterte opplysninger. Del den bare med personer som faktisk skal ha tilgang.
|
||||
|
||||
### Importer tidligere data
|
||||
|
||||
Hvis du har byttet enhet, byttet nettleser eller mistet lokale data, kan du importere en tidligere eksportert JSON-fil via **Personvern**.
|
||||
|
||||
---
|
||||
|
||||
## For veiledere
|
||||
|
||||
Veiledervisningen finnes på:
|
||||
|
||||
```text
|
||||
https://arbeidspuls.rolfsvaag.no/veileder
|
||||
```
|
||||
|
||||
eller:
|
||||
|
||||
```text
|
||||
https://arbeidspuls.rolfsvaag.no/evaluator
|
||||
```
|
||||
|
||||
### Importere rapporter
|
||||
|
||||
1. Be brukeren eksportere JSON fra **Personvern**
|
||||
2. Åpne veiledervisningen
|
||||
3. Velg JSON-filen
|
||||
4. Gi brukeren et navn eller en intern identifikator
|
||||
|
||||
Dataene lagres lokalt i veilederens nettleser. Arbeidspuls sender ikke rapportene til en sentral server.
|
||||
|
||||
### Gjennomgå rapporter
|
||||
|
||||
Veileder kan:
|
||||
|
||||
- se trendgraf for valgt bruker
|
||||
- filtrere på tidsperiode
|
||||
- åpne fullskjerm grafanalyse
|
||||
- lese rapportdetaljer
|
||||
- lese oppfølginger
|
||||
- se totalscore og kategoriscore
|
||||
- skrive generelt notat for bruker
|
||||
- skrive notat per rapport
|
||||
- skrive notat per oppfølging
|
||||
- eksportere/importere veilederbackup
|
||||
|
||||
### Score og funksjonsnivå
|
||||
|
||||
Arbeidspuls viser totalscore og kategoriscore som interne funksjonsindikatorer.
|
||||
|
||||
Score er ment for oversikt og trend, ikke som medisinsk fasit.
|
||||
|
||||
I veiledervisning brukes scoreband som:
|
||||
|
||||
- **Særdeles høyt funksjonsnivå**
|
||||
- **Forventet funksjonsnivå**
|
||||
- **Moderat redusert funksjon**
|
||||
- **Betydelig redusert funksjon**
|
||||
- **Svært lav funksjon**
|
||||
|
||||
75 % tilsvarer omtrent et forventet/godt rapportert funksjonsnivå, mens 100 % tilsvarer særdeles høyt funksjonsnivå.
|
||||
|
||||
### Integritetskontroll
|
||||
|
||||
Rapporter kan inneholde lokal integritetsmetadata. Dersom en rapport mangler verifisering eller ser ut til å være endret, vises et varsel i veiledervisningen.
|
||||
|
||||
Dette er en teknisk kontroll. Det er ikke en juridisk garanti og sier ikke noe om medisinsk sannhet i rapporten.
|
||||
|
||||
---
|
||||
|
||||
## Personvern og lokal lagring
|
||||
|
||||
Arbeidspuls lagrer data lokalt i nettleseren på enheten som brukes.
|
||||
|
||||
Det betyr:
|
||||
|
||||
- rapporter sendes ikke automatisk til en server
|
||||
- standardappen bruker ingen sentral database
|
||||
- data blir liggende på brukerens enhet/nettleser
|
||||
- sletting av nettleserdata kan slette rapportene
|
||||
- bytte av enhet eller nettleser krever eksport/import
|
||||
|
||||
Brukeren må selv eksportere JSON dersom data skal deles med veileder eller tas med til en annen enhet.
|
||||
|
||||
---
|
||||
|
||||
## Teknisk oversikt
|
||||
|
||||
Arbeidspuls er en statisk React/Vite-app med lokal nettleserlagring.
|
||||
|
||||
Typisk produksjonsbygg:
|
||||
|
||||
```bash
|
||||
npm ci
|
||||
npm run build
|
||||
```
|
||||
|
||||
Innholdet i `dist/` hostes deretter som statiske filer.
|
||||
|
||||
For en SPA bør webserveren ha fallback til `index.html`, for eksempel i Nginx:
|
||||
|
||||
```nginx
|
||||
location / {
|
||||
try_files $uri $uri/ /index.html;
|
||||
}
|
||||
```
|
||||
|
||||
### Teknologi
|
||||
|
||||
- React
|
||||
- TypeScript
|
||||
- Vite
|
||||
- PWA-manifest
|
||||
- service worker
|
||||
- lokal lagring i nettleser
|
||||
- JSON import/eksport
|
||||
- lokal veiledervisning
|
||||
- norsk/engelsk UI
|
||||
|
||||
### Produksjon
|
||||
|
||||
Arbeidspuls krever normalt bare statisk hosting. Det er ikke nødvendig å kjøre en Node-server i produksjon.
|
||||
|
||||
---
|
||||
|
||||
## Utvikling
|
||||
|
||||
Installer avhengigheter:
|
||||
|
||||
```bash
|
||||
npm ci
|
||||
```
|
||||
|
||||
Kjør utviklingsserver:
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
|
||||
Bygg produksjonsfiler:
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
Kjør tester:
|
||||
|
||||
```bash
|
||||
npm test
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Viktig presisering
|
||||
|
||||
Arbeidspuls er et hjelpemiddel for strukturert egenrapportering og gjennomgang. Tjenesten skal ikke brukes som eneste grunnlag for medisinske, juridiske eller arbeidsrettslige beslutninger.
|
||||
|
||||
Totalscore og kategoriscore er interne funksjonsindikatorer for oversikt og trend. De er ikke medisinsk validerte testresultater.
|
||||
|
||||
---
|
||||
|
||||
## Lisens
|
||||
|
||||
Se [`LICENSE`](LICENSE).
|
||||
Loading…
Reference in New Issue
Block a user