Skriv en programmanual

Bemærkninger

Manualer vil blive inkluderet som undersider af programmets hovedside. For nemheds skyld vil jeg omtale hovedsiden som Prognavn. Strukturen bliver så noget i retning af:

• Prognavn
  • Prognavn/Vink og tips
• Prognavn/Manual # Indholdsfortegnelse
  • Prognavn/Manual/En introduktion til Prognavn
  • Prognavn/Manual/Konfigurationsmuligheder** Prognavn/Manual/Første gang du bruger Prognavn
  • Prognavn/Manual/afsnit 1
  • Prognavn/Manual/afsnit xxx
  • Prognavn/Manual/Vink og tips
  • Prognavn/Manual/Fejlløsning
  • Prognavn/Manual/Programfejl
  • Prognavn/Manual/Involver dig #link til techbase etc

Husk!

Undgå enhver brug sætningstegn i sidenavne — sætningstegn som spørgsmålstegn og punktummer giver alvorlige problemer for wikisoftwaren, ikke mindst for oversættelsessystemet.

Du vil få brug for en testområde til at eksperimentere med afsnitoverskrifter og sider. Du kan enten bruge din personlige UserBase-side eller diskussionssiden knyttet til det område, hvor du arbejder. Det er en stor hjælp, hvis du fjerner alt, hvad du ikke længere skal bruge, når du er færdig med det.

Indhold

• Når du har lavet din plan (det kan være en langvarig proces), så lav links til alle de sider, du vil skrive i indholdsfortegnelsen. Du kan selvfølgelig altid indsætte et afsnit senere, hvis du opdager, at du har glemt noget.

Skriv manualen

• Brug de røde links til at lave siderne og skriv et afsnit ad gangen.

• På diskussionssiden kan du notere alt det, som du skal kigge på senere, så som links, der ikke kan laves endnu.

Husk!

Det er vigtigt at være konsistent, ikke mindst i manualer, så her er nogle almindelige regler:

• Vær omhyggelig med overskriftniveauer — vi starter på andet niveau (Mediawiki bruge topniveauet til sidenavne) med ==

• Sørg for at se her og på Opgaver og værktøjer og Typografiske retningslinjer med jævne mellemrum

• Tjek, at alle tabelceller har et mellemrumstegn efter "pipe"-tegnet. Denne regel følger traditionel wiki-formattering.

• Vær konsistent i formatteringen af programnavne (undgå at skrive Amaroks, skriv Amarok's — på dansk dog Amaroks).

• Søre for, at alle billeder er i PNG-format (du kan også bruge JPEG, men i så fald bør du konvertere dem til PNG senere. Gør dit arbejde nemmere ved at konvertere dem fra begyndelsen af .

• Fjern alle blanktegn fra billednavne.

Forbered manualen for oversættelse

• The steps for markup editing can be found on Preparing a Page for Translation. Please adhere to that guide, since old markup styles may not still be relevant.