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.
- Note on the Discussion page anything you will need to refer to later, such as links that can't yet be created.
Remember
It's important to be consistent, particularly in Manuals, so here are some general rules:
- Take care with heading levels - we start at second level (Mediawiki uses top level for page-name), using ==
- Make sure you refer frequently to this page, to Tasks and Tools and to Typographical Guidelines
- Check if all table cells have space after the pipe character. This rule conforms with traditional wiki formatting.
- Make application name formatting consistent (avoid using Amaroks, do use Amarok's).
- Ensure that all images are in PNG format (you can use JPEG (.jpeg, not .jpg) as well, but in this case you should convert your images to PNG later. Save work by converting them before you start
.
- Remove all non-printable characters from image names.
Preparing the Manual for Translation
- 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.