[selinux-docs] Re: Sammandrag av selinux-docs, kommentarer

[Alexander Nordström]

Sunday, 16 October 2005 18:34, Martin wrote:
> Jag tror SVN är ett måste för att under längre tid underhålla
> översatta dokument. Inte bara för att det blir svårt för den
> ursprunliga översättaren att underhålla sina översatta dokument på
> egen hand, utan även för att de ska utvecklas till det bättre. Ett
> problem här är dock hur erkännande av arbete ska gå till. Det kan
> tänkas att översätta dokument i framtiden till stora delar skrivs om.
> Det blir lite klumpigt att föra dokumenthistorik över alla ändringar,
> i själva dokumentet, men samtidigt är det trevligt om någon får sitt
> erkännande vid större omarbeten.

Samtliga personer som bidragit till ett dokument ska givetvis få 
erkännande i dokumentet. Det gäller såväl ursprungsförfattare som 
nuvarande och tidigare översättare. Detta sker vanligtvis genom att 
dessa personer namnges i början av dokumentet samt i den 
upphovsrättsliga informationen, vanligtvis i slutet av dokumentet. 
Många dokument har också en versionshistorik. Denna brukar dock 
inskränka sig till en svepande summering av vilka förändringar som 
gjorts i den senaste versionen.

Min huvudtanke med SVN har i första hand inte varit att flera personer 
ska arbeta med ett och samma dokument, även om det ger möjlighet till 
visst samarbete. Fler än två översättare per dokument är nog för många 
kockar per soppa.

Fördelarna med SVN blir då istället följande:
 - Dokumenten får en versionshistorik (alltid bra att ha).
 - Det blir lättare för den som vill ta över ett övergivet dokument att 
   komma igång när den senaste versionen under arbete finns på nätet.
 - Korrekturläsning kan ske direkt i dokumentet. När korrekturläsningen 
   är klar förs ändringarna in i SVN-arkivet. Översättaren kan lätt se
   med en diff vilka ändringar som gjorts och göra eventuella vidare 
   justeringar.

> Jag gillar tanken med Wiki. Är det möjligt att publicera vägledningar
> som Wiki-sidor? Det kanske går emot tanken med arbetet lite. Att göra
> översättningarna till Wiki-sidor ger naturligtvis ytterligare arbete
> i början, men i mina ögon är det ett av de bästa sätten att få
> dokument att utvecklas. Det är ett enkelt sätt att få personer att
> arbeta med dokumenten direkt, utan att behöva sätta sig in i andra
> program. En annan trevlig idé med Wikis är att lägga upp
> originaldokumentationen oöversatt, och sedan låta de som vill
> översätta det - i samarbete. Det skulle ge snabbare översättningar,
> och mer villiga att hjälpa till tror jag. Förmodligen även bättre
> översättningar. Men som sagt, kanske det går emot tanken lite?
> Wiki-sidor innebär naturligtvis lite mindre övergripande kontroll av
> arbetet också. Det är kanske inte alla licenstyper som tillåter det
> heller.

Det har pågått en diskussion på moderprojektet LDPs diskussionslista ett 
tag nu om huruvida de ska införa någon typ av wiki. Mitt intryck av 
diskussionen är att de flesta är skeptiska till det, och jag har viss 
förståelse för det, även om jag gillar wiki, både som idé och i 
praktiken med webbplatser som Wikipedia i åtanke.

Några av problemen som jag ser är specifika för översättningsprojektet. 
Andra är mer generella för LDP eller wikiwebbplatser i allmänhet. Att 
implementera översättningsprojektet som en wiki tror jag stöta på 
följande problem:

 - risken för vandalism,
 - LDPs breda licensflora,
 - svårigheten att publicera för spegling,
 - sämre kontroll över dokumentens status,
 - minskat individuellt ansvar för enskilda dokument och
 - behandling av ofärdiga översättningar när originalet uppdateras.

Så jag tror mer på en modell med ett SVN-arkiv för dokument under 
bearbetning i kombination med ett FTP-arkiv där färdiga dokument 
publiceras i olika format. Jag har grunnat på detta en del idag och 
kommit fram till följande förslag:

 - SVN-arkivet innehåller kataloger såsom howto, faq och guide efter
   behov och i likhet med den engelska strukturen.
 - Howto-katalogen innehåller enbart filer i källkodsformat.
 - Docbook och Linuxdoc ligger i samma katalog.
 - Dokument som kräver flera filer läggs i underkataloger.
 - Engelska filnamn bevaras.
 - SVN-arkivet är läsbart för alla.
 - Översättare kan låna, uppdatera och infoga ändringar i de dokument
   till vilka de fått skrivrättigheter.
 - Den dokumentationsansvarige kan skapa nya dokument, dela ut
   rättigheter samt vid behov ta bort dokument och dess historik.
 - Den dokumentationsansvarige kan även officiellt publicera
   dokumentation från SVN-arkivet.

Vid publicering av dokument sker följande:
 - Dokumentet översätts till de olika publiceringsformaten och
 - de olika formaten laddas upp till FTP-servern i respektive katalog.

-- 
Alexander Nordström
Svenska Linuxföreningen
http://se.linux.org
Skicka inte kopior på uppföljande meddelanden till mig;
jag prenumererar på selinux-docs.
-------------- 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-docs/attachments/20051016/905c5897/attachment.pgp