Bruk av Document360

Document360 er vårt hjelpesenter for hele plattformen.
Denne gjennomgangen tar for seg bruk og best practice for alle som skal jobbe i verktøyet.

Ansvarsområder

Hvem har ansvar for hjelpesenteret? Hvem lager nye artikler, og hvem oppdaterer eksisterende?

Innhold og struktur
I all hovedsak er support ansvarlig for hele hjelpesenteret, struktur og vedlikehold.

Opprette nye artikler
Det er ingen faste regler for hvem som oppretter en ny artikkel.
Om det en artikkel som mangler på en eksisterende tjeneste vil det være naturlig at support følger opp og legger til denne.

Om det er nye artikler på helt nye tjenester vil det være naturlig at prosjektleder, eller den med best kjennskap til tjenesten, oppretter den første artikkelen.

Oppdatering av artikler
Om man oppdager utdaterte artikler eller artikler med mangler skal dette meldes inn gjennom tilbakemelding på artikkelen, videre har support ansvar for å oppdatere eller sørge for at artikkelen blir oppdatert.

Markedsføringsartikler
Artikler som omhandler markedsføring (Google, Meta etc.) er det markedsføringsteamet selv som står ansvarlig for å holde oppdatert.

Teknisk
Teknisk vedlikehold, custom tilpasninger etc. utføres av PU.

Opprette artikkel

For å opprette ny artikkel må man først navigere til Documentation i sidemenyen:

Deretter klikker man på Create oppe til venstre. Gi deretter artikkelen et navn og velg plassering (kategori).

Man kan også opprette en artikkel direkte i en kategori ved å klikke på pluss-tegnet i sidemenyen.

Se Document360 egen hjelpeartikkel her.

Bruk av titler i artikler

Titler, eller “ Headings” brukes for å automatisk opprette innholdsfortegnelse, så samme måte som i Confluence, Word etc.

• Heading 1

  • Heading 2

• Heading 1

  • Heading 2

    • Heading 3

For å gjøre artikler mest mulig oversiktlig er det viktig å være påpasselig med bruk av titler. Ha også i bakhodet at innholdsfortegnelsen er relativt smal, så titler burde ikke være for lange.

Skjule innholdsfortegnelse

Om artikkelen er kort, inneholder få titler eller av andre grunner ikke trenger innholdsfortegnelse kan denne deaktiveres pr. artikkel.

Klikk på “ Article settings” (tannhjul oppe til høyre), Velg “ Preferences” og slå deretter av “Show table of contents”.

Som standard er innholdsfortegnelse aktiv på alle artikler

Redigere artikkel

1. Finn artikkelen du ønsker å redigere

   1. Naviger til “Documentation” i venstremenyen og bla i kategoriene

   2. Bruk søket oppe til høyre

2. Trykk Edit i høyre hjørne

   1. Dette lager en “fork” av artikkelen, altså en ny versjon. Man kan når som helst forkaste denne og gå tilbake til opprinnelig artikkel

3. Gjør ønskede endringer (disse lagres automatisk forløpende)

4. Når du er ferdig å redigere kan artikkelen publiseres ved å trykke på Publish oppe til høyre. (Krever at din bruker har rettigheter for å publisere artikler)

Viktig ang. språk!

Endringer som gjøres på et språk vil ikke oppdatere de andre språkene. Man må selv sørge for å gjøre de nødvendig endringene på andre språk.

Slette artikler

• Sletting av artikler er forbeholdt admins.

• Om man sletter en artikkel vil den ligge i “Recycle bin” i 30 dager før den slettes for godt.

• Sletter man artikkel på et språk vel det også slette samme artikler på andre språk.

  • F.eks: du velger å slette Artikkel A med svensk språk, da vil også samme artikkel på norsk og engelsk bli slettet.

Språk

Når man oppretter en ny artikkel vil det automatisk opprettes en tom artikkel på de andre aktive språkene.

Disse kobles automatisk sammen basert på unike ID-er, som betyr at man kan endre navn, URL og innhold uten at det påvirker sammenkoblingen.

Innholdet i artikkelen vil ikke overføres til de andre språkene, dette må gjøres manuelt.

Høydepunkter

• Artikler opprettes automatisk på de andre språkene, disse er tomme og må manuelt oppdateres

• Artiklene linkes sammen med unike ID-er som ikke kan endres

• Èn artikkel kan ha unikt innhold (tekst, bilder, video) pr. språk

Rutiner for oversetting

Når du har opprettet en artikkel på ditt hovedspråk, f.eks norsk, må også de andre språkene legges inn.
Dette må gjøres manuelt og erfaring tilsier at følgende flyt er enklest:

1. Kopier alt innhold fra artikkelen du nettopp opprettet

2. Bytt til språket du vil oversette til

3. Lim inn innholdet fra den originale artikkelen

4. Trykk på “Needs translation”

   

5. Velg “Mark as translated” eller “Machine translate”

   1. Mark as translated brukes om man manuelt har oversatt artikkelen.

   2. Machine translate bruker AI for å oversette teksten fra språket du limte inn til valgt språk. Dette bruker credits, som igjen må kjøpes. Brukes med omhu.

      

6. Når oversettingen er utført kan man publisere artikkelen på vanlig vis.

Husk!

Husk å endre navn og slug (URL) for å passe språket. Språkene kobles basert på ID slik at navn og slug kan endres akkurat slik man måtte ønske.

Oversette endringer

Om man gjør endringer i en artikkel, f.eks skriver om eller legger til seksjoner, vil ikke dette automatisk oppdateres på de andre språkene.
Det er derfor viktig at man gir beskjed til personen ansvarlig for de andre språkene slik at den/de kan ta en vurdering på om endringen også gjelder der.

Tilbakemelding - rutiner

Når en artikkel har behov for oppdatering eller forbedring er det viktig at alle, også intern, benytter seg av tilbakemelding-funksjonen inne på en artikkel.

Gi tilbakemelding

I bunnen av hver artikkel kan man gi tilbakemelding i form av tommel opp/ned.

Om artikkelen har utdatert, feil eller mangelfull info kan man her klikke tommel ned for så å fylle ut nøyaktig hva som mangler.

Etter nødvendig beskrivelse er lagt til sendes tilbakemeldingen inn.
Dette vil gi et varsel i Slack-kanalen #knowledgebase-feedback, i tillegg til at den vil ligge i Document360 sitt eget tilbakemeldingssystem.

Oversikt over tilbakemelding

Document360 har et eget system for å håndtere tilbakemelding.

I venstremenyen:

• Naviger til “Content tools” (verktøy-ikon)

• Gå videre til “Feedback Manager”

Her finner man under fanen “Article Feedback” alle tilbakemeldings som er sendt inn.
Ved å bruke filteret i høyre hjørne kan man filtrere seg fram til tilbakemeldinger basert på status, hvem de er satt til osv.

Oppdatering basert på tilbakemelding

Når en artikkel er oppdatert basert på tilbakemelding skal den i Document360 settes til CLOSED.
Samme artikkel markeres i Slack med ✅ slik at andre brukere vet at den er oppdatert.