Date: Sun, 21 Aug 2005 18:38:51 +0200 From: Phil Regnauld <none@regnauld--x0.dk.lh.bsd-dk.dk> To: bsd-dk@bsd-dk.dk Subject: Re: Konfigurations oversigt over serverpark
On Sun, Aug 21, 2005 at 02:26:16PM +0200, Michael Knudsen wrote:
>
> 1) Ting bliver aldrig nogensinde dokumenteret.
Min oplevelse er at, medmindre der er strenge instruktioner
og krave fra ledelsen, er det endnu værre med "tradtionelle"
dokumentation i form af Word/statisk tekst dokumenter.
Efter at have brugt TWiki flere steder, viser det sig at
være, sammen med Lotus Notes (samme princip) den bedste måde,
med laveste adgangs "threshold", at dokumentere. Bare man husker
at det er en ad-hoc system.
TWiki har det fordel at den har indbygger versionering vha. RCS,
som gør det muligt at se ændringshistorik i dokumenterne.
> 2) Ting bliver kun overfladisk dokumenteret.
Det er ikke et problem med værktøj, men med dokumentations
procedurerne.
> Jeg har en mistanke om, at det skyldes, at ``det kan jeg lige rette
> senere'', og i min verden har `senere' vist sig at betyde `aldrig'.
Det svarer til at sige "Perl er nem at programmere i, jeg behøver
ikke lave variable declaration, så gør jeg det ikke".
> Jeg ville _personligt_ foretraekke et eller andet, der kan klares
> lokalt paa den server, man laver aendringerne paa, og derefter
> synkroniseres ind i et centralt repository. Jeg ville nok finde CVS
> eller Subversion velegnede til dette -- med Tortoise-klienterne ville
> man ogsaa fint kunne benytte dem fra Windows paa en god maade.
God idé, så mangler der kun et valg om noget hypertekst som gør
det nemmere at lave kryds referencer i dokumentationen. Det kan
man da godt i Pod... eller Wiki.
> Hvis man ikke har noget imod at arbejde gennem en webbrowser, kan et
> Wiki sikkert vaere en god loesning.
De fleste Wiki'er tillader upload af preformatterede dokumenter.
Jeg har været med at hjælpe nogle kunder at migrere flad tekst-baseret
dokumentation til TWiki. Stor succes.
Jeg har også skrevet en del QA valideret dokumentation med standardiseret
skabelon. Den kan jeg ikke sige er lige så godt vedligeholdt.
Igen, det er vigtigt at huske formålet med sådan en system. Hvis
der er tale om vel-defineret data hvor struktur sjlældent ændrer sig,
kan en SQL/PHP form baseret løsning være en god idé (til f.eks
en udstyrsdatabase, hvor kravene er forholdsvis vel kendte).
Hvis der skal løbende tilføjes nye "felter", informationer, osv...,
en en flad tekst fil eller en Wiki nok en bedre idé.
This archive was generated by hypermail 2b30 : Wed 15 Nov 2006 - 18:24:51 CET