Nederlandse documentatie

Ik ben op dit moment op mijn stage bezig met documentatie over MODx. Ik moet nog even overleggen of ik deze op internet mag zetten, maar ik voorzie daar geen problemen in.

Heeft iemand dingen die er zeker in moeten komen? Ik ben op dit moment met een leeg document begonnen die begrijpbaar is voor onze klanten, deze documentatie is dus anders dan de engelse documentatie die op de site staat.

Op dit moment heb ik het volgende er al in zitten:

• inloggen & uitloggen
• Documenten
• Pagina toevoegen

Ik hoor het graag als iemand over bepaalde dingen al nederlandse documentatie heeft, deze zou ik dan graag willen toevoegen aan mijn documentatie.

Wat voor documentatie gaat het worden? Een handleiding voor klanten of echt een handleiding voor websitebouwers?

Ik ben in beide geinteresseerd.

Voor klanten die zelf hun content onderhouden zou een overzichtelijke handleiding (met een uitleg van QuickEdit) welkom zijn.

Voor websitebouwers kun je denken aan onderwerpen als template variabelen en chunks. Maar denk ook aan het maken van beveiligde content (hier heb ik een beknopte handleiding van gepost aan de hand van schermafdrukken). Installatie van snippets, plugins en modules, dat soort dingen.

Zelfs de vraag ’hoe krijg ik de voorbeeldpagina/-site’ weg uit de manager zou je kunnen beantwoorden.

Een beetje rondneuzen hier op de forums zal je een beetje een beeld geven van veel voorkomende problemen waar ’beginners’ tegenaan lopen. Brengt je misschien ook nog op ideeen.

Wat Nederlandstalige documentatie zou zeker welkom zijn en het Nederlandse forum misschien weer eens wat leven in kunnen blazen.

Succes met het schrijven ervan!

In eerste instantie word begonnen aan documentatie voor klanten, daarna als het goed is ook voor websitebouwers

Ik ben ondertussen druk bezig met het maken van de documentatie voor klanten en heb nu al 18 pagina’s inhoud. Ik heb nog 7 pagina’s klaarstaan om in te vullen en daarna zullen er nog meer volgen.

Ik verwerk nu de volgende elementen erin:

• Inloggen & uitloggen bij MODX
• Documenten
• Pagina aanmaken
• Link aanmaken
• Bestanden uploaden
• Zoeken
• WYSIWYG Editor (tinyMCE)
• Zoeken/vervangen
• Speciale tekens invoegen
• Afbeelding invoegen
• Hyperlink invoegen
• Bladwijzer invoegen
• Video invoegen
• Tabellen

Ik denk dat deze lijst al redelijk compleet is, zijn er nog bepaalde dingen die jullie erin willen?

Lijkt mij inderdaad vrij compleet.

Misschien kun je bij de WYSIWYG editor ook aan een uitleg van QuickEdit denken.

Als ik een klant zelf de content laat onderhouden, dan laat ik ze na het inloggen meestal meteen naar de homepage gaan, waar ze met QuickEdit (en de knop Wijzigen content) meteen aan de slag kunnen. Veel gebruikersvriendelijker is het haast niet te maken

Zelf heb ik een voorkeur voor FCKeditor: overzichtelijker en gebruikt minder resources. Maar dat is natuurlijk altijd in de handleiding aan te passen.

Quote from: WeBe at Dec 24, 2007, 04:49 PM

Lijkt mij inderdaad vrij compleet.

Misschien kun je bij de WYSIWYG editor ook aan een uitleg van QuickEdit denken.

Als ik een klant zelf de content laat onderhouden, dan laat ik ze na het inloggen meestal meteen naar de homepage gaan, waar ze met QuickEdit (en de knop Wijzigen content) meteen aan de slag kunnen. Veel gebruikersvriendelijker is het haast niet te maken

Zelf heb ik een voorkeur voor FCKeditor: overzichtelijker en gebruikt minder resources. Maar dat is natuurlijk altijd in de handleiding aan te passen.

QuickEdit ben ik idd helemaal vergeten, die komt er ook nog in

Ik voel persoonlijk ook meer voor FCKeditor, maar op mijn stage houd ik de installatie het liefste zo standaard mogelijk. Bij eventuele support vragen hoef ik dan niet helemaal uit te leggen wat ik allemaal vervangen heb

Ik ga overigens over 2 weken pas weer verder met de documentatie, ik heb nu vakantie en ik heb het document op mijn werk gelaten.

Het kan nog even duren voordat ik verder kan met het afmaken van de documentatie. Ik moet nu eerst nog wat opdrachten afmaken voordat er weer tijd vrij is voor de handleiding.

Klinkt bekend... kom ook altijd tijd tekort

Kan je helaas geen hulp aanbieden op dit moment.

Hoi Ronald,

Het klinkt al heel compleet! Ik maak meestal een handleiding op maat per project, maar die zijn altijd korter (3-4 A4tjes).
Misschien kun je nog iets schrijven over back-uppen. Ik vertel er in elk geval wel altijd bij hoe dat moet (heb ooit een klant gehad van wie de server crashte en de provider had geen backups >:( ).

Quote from: Maaike at Feb 08, 2008, 09:27 PM

Hoi Ronald,

Het klinkt al heel compleet! Ik maak meestal een handleiding op maat per project, maar die zijn altijd korter (3-4 A4tjes).
Misschien kun je nog iets schrijven over back-uppen. Ik vertel er in elk geval wel altijd bij hoe dat moet (heb ooit een klant gehad van wie de server crashte en de provider had geen backups >:( ).

Inderdaad is het wel verstandig om dit erbij te doen, alhoewel ik niet weet of dit er gelijk in komt. Wij beheren zelf alles voor onze klanten waardoor het voor onze klanten minder van belang is. Maar het is sowieso intern ook handig om te hebben