English

VIA University College

Udarbejd eller rediger en it-vejledning

Opdateret

Denne vejledning retter sig mod redaktører og indholdsleverandører og klæder dig på til at udarbejde "den gode it-vejledning" ved hjælp af ScreenSteps. Vejledningen introducerer både VIAs standarder for udarbejdelse af it-vejledninger og henviser til forskellige ressourcer, der hjælper dig til at benytte ScreenSteps. Denne vejledning kommer ind på følgende:

Hvis du har spørgsmål til udarbejdelse af vejledninger, som du ikke kan finde svar på her, kan du gå til ScreenSteps ressourcesamling her.

Opret en ny vejledning

  1. Start med at åbne ScreenSteps desktop editor.
    • Vi anbefaler, at du anvender ScreenSteps desktop editor til at udarbejde vejledninger, men det er også muligt at gøre i webapplikationen. Der er dog nogle funktioner, der ikke er tilgængelige i webapplikationen. Hvis du ikke allerede har downloadet ScreenSteps desktop editor kan du downloade editoren her. Du kan også finde yderligere vejledning til brugen af editoren i vejledningen Introduktion til ScreenSteps her.
  2. Vælg Create Article.
  1. Et popup vindue åbner nu, hvor du skal:
    1. Skrive navnet på vejledningen
    2. Vælge vejledningstype. Vælg altid Article
    3. Vælg sitet (vejledningsbiblioteket), hvor din vejledning skal placeres.
      • Vælg VIA University College til danske vejledninger og VIA University College (UK) til engelske vejledninger. 
    4. Vælg vejledningsskabelonen IT-vejledningsskabelon.
    5. Vælg manual, hvor din vejledning skal placeres.
      • Manualer fungerer som målgrupper, så her skal du vælge, hvilken "målgruppe", din vejledning henvender sig til. Hvis din vejledning henvender sig til flere målgrupper, vælger du blot én af dem, og så skal du efterfølgende "referere" vejledningen i andre målgrupper. Læs mere om referering af vejledninger her.
    6. Vælg chapter, hvor din vejledning skal placeres.
      • Chapter fungerer som undermapper til din(e) vejledning(er) og beskriver de kategorier, der findes vejledninger om.
    7. Vælg Create.

Fortrolige oplysninger i vejledninger

Alle typer af fortrolige oplysninger såsom licensnøgler og loginoplysninger (brugernavn og/ eller adgangskode) må ikke placeres i en vejledning. I stedet skal den slags oplysninger placeres i et dokument på det tidligere vejledningsbibliotek på Studienet (se dokument for studerende og medarbjedere her og kun for medarbejdere her), som du kan linke til direkte fra en vejledning. Kontakt viaservice@via.dk for at få indsat fortrolige oplysninger i et af dokumenterne på Studienet.

Opbygning og strukturering af indhold

Hvis du skriver it-vejledninger for IT og digitalisering, er der udarbejdet en række principper, der bør overholdes. Du kan læse principperne her.

Indholdstyper

Når du udarbejder vejledninger i ScreenSteps desktop editor kan du "trække og slippe" forskellige typer af indholdselementer fra venstreside-panelet.

Overskrifttyper: Der findes to forskellige typer af overskrifter, som er stylet på forskellige måder (se billedet nedenfor). Disse er følgende:

  • None: Almindelig overskrift.
  • Foldbar overskrift (foldable section). Anvendes til at skjule det teksttunge i en vejledningen, således vejledningen fremstår mere overskuelig. En bruger skal ikke læse mere, end de har brug for. Eksempelvis kan det anveved at have en foldbar sektion til Mac-vejledning og en foldbar sektion til Windows-vejledning. På denne måde kan en bruger folde det element ud, der er anvendeligt for netop denne bruger.

Afsnitstyper: Der findes forskellige typer af afsnit, der er stylet på forhånd (se billedet nedenfor). Det er ikke alle, der må anvendes. Følgende præsenteres elementtypernr:

  • None: Almindeligt afsnit element, der anvendes til almindelig brødtekst.
  • Introduction: Introduktionselement, der udelukkende anvendes som det første afsnit i hver vejledning, hvori målgruppe samt formålet med vejledningen beskrives.
  • Info: Må ikke anvendes. Alt i vejledningerne er information.
  • Alert: Må ikke anvendes. Det er for svært for redaktører at skelne mellem Alert og Warning, hvorfor kun Warning-elementtypen må bruges.
  • Warning: Advarselselement, der anvendet til at skabe opmæksomhed omkring noget, brugeren skal være opmærksom på. Eksempelvis OBS. eller NB punkter.
  • Tip: Tip element, der anvendes til at give brugere forskellige tips og tricks.

 

Ændr overskrift- eller afsnittype

Efter du har indsat et overskrifts- eller afsnitselement skal du vælge content inspector i højreside-panelet og for afsnit vælge Style og for overskrift afkrydse Foldable section.

Strukturering

I venstrepanelet kan du se strukturen på elementerne i din vejledning og hvordan de forskellige elementer hænger sammen. Eksempelvis overskrifthierarkiet. Hvis du vil flytte rundt på sektioner (afsnit, overskrifter (inkl. elementer herunder) og billeder mm), kan du nemt gøre det i sidebaren til venstre ved at trække elementerne rundt.

Det er t vigtigt at strukturere overskrifter, underoverskrifter og afsnit rigtigt for at vejledningen har den rigtige struktur og læserækkefølge. Du kan ved de små linjer, der illustrerer sammenhænge se, hvilke overskrifter, der indeholder, hvilke afsnit og underoverskrifter.

Formatteringsmuligheder for tekst

  1. Fed
  2. Kursiv
  3. Understregning
  4. Skriftfarve
  5. Skrift baggrundsfarve
  6. Kodekørsel - bruges til at formatere de valgte ord som kodeuddrag (f.eks. HTML eller Javascript).
  7. Sænket skrift
  8. Hævet skrift
  9. Afsnitsstil - Normal, Kode eller Spørg. Kodestilen bruges til at formatere hele afsnit som kodeuddrag (f.eks. HTML eller Javascript). Prompt bruges til at fortælle nogen, at de skal tale teksten i afsnittet.
  10. Numerisk liste
  11. Punktliste
  12. Forøg indrykning - Hvis tekstlinjen er en del af en liste, indrykker dette linjen for at lave en indlejret liste. Hvis linjen ikke er en del af en liste, er første linje i afsnittet indrykket.
  13. Formindsk indrykning - Hvis linjen er en del af en liste, overskrider dette listeelementet. Hvis linjen ikke er en del af en liste, formindskes indrykningen af første linje i afsnittet.
  14. Links - Links til vejledninger eller overskrifter i din vidensbase, til steder i den aktuelle vejledning eller til eksterne websteder
  15. Ryd formatering - Fjerner al formatering fra den markerede tekst. Du kan bruge denne knap til at fjerne links.

Ændr værdien i listeopstilling med tal eller bogstaver

For at ændre det nummer eller bogstav, som din liste starter med skal du gøre følgende:

  1. Vælg Format i topmenuen
  2. Vælg List
  3. Vælg Start Ordered List At...
  4. Skriv det tal, du ønsker at starte listen med og vælg OK

Formatteringsmuligheder for billeder

Når du anvender billeder, hvor man kan se ansigter på folk, loginoplysninger, mailadresse eller brugernavn skal du sløre dette, så det ikke er synligt, hvem, der fremgår på billeder eller har taget billederne.

  1. Markør - Vælg. Vælg indsat element på billedet.
  2. Vælg billede markør. Vælg billede for bl.a. at gøre det større eller mindre.
  3. Indsæt pil eller linje.
  4. Indsæt rektangel.
  5. Indsæt cirkel.
  6. Highlight område.
  7. Indsæt nummereringssekvens.
  8. Indsæt tekst.
  9. Slør område.

Elementer indsættes på billeder ved at du vælger det element, du ønsker i menuen (vist på billedet ovenfor) og klikker og trække markøren over det område, du ønsker elementet indsat.

Udarbejd ny it-vejledning

Når du indsætter annotationer er det vigtigt, at du bruger den prædefinerede skabelon IT-skabelon primær. Dette sikrer et mere ensrettet udtryk gennem alle vejledninger i vejledningsbiblioteket.

Udarbejd ny it-vejledning

Beskær billede

For at beskære et billede skal du gøre følgende:

  1. Vælg Edit i topmenuen
  2. Vælg Crop Image
  3. Vælg det område, du ønsker skal udgøre billedet
  4. Tryk Enter eller dobbeltklik på området
Udarbejd ny it-vejledning

For flere vejledninger til billeder kan du tilgå ScreenSteps ressourcesamlinger om at arbejde med billeder her og om billederedigering og annotationer her.


Gem din vejledning

Når du er færdig med at udardbejde eller redigere en vejledning, skal du vælge mellem at gemme som kladde eller at offentliggøre vejledningen.

Overvej, om det er relevant at tilføje en note om de ændringer, du har foretaget. Det kan fx være relevant hvis du ændrer i en vejledning, som en anden redaktør er ejer af. Du kan læse, hvordan man opretter noter her.

Når du gemmer, har du mulighed for at vælge hvem, der er ejer af artiklen, og du kan give artiklen en:

  1. Beskrivelse: Det kan være en god ide at indsætte en beskrivelse af de ændringer, man har foretaget, hvis man har revideret en eksisterende vejledning. Det er muligt at emaile beskrivelsen til andre redaktører og administrative brugere.
  2. Ejer: Ejeren er den redaktør, der ved mest om vejledningens indhold, og vil oftest være den, der har udarbejdet eller publiceret vejledningen. Der skal tildeles en ejer, så andre redaktører ved, hvem de skal henvende sig til med spørgsmål, kommentarer eller ændringer til en vejledning.
  3. Status. En status kan tydeliggøre, hvor i processen, artiklen befinder sig.

Referer, dupliker eller flyt en vejledning

Hvis du gerne vil flytte en vejledning til en anden manual (målgruppe), oprette en kopi af en vejledning eller skabe en reference, der henviser til en vejledning i en anden manual, skal du følge disse instruktioner.

  1. Under TOC/Manuals. gå til det kapitel (kategori), hvori du ønsker at placere en allerede oprettet vejledningen.
  2. Vælg Chapter Actions
  3. Vælg Add Existing Article
  1. Vælg site, derefter manual, derefter kapitel, og vælg til sidst handling (reference, duplicate eller move) ved siden af den eller de artikler, du vil tilføje.
    • Reference: Vejledningen vil forblive i det originale kapitel, og der vil blive tilføjet en reference til det aktuelle kapitel. Opdatering af artiklen opdaterer dens indhold i begge kapitler.
    • Duplicate: Den originale vejledning forbliver i det originale kapitel. En kopi af vejledningen tilføjes til det aktuelle kapitel. Redigering af artiklen i det ene kapitel ændrer ikke dubletten i det andet kapitel.
    • Move: Vejledningen vil blive fjernet fra det originale kapitel og tilføjet til det aktuelle kapitel.
  2. Vælg Done

Brug af ekstra søgetermer til at forbedre søgning

Søgefunktionen i vejledningsbiblioteket fungerer sådan, at der kun søges på det, som brugeren har indtastet i søgefeltet. Dvs. der ikke søges på lignende ord, hvilket er et problem, hvis der er stavefejl i det, der søges på.

Nogle brugere vil derfor kunne opleve, at de ikke kan finde en given vejledning, hvis de søger på noget bestemt. Eksempelvis hvis en bruger skal fremsøge en vejledning om at forbinde til VIA netværk kunne finde på at søge på "trådløs netværk", "trådsløst netværk", "wifi" eller måske "Wi-Fi". For at finde vejledningen skal brugeren søge på netop den term og stavemåde, der er anvendt i vejledningen. For at løse denne problemstilling kan ekstra søgetermer anvendes.

Tilføj derfor ekstra søgetermer, når det giver mening. Eksempelvis, når ord kan staves på flere måder, eller der bruges forskellige ord til at referere til den samme ting.

Tilføj ekstra søgetermer:

  1. Vælg Article Inspector.
  2. Skriv ekstra søgetermer under Additional Search Terms.
  3. Vælg Save Meta Properties.
Forrige Vejledning Introduktion til ScreenSteps og administrationsmodulet
Næste Vejledning IT-vejledningsskabelon