[selinux-aktiva] Dokumentationsmötet 29/11 - sammandrag

[Alexander Nordström]

Sammandrag från dokumentationsgruppens möte den 29 november

Närvarande var LX, timte, Vecchio och dikatlon. Vi ser gärna att fler 
tar aktiv del i dokumentationsgruppens arbete. Vad tycker alla ni 
andra? Läs och kommentera!

Vi talade först och främst en del om att skapa mer enhetlig och 
sammanhängande dokumentation i första hand avsedd för nybörjare och 
mellanavancerade användare, vilka vi ser som en primär målgrupp. Därför 
bör vi satsa på att börja med att skriva grundläggande handledningar 
för vanliga sysslor, gärna med inriktning på program som finns för 
många olika operativsystem för att underlätta smidig migration.

För att skapa enhetlighet vore det bra om dokumentationen åtminstone 
delvis följer en gemensam mall. Vi börjar med att jobba på en 
introduktion till webbläsaren Mozilla Firefox. Tim kontaktar mozilla.se 
för att se vilka önskemål och idéer samt vilket eventuellt färdigt 
arbete de har. Målsättningen är rikt illustrerad dokumentation som 
börjar på nybörjarnivå och gradvis blir mer avancerad allteftersom 
ämnet kräver det. På samma sätt bör även arbetet struktureras.

En uppstädning av dokumentationsmappen anses också behövas. Skillnaderna 
mellan kategorierna är många gånger oklara och fokuserade på form 
snarare än innehåll. Hierarkin är både för djup och för bred, särskilt 
för den innehållsmängd vi kan tänkas uppnå inom överskådlig tid. En 
innehållsförteckning över en sådan enhetlig dokumentation som nämnts 
ovan vore förmodligen bättre än en katalogstruktur för en stor del av 
innehållet. Tim undersöker vad som krävs för att dirigera om trafik 
till flyttade dokument.

Vi diskuterade även om en wiki med versionshistorik och möjlighet för 
flera att redigera vore lämpligt. Detta skulle kunna underlätta 
situationen för deltagare som vill göra små förbättringar utan att göra 
stora åtaganden eller "störa" författaren "i onödan". En del uppfattar 
dock wikisystem som onödigt komplicerade, och att införa ett sådant 
skulle kräva resurser som kan göra mer nytta i andra arbetsinsatser. 
Plone, som föreningens webbplats bygger på, har en wikifunktion som 
används i dokumentationsmappens idé-wiki, men vi behöver undersöka 
möjligheterna och begränsningarna med denna och alternativa lösningar 
jämfört med nuvarande system.

Vi fortsätter att ha idén i åtanke, men avvaktar för tillfället om inte 
intresset bland skribenterna visar sig större. På den här punkten är vi 
särskilt intresserade av vad ni, våra tilltänkta skribenter, tycker. 
Tim har nu lagt till en röstningsfunktion på webbplatsen, så om några 
välformulerade alternativ utkristalliseras kan vi genomföra en 
omröstning.

Redan i nuläget finns möjligheter att dela ut rättigheter till andra för 
att samarbeta kring enskilda dokument. Det ger originalförfattaren 
större kontroll, men skulle också behöva versionshistorik och helst 
någon typ av samkörningskontroll för att undvika att samtida 
förändringar skriver över varandra. Att originalförfattaren meddelas 
när en person med rättigheter gör en ändring vore önskvärt.

Kommentarer tilläts tidigare till alla dokument på webbplatsen, men 
detta bedömdes inte fungera tillfredsställande och har sedan dess 
inaktiverats. Privata kommentarer är önskvärda oavsett om publika 
kommentarer ska tillåtas eller inte, och dokumentets författare bör 
meddelas om nya kommentarer via e-post. Om publika kommentarer tillåts 
bör författaren kunna ta bort kommentarer om de blir inaktuella (till 
exempel för att påtalade fel rättats till) eller är olämpliga.

Betygssättning av artiklar har föreslagits, men detta kan lätt bli 
missledande av personliga skäl eller för att omfattande bearbetning 
dras med gamla betyg. Idén avvisas därför.

GFDL, Gnuprojektets licens för fri dokumentation är behäftad med vissa 
problem. Vi bör markera detta bättre, och jag skriver en brasklapp för 
GFDL-mappen för att beskriva problemen och understryka att 
översättningen av licensen inte bör uppfattas som att licensen 
rekommenderas. Allt innehåll på webbplatsen som inte specificerar något 
annat licenseras enligt villkoren i Creative Commons 
Share-Alike-licens, och det är den licens vi rekommenderar för 
nyskrivet innehåll.

Vi fortsätter dock att hämta in information från andra källor så länge 
den är licenserad enligt villkor som tillåter det, även om rätten att 
förändra dem är helt eller delvis begränsad. Givetvis ska vi dock 
prioritera så fria licenser som möjligt även när vi hämtar dokument 
från andra källor.

Har du några synpunkter på ovanstående, eller har du något annat du vill 
ta upp? Berätta!

-- 
Alexander Nordström
Styrelseledamot och dokumentationsansvarig
Svenska Linuxföreningen
http://se.linux.org
-------------- next part --------------
En bilaga som inte var text, skiljdes ut...
Namn       : inte tillgänglig
Typ       : application/pgp-signature
Storlek: 189 bytes
Beskrivning: inte tillgänglig
URL        : http://mail.se.linux.org/pipermail/selinux-aktiva/attachments/20041130/639040b9/attachment.pgp