Samsyn:Stilguide

Version från den 24 september 2018 kl. 10.08 av Sara Mörtsell (WMSE) (diskussion | bidrag) (→‎Referenser: exempel tidskriftref)



Den här stilguiden anger riktlinjer om vad som är lämplig stil för både språk och form för samverkansbegreppens beskrivningar på denna wiki. Stilguiden fungerar som en beskrivning över vad målet är med en begreppssida och fylls på successivt under projektets gång för att dokumentera det som projektet Samsyn kommer underfund med. Som ett stöd för att planera, skriva och ge återkoppling om samverkansbegrepp i wikin finns också en checklista som utgår från vad som finns i denna stilguide.

Sidan tar också upp hur man kan markera olika åtgärdsbehov och “vad som finns kvar att göra” för att en begreppssida ska bli så komplett som möjligt.

Avgränsning

Samsyns wiki samlar begrepp som berör universitets och högskolors samverkan. Om ett begrepp går att beskriva utifrån denna riktlinje så hör det hemma i wikin. Vissa begrepp är gränsfall, då kan det behöva lyftas för en diskussion med andra i projektet för att reda ut om det ska ingå eller ej. Universitets och högskolors samverkan som tydligt tema kan också verka som vägledande för hur lång en sida kan bli, eller vad som bör ingå i begreppets beskrivning och inte. Här kan det vara till hjälp att sträva efter att "hålla sig till ämnet". När ett stycke eller detalj kan sägas vara alltför löst kopplat till det övergripande temat, kan det finnas anledning att stryka det från att ingå i wikin.

Om sidans innehållsförteckning

Wikins mjukvara genererar automatiskt en innehållsförteckning när sidan har minst fyra rubriker. Se exempelvis innehållsförteckningen på denna sida.

Dispositionen

 
Exempel på hur en begreppssida kan se ut med definitionen i inledningen och sedan de andra delarna under respektive rubrik (klicka för förstoring).

Varje samverkansbegrepp ska på sin beskrivningssida ha följande rubriker eller stycken.

Begreppet

Begreppet utgör själva titeln på sidan och bör vara i verbets infinitiv eller om substantiv i obestämd form. Om sidans titel innehåller ett fel går det att ändra genom att flytta sidan.

Definition (inledning)

Begreppssidans inledande stycke innehåller begreppets kortare och mer allmängiltiga definition. Detta stycke har ingen rubrik eftersom det är sidans titel - själva begreppet utgör rubriken och inleder hela texten. Inledningen är det stycke text som föregår innehållsförteckningen. Inledningen bör vara kort och koncis och samtidigt ge det nödvändiga sammanhanget.

Exempel: “Utadjungering inom universitets- och högskolesektorn är när en lärare eller forskare från ett universitet eller högskola under en begränsad period och på deltid arbetar eller på annat sätt närvarar hos en arbetsgivare utanför akademin.”

Tillämpningar

Efter den inledande definitionen lägger vi in rubriken "Tillämpningar". I det stycket skriver vi in en mer utförlig beskrivning av hur begreppet används, inom olika delar av högskolans verksamheter eller av våra samverkansparter. Vi kan ta upp avgränsningar mot närliggande begrepp inom samverkan, även motsatta begrepp kan tas upp. Exempel kan användas för tydlighet om det behövs. Har begreppet genomgått någon känd förändring eller har en känd uppkomst är det också relevant i detta avsnitt.

Motsvarighet i engelskan

Ange den engelska motsvarigheten. Skriv först in rubriken "Engelska motsvarighet". Skriv det engelska ordet i kursiv för att göra texten läsvänlig. Vi använder den brittiska engelskan med tanke på vårt EU-sammanhang och ESG-standard.

Exempel: Utadjungering motsvarar engelskans Adjunct eller affiliated professor (eller teacher, researcher och så vidare).

Referenser

De referenser som har fotnoter i texten listas automatiskt under denna rubrik som en referenslista. Vi försöker att undvika fotnoter i texternas inledande definition för att i stället placera dem i avsnittet under rubriken tillämpningar. Via "Ange källa" finns tre olika referensmallar som kan användas beroende på vad källan är, dessa är "webbref", "bokref" eller "tidskriftref".

Webbref: Exempel på källhänvisning för webref [1]
Tidskriftref: Exempel på källhänvisning för tidskrift: [2]

  1. ”Högskolelag (1992:1434)”. Sveriges riksdag. https://www.riksdagen.se/sv/dokument-lagar/dokument/svensk-forfattningssamling/hogskolelag-19921434_sfs-1992-1434. Läst 14 september 2018. 
  2. Författarens namn (2018). ”Artikelns rubrik”. Tidskriftens namn (Utgivaren). 

Dessutom är detta platsen för att lista övriga referenser som texten bygger på, även om de inte hänvisas till med fotnot. När källorna listas använder Samsyns wiki systemet:

  • Efternamn, Förnamn (årtal) Publikationens titel (länkad med extern länk).

Exempel på litteraturlista med källhänvisningarna:

instruktionssidan finns instruktionerna för att lägga till

Textursprung

När texter kopieras, helt eller delvis, ska det anges med mallen Textursprung.

Externa länkar

Denna rubrik kommer eventuellt inte användas särskilt flitigt då varje begreppssida istället har en lista med den litteratur och publikationer som ligger till grund för innehållet (se ovan). Under den här rubriken kan externa länkar till resursmaterial som anknyter till begreppen, men som inte passar som källhänvisning i själva löptexten punktlisas.

Språkliga riktlinjer

Begreppssidans innehåll ska kunna förstås av någon som inte vardagligen rör sig inom högskolesektorn. Därför är det bra att:

  • skriva ut förkortningar (Universitetskanslersämbetet och inte UKÄ, högskolepoäng och inte hp)
  • förklara det som internt i utbildningssektorn uppfattas som självklart (skillnad på kurs och program, rektors ansvar vid ett universitet ansvar jämfört med inom grundskolan)
  • använda ett vanligt språkbruk, undvik helst högtravat eller alltför akademiska formuleringar

Att ange åtgärdsbehov

Det är sällan en lätt uppgift att åstadkomma en komplett begreppsbeskrivning på första försöket. Det är mycket enklare att successivt arbeta fram beskrivningens olika delar och växelvis gå från att granska texten till att lägga till mer innehåll. Och att låta den uppgiften cirkulera bland flera ögonpar.

För att markera var olika behov finns för ett begrepp så går det att markera detta genom lägga in en mall om att åtgärd behövs.

Exempel
"Samverkan är det viktigaste som finns."[Åtgärd behövs]
(Rör muspekaren över länkarna för att få förklaring om vilken åtgärd som behövs.)

Sådana markeringar underlättar för andra att se vilka hål som finns att fylla, och det grupperar också olika begrepp som har åtgärdsbehov vilket underlättar arbetet och arbetsfördelningen. Markeringarna ska ses som minneshjälp över “vad som är kvar att göra”.

Exempel på åtgärder kan vara följande:

  • Behöver referenser
  • Behöver engelsk översättning
  • Behöver språkkorrektur
  • Behöver länkar

Att en projektdeltagare anser att det finns ett behov och markerar det betyder inte att det är samma person som ansvarar för åtgärden. Markeringarna ska vara ett sätt att samarbeta och underlätta det iterativa arbetssättet i samsynwikin.

Alla begrepp som är markerade för något av de här åtgärdsbehoven kan samlas upp.

Instruktioner för att ange "Åtgärd behövs"


Sida Mall:Navbox/styles.css måste ha en innehållsmodell "Sanerad CSS" för TemplateStyles (nuvarande modell är "wikitext").