Huvudsida/Handbok
Ubuntu Sverige
Innehåll |
[redigera] Vem skriver du för
Vilken är din målgrupp?
En del handledningar beskriver sådant som nybörjare inte bör handskas med, då kan man anta att läsaren känner till saker som kommandon och text-editorer samt har koll på hur Linux är uppbyggt och fungerar. Andra handledningar vänder sig till nya/ovana användare, som inte har lika stor erfarenhet av Linux eller datorer i allmänhet.
Avgör hur mycket du behöver förklara och vilka förkunskaper som krävs för att följa handledningen. Tänk gärna på en konkret person, det kan vara en administratör eller din moster i Säffle (fördom: mostrar i Säffle är inte så Linux-kunniga).
Målgruppen beskrivs i sin tur delvis av ämnet. Skriver du om enkel ordbehandling i OpenOffice vänder du dig antagligen till mostern i Säffle och då kan de vanlig dialogruta vara svår att förstå. Beskriver du däremot hur man sätter upp virtuella hostar i Apache, så kan man anta att användaren är rutinerad och vill ha en så koncis och snabb genomgång som möjligt. Kan du en "genväg" eller två är det dock ofta uppskattat!
När du vänder dig till nybörjaren får du inte ta någonting för givet. Allt bör förklaras noga, steg för steg. Allt behöver dock inte förklaras just i din text, länka gärna till andra handledningar. Undvik tekniska termer, och förkortningar och om du måste ta med sådant - förklara! Använd gärna bilder.
[redigera] Vad hör hemma var?
Den information som wikin presenterar skulle huvudsakligen kunna delas upp i följande delar:
- Informativa artiklar om hur olika fenomen inom linux världen fungerar
- HowTo's och guider som är längre vägledning för specifika projekt på Ubuntu.
- Nybörjarguider och frågor. Sidor riktade helt mot de som är nya i Ubuntu.
De olika kategorierna går in i varandra men för att strukturera upp informationen kan följande tumregler användas
- Information om program hamnar i huvudsak under kategorin Program
- Längre guider som spänner över fler områden hamnar under "Howtos".
- Artiklar om multimedia på ubuntu eller multimedia i allmänhet hamnar under kategorien Multimedia.
- Allt som ni är osäkra på vart det skall ligga, kan lägga under Övrigt. Administratörerna kommer då flytta det om de behövs.
- All officiell dokumentation och information om Ubuntu i allmänhet ligger på portalen.
[redigera] Sidans struktur
Alla sidor skall vara snyggt strukturerade och därför skall de vara uppbyggda enligt följande mall.
Alla sidor börjar på dessa tre rader.
{{Testad|Ubuntu 8.04}}
{{titel|Första rubriken}}
<br />
__toc__
Därefter följer resterande guide. Se till att strukturera dem i rubriker:
==rubrik-1== ===rubrik-1:1=== ===rubrik-1:2=== . . .etc ==rubrik-2== ===rubrik-2:1=== ===rubrik-2:2=== . . .etc ==rubrik-3== . . .etc
[redigera] Kvalitetsstämpel
Den första biten {{Testad|Ubuntu 8.04}} är en så kallad kvalitetsstämpel. Den är till för att användarna skall kunna vara säkra på att guiden funkar mot motsvarande version. Det är viktigt att ni har en så ren installation av versionen som möjligt. När ni går igenom guiderna så är det viktigt att ni ändrar dessa så att den "röda tråden" är anpassad till senaste versionen (8.04).
Alla andra versioner skall behandlas som tillägg (sidospår) i guiden. Dessa skall tydligt markeras och det skall framgå för vilken version de är till för. När en guide testats mot en annan version än 8.04 och funkar (med eller utan tillägg) så kan ni lägga till detta i kvalitetsstämpeln.
[redigera] Sammanfattning
Direkt efter huvudrubriken kommer en kort introduktionstext till sidan. Beskrivningen skall vara kort, helst inte mer än 10 rader.
[redigera] Förberedelser / Förutsättningar
Saker man behöver förbereda innan man följer guiden. Kan vara allt från förkunskap till mjukvara eller hårdvara som behövs.
[redigera] Så här gör du
Steg för steg-beskrivning illustrerad med bilder. Fokuserat på HUR man gör inte varför. Det här är den viktigaste delen. Den vi ska lägga mest krut på.
Använd med fördel underubriker för att snyggt strukturera upp instruktionerna.
[redigera] Förklaring
Teknisk bakgrund till det man gjorde - för den som bryr sig.
[redigera] Problemlösning
Vad kan rimligen gå fel, hur märker man det och hur fixar man det
[redigera] Resurser
Länkar, litteraturreferenser, var man hittar källkod eller vad det nu kan vara.
[redigera] En bild säger mer än tusen ord
Ni får gärna infoga bilder där det behövs. Framförallt i programsektionen så andra vet hur programet ser ut. Använd bara inte för många bilder då det lätt kan bli svåröverskådeligt.
Bilderna kan läggas upp här, varefter det går att använda dem i texten med kommandot: [[Bild:bildnamn]]
Bilderna får max vara 730px breda och 150kb stora.
[redigera] Använda scrot för att ta bilder
För att ta bilder kan ni använda programet scrot:
sudo apt-get install scrot
Öppna sedan en terminal och skriv:
scrot -sb
Varefter du klickar på fönstret du vill få en bild på.
[redigera] Språket
Undvik slang, jargong och nördiska. Skriv så gott det går på vanlig "bondsvenska".
Facktermer och akronymer (förkortningar) kan knappast undvikas helt
men bör vara så få som möjligt och ska förklaras på lämpligt vis.
Det finns inget som hindrar att du skriver personligt, roligt och lättsamt.
Tvärt om uppskattar de flesta läsare det.
Försök stava rätt och hjälp varandra att korrekturläsa och rätta till de fel
som ändå smugit sig in. Använd gärna ordlistor, se nedan och rättstavnings-
program.
Särskrivning är en vanlig sjuka. Läs det du skrivit högt, med en tydlig paus vid varje
mellanslag så hör du om det blivit rätt. Blir det fel blir också betydelsen
annorlunda. Jämför följande meningar.
1) En röd hårig sjuk sköterska
2) En rödhårig sjuksköterska
I mening ett är det lite oklart vad kvinnan sköter, men hon är krasslig, har vänster-
sympatier och generande hårväxt. Den andra meningen tror jag ni kan tolka själva.
Hård disk kan det bli om man har haft många gäster och diskmaskinen strejkar, men aldrig i datorn.
Ordval
Vissa ordval kan vara känsliga, men här på Ubuntu Sverige har vi beslutat att uttrycken GNU/Linux och Linux får användas som likvärdiga synonymer när man beskriver en
distribution med Linuxkärna som exempelvis Ubuntu. Författaren avgör vilket ordval denne vill använda och detta får inte ändras av andra utan författarens medgivande.
Resurser
[redigera] Layoutfrågor
[redigera] Rubriker
Använd rubriker för att organisera din sida.
Börja med 1a rubrik på sidnamnet, därefter 2a rubrik för huvudkategorier etc..
= Sidnamn = == 2a Rubrik == === 3e Rubrik === ==== 4e Rubrik ====
[redigera] Styckesindelning
Du kan enkelt dela upp din text i stycken (paragrafer) genom att lämna en blank rad emellan. Gör du detta efter några meningar så blir din text mkt enklare att läsa.
[redigera] Licensfrågor
Alla sidor på Ubuntu-se wiki är licenserade under Creative Commons Attribution-Share Alike 3.0
Detta innebär bl.a. att du bara får porta guider från sidor med samma licens. Du måste även ange referens till den urpsrungliga sidan.
Hittar du en guide under annan licens, så länka direkt till sidan, eller skriv om guiden från grunden (bättre självklart =) )och posta den sen i vår wiki.
