Instruktioner för att skriva snabbguider till analysprogram

Instruktioner för att skriva snabbguider till analysprogram

Snabbguiderna är avsedda att ge en kort introduktion till diverse verktyg som på ett eller annat sätt kan användas i vetenskapliga analyser. Det kan röra sig om tunga, väletablerade system som NVivo eller enkla webbresurser som Voyant Tools (ett vanligt verktyg som används som introduktion till digital humaniora). Syftet är att ge en orientering (för DAU-personal eller forskare), inte en fullständig genomgång av allt som ett program kan göra. Därför bör guiderna hållas korta (2 sidor i Times New Roman 11 punkter är ett riktmärke).

Snabbguiderna ska bestå av:

1. en kortfattad beskrivning av programmet: vilken typ av forskning det användas till (ofta är detta bredare än vad programmets skapare avser; tänk brett), vilken övergripande funktionalitet har det, vilka olika licenser som finns och vad som skiljer dem åt, vilka datatyper är det lämpat för och vad kan man göra med dessa
2. en lathund som, förutom en kommentar om vilken version som beskrivs, innehåller tre rubriker:
   • Dokumentationsmöjligheter: här tar man upp vilka möjligheter programmet erbjuder för att dokumentera sina beslut, koder eller annat på objektnivå. Viktigt att nämna är också i vilken mån det går att exportera dokumentationen. Ofta är dessa funktioner avsedda för annat men kan användas till dokumentation – viss fantasi kan krävas.
   • Filtyper som stöds: vilka filformat kan importeras i programmet och vilka kan exporteras ur det. Om programmet har egna filformat så är det viktigt att undersöka om de egentligen är vanliga format som skulle kunna användas till att återskapa/utvinna information. (Som t.ex. att Elans .EAF-format är ett .XML-format ur vilket information kan utvinnas med viss ansträngning.)
   • Att öppna och spara en fil: kort information om hur man utför de mest grundläggande handlingarna i programmet, så att det går att komma igång och att man inte riskerar att förlora sitt arbete.

Tanken är att samlingen med snabbguider ska växa så att man snabbt kan skaffa sig en uppfattning om ett program om man skulle konfronteras med ett man inte känner till, upplysa forskare om möjligheter att dokumentera i deras valda analysprogram, eller kanske hitta tips om en forskare behöver hjälp.