Tips til god stil

Her er nogle få tips til, hvordan man skriver en god wikiside.



1. Sidestrukturer


  • Begynd din side med en overskrift på første niveau med en meningsfuld titel.
  • Indlejr overskriftsniveauerne i den rigtige rækkefølge, sektioner på andet niveau bør starte med en overskrift på andet niveau.
  • Opdel din tekst i afsnit ved at efterlade en tom linje mellem dem. Et gennemsnitligt afsnit bør ikke være længere end 10-20 linjer.
  • Hvis din tekst er længere end nogle få (3-5) afsnit, bør du overveje at opdele den i sektioner ved at tilføje overskrifter på andet til femte niveau.
  • Når din tekst bliver længere end 2-3 skærmsider, skal du sætte et kort resumé af sidens indhold ind efter den første overskrift. Når din side bliver betydeligt længere, kan du overveje at dele den op i flere sider.
  • Hvis du har mange links til andre wikisider eller eksterne ressourcer, skal du tilføje et særligt afsnit med yderligere henvisninger (se nedenfor).
  • Hvis de fleste af siderne i et namespace har en fælles struktur, så tilføj en namespace-skabelon, så enhver ny side kan begynde med denne skeletstruktur.
  • Prøv at undgå overkomplicerede namespace-strukturer. Prøv at bruge korte, nemme at huske navnerumsnavne.

2. Tekstformatering


  • Fremhæv enkelte ord eller korte tekststykker ved at bruge fed eller kursiv. Vælg en af dem og hold dig til dit valg.
  • Vælg en stil til at repræsentere skærmoutput og tekst på skærmen, f.eks. knapper eller menuelabels, og brug den konsekvent. Det kan være en god idé at tilføje en side med en forklaring af dine stilkonventioner til din wiki.
  • Brug uordnede lister til udsagn, der er uafhængige af hinanden. Hvis du udvikler en tankegang, skal du skrive i en sammenhængende rækkefølge af sætninger.
  • Brug fodnoter sparsomt og kun til meget korte supplerende bemærkninger. Hvis der er meget mere at sige om et bestemt emne, så skriv det på en ny wikiside. Hvis du ønsker at henvise til andre (eksterne) informationskilder, skal du i stedet bruge links.
  • Tabeller kan i høj grad forbedre læsbarheden af strukturerede data. Hvis du indsætter en tabel, skal du sørge for, at den har meningsfulde celleoverskrifter og give en overskrift, der klart angiver tabellens indhold (f.eks. "Tabel 1.2: Gennemsnitlige afstande mellem planeterne").
  • Store tabeller har tendens til at være meget svære at redigere. Overvej i stedet at repræsentere dataene i en indlejret liste.

3. Sprog


  • Skriv ordentlige sætninger og brug artikler i stedet for navneord, når det er nødvendigt.
  • Begynd hver sætning med et stort bogstav og afslut den med et punktum eller anden passende tegnsætning.
  • Prøv at skrive korte, klare sætninger uden for meget brug af underordnede sætninger. Når du tror, at du er færdig med din side, skal du læse den igen og revidere enhver sætning, der har en alt for kompliceret struktur.
  • Beslut dig for, hvordan du skal henvende dig til dine læsere. Da Wiki er rettet mod at skrive dokumentation, vil du ofte være nødt til at instruere dine læsere, hvordan de skal gøre visse ting. Du kan bruge den imperative form ("Gør dette!"), vi/du-formen ("Så klikker vi/du på...") eller jeg-formen ("Jeg tilføjer derefter foo til bar ved hjælp af..."). Disse former må ikke blandes.
  • Kontroller din side for grammatiske eller stavefejl, inden du gemmer den. Hvis din tekst viser mange fejl, vil det mindske troværdigheden af dine udsagn, uanset hvor velgennemtænkte de end måtte være.
  • Udvikl din egen stil. Tving ikke dig selv til at skrive på en måde, du ikke er tryg ved. Det ville kun lyde unaturligt og være ubehageligt at læse.

4. Referencer


  • Når du støder på et begreb, der har brug for en nærmere forklaring, så tilføj en ny wikiside for begrebet og link til den.
  • Kontroller din side igen, før du er færdig, og tilføj links til eksisterende wikisider til de centrale termer på din side.
  • Tilføj ikke et link til hver forekomst af et specifikt begreb. Gør den første/mest fremtrædende forekomst på siden til et link og tilføj eventuelt et link til referenceafsnittet.
  • Angiv links til kilderne til billeder, data og citater.
  • Overvej at tilføje en "Se også:"-linje i slutningen af din side. Angiv links til wikisider, der er tæt relateret til emnet for din side der.
  • Hvis du ønsker at give henvisninger til eksterne ressourcer, der indeholder yderligere oplysninger om dit emne, eller som du har brugt ved udarbejdelsen af din side, skal du tilføje et afsnit med titlen "Referencer" eller "Yderligere oplysninger" til sidst og give en liste over links eller andre henvisninger (f.eks. ISBN-numre). Hvis du ikke allerede har gjort det i hovedteksten, skal du angive, hvad referencen er beregnet til.
  • Opsætning af interwiki-genveje kan hjælpe med at linke til fælles ressourcer.

5. Billeder og andre medier


  • "Et billede siger mere end tusind ord." Det betyder måske endda mere, end du havde tænkt dig at sige. 1) Mennesker har en tendens til at sætte mindre spørgsmålstegn ved billedernes autenticitet end ved sprogets. En kort tekstbeskrivelse er bedre end et unøjagtigt billede.
  • Som med tabeller skal du altid give en billedtekst til billeder, der angiver, hvad du ønsker at vise med billedet.
  • Hvis du ikke selv har skabt billedet, skal du angive kilden (eventuelt med et link) og ophavsretten.
  • Link ikke til billeder fra eksterne websteder, medmindre du udtrykkeligt har fået lov til det. Dette er først og fremmest et spørgsmål om ophavsret, men kan også være et spørgsmål om båndbreddestyring, når caching for eksterne billeder er deaktiveret.
  • Hvis billedet er større end ca. en tredjedel af en skærmside, skal du bruge et link med instruktioner om størrelsesændring for at indsætte et miniaturebillede.

Read comments (0 comments)