Vil du skrive en guide?

Jeg modtager gerne udkast til guides. Denne side beskriver, hvordan du laver et godt udkast. Webmaster og skribent har det sidste ord at skulle have sagt. Det skyldes hensynet til en ensartet kvalitet og et ensartet farvevalg i de mange guides på siden.

Skriv kun om programmer/emner, du har indgående kendskab til, da du ellers ikke kan skrive om de væsentligste emner og faldgruber, brugerne kan opleve.

Kom godt i gang

Det allervigtigste er, at du gør dig klart, at du skriver for alle mennesker. Nørderne klarer såmænd sig selv.

Denne vejledning er “diktatorisk”; det skyldes, at jeg ønsker, at de mange guides har en ensartet kvalitet og grafisk udtryk.

Det er lidt af en kunst at skrive læsbare tekster på nettet, fordi vi læser helt anderledes på skærmen end i fx en bog eller en avis. Det vil sige, at man skal tænke meget over læsbarheden.

Niels Gamborg har beskæftiget sig meget med læsevenlige tekster på nettet. Det er altid hans råd, jeg følger. Her er en lærerig artikel, som du bør læse, inden du går i gang med din første guide.

En anden forfatter, der er god at kende til, når man skriver til nettet, er Jakob Nielsen. Her er en liste med hans arbejde med “usability”, som vel nærmest kan oversættes til “brugervenlighed” – desværre er listen kun på engelsk.

Når du afleverer din guide til mig, forbeholder jeg mig retten til at rette stavefejl, kommafejl, dele op i flere afsnit, reducere antallet af illustrationer mv. – alt sammen af hensyn til kvalitet, overskuelighed og læsbarhed. Der er ikke noget så distraherende som tekster fyldt med fejl.

Starten på guiden

Afsnit 1: Start altid med at beskrive hvad programmet kan, og hvorfor det er en god idé at anskaffe det – eller sagt på en anden måde ”Hvad er formålet”?

Afsnit 2: Skal man betale for programmet, eller er det gratis? Hvis det skal købes, skal du angive prisen og hvilket år, den er fundet.

Afsnit 3: skal være en henvisning til, hvor programmet kan hentes. Herunder er en liste over sider, du gerne må henvise til.

Hent altid fra producenten eller ovenstående, hvis det er muligt. Hvis producenten selv linker til andre sider, må det formodes, at linket er i orden.

Klik aldrig på “reklamer”. Undersøg siden du henter fra; i mange tilfælde “gemmer” linket sig lidt nede på siden. Det bør i givet fald fremgå af guiden

Vær opmærksom på “ekstra” – og som oftest unødvendig – software, når du installerer et program. Læs hvad der står på skærmbilledet og fjern eventuelle flueben, der er sat på forhånd.

Er du i tvivl, så lad være med at hente/installere; spørg i stedet i gruppen, om der findes sikre alternativer.

Afsnit 4: Beskrivelse af installationsprocessen. Hvor gemmer man den hentede fil? Hvad hedder filen? Hvad sker der, når man dobbeltklikker? Er det så bare næste, næste, næste? Hvis ikke hvad så? Er der særlige knapper, der skal trykkes på?

Når programmet kører
  1. Hvordan ser første skærmbillede ud? Evt. med illustration.
  2. Hvad gør man for at komme i gang med programmet?
  3. Er der evt. særligt vigtige punkter af være opmærksom på?
  4. Har du tips som ikke fremgår af menuerne?
  5. Og meget mere som din erfaring med programmet siger dig.
Formater og illustrationer mv.

Jeg skal have dit bidrag i Word, Libre Office eller hvad du nu bruger som tekstbehandlingsprogram, og illustrationer skal være indlejrede, så jeg kan se, hvor i teksten du vil have dem. Jeg vil ikke have pdf-filer.

Samtidig vil jeg gerne have billedfilerne i naturlig størrelse tilsendt på mail: https://supportpcogandet.dk/kontaktwebmaster/. Når jeg gerne vil have filerne særskilt, skyldes det, at de ofte bliver for små, når de er indlejrede, og det dur ikke. Hvis der skal være illustrationer, skal de også kunne ses. Hvis du har mulighed for at sætte pæne pile, der peger på vigtige elementer, er det godt, og ellers så sætter jeg dem på med ”Snagit”.

Du skal ikke levere ti illustrationer med mindre, der er tale om et billedbehandlingsprogram, da det bliver uoverskueligt for læserne (og mig). To – tre stykker, der er essentielle, er fint. Det er teksten, der skal være det bærende.

Farver

Hvis du laver skærmdump, pile, kasser, figurer mv., skal du i videst mulige omfang bruge følgende farver for at titellinjerne får den rigtige terrakottafarve:

  • Terrakotta: HEX: #c3512f  som svarer til RGB: 195,81,47
  • Grå: HEX: ##f8f8f8 som svarer til RGB: 248,248,248
  • På din PC skal du indstille farven, så den også bliver terrakotta. Du gør det således:
    • Højreklik på skrivebordet.
    • Vælg personlige indstillinger
    • Vælg farver
    • Brugerdefineret farve: #c3512f
    • Sæt mærke i “Start, proceslinje og handlingscenter”
    • Sæt mærke i “Titellinjer”.
  • Hvis du ikke bruger de rigtige farver, retter jeg dem, så siden vedbliver at have et ensartet design, idet der er lagt et stort arbejde i at skabe et ensartet “look and feel” på siden og på tværs af alle guides. Dette skal bevares!

 

Sprog

Du skal skrive direkte til brugerne; derfor skal der fx stå “Du henter…”, “Du installerer…” osv.

Du skal stave rigtigt og sætte både punktummer og kommaer. Herudover skal afsnittene ikke være for lange. Det skyldes alt sammen hensynet til læsbarheden. Retter du ikke disse ting til, gør jeg det.

Du skal ikke bruge kancellisprog.

Du skal ikke bruge forkortelser men skrive ordene helt ud lige bortset fra selvfølgelig: fx, mm., mv., osv. og den slags.

Guiden skal være på dansk: ikke på “pseudoengelsk”. Det vil sige ikke ”Clean install” men ”ren installation”, ikke ”Download” men ”Hent”, ikke ”Install” men ”installere”, ikke ”site” men ”side”, ikke “admin” men “administrator”, ikke “add on” men “tilføjelse”, ikke “detektere” men “spore”, ikke “double click” men “dobbeltklik”, ikke “ISP” men “udbyder” osv.

Ingen smileys: Dine ord skal kunne forklare dit budskab i sig selv. Smileys reducerer tekstens seriøsitet.

Skriv ”stramt” uden overflødige ord.

Slang: Vi ”smider” ikke ting på nettet. Vi lægger. ”Smider” er slang, og det er ikke godt og virker useriøst.

Talord til og med ti skrives med bogstaver, altså tre, fire, fem osv. 11 og derover skrives med tal. Tusindtalsseparator er punktum fx 1.000.

Hvis programmet hedder fx ”uBlock”, skal du skrive det på helt samme måde og være konsekvent hele vejen igennem.

Kategorisering

Du skal tage stilling til under hvilket menupunkt/hvilken knap, din guide skal høre til, og hvis der er undermenuer, skal du også tage stilling til, hvilken, der er den rigtige.

Proces
  1. Du sender dit udkast. Husk at vedlægge billederne og husk, at jeg ikke kan bruge PDF-filer.
  2. Jeg kigger det igennem og sætter det op på en side.
  3. Jeg sender dig et link til siden, og du ser det igennem, og erklærer det for OK eller kommer med forslag til ændringer. Siden er på dette tidspunkt “hemmelig”, da den er ikke er knyttet til menuerne.
  4. Typisk har du glemt at tage stilling til kategorisering.
  5. Hvis ovenstående stillingtagen mangler, kommer jeg med et forslag, som du skal godkende.
  6. Når jeg har svar fra dig, sætter jeg oplysningerne på, og linker siden til menuerne.
  7. Jeg annoncerer den nye guide i Facebookgruppen med startordene: “Ny guide: Fornavn, Efternavn har bidraget med en guide om: xxx. Den kan findes i menuen xxx, eller du kan klikke herunder.
  8. Guiden promoveres også nederst på siden under overskriften “Nye og ændrede guides”
Afslutning og kontakt

Er du i tvivl om noget, svarer jeg altid gerne på spørgsmål. Du finder mig her:


Hanne B. Stegemüller, webmaster og skribent. 1. maj 2018