Documentatie, handleiding: geen.
Hoe op een goede manier je LAMP-project documenteren, en hoe een nuttige handleiding maken voor de gebruikers van de software? Voor documentatie van de software kan je er van uit gaan dat de ontwikkelaar dat automatisch doet, maar misschien is die wel van het principe “het programma is de documentatie”. In zekere zin is dat ook zo bij open source software, zoals het ook bij script-talen voor de hand ligt. Een MySQL database is ook geen geheime zwarte doos en laat toe de struktuur te onderzoeken of exporteren. Maar toch.
Voor de gebruikersdocumentatie is het anders, de ontwikkelaar kan niet aan alle gebruikers uitleg gaan geven. Een handleiding of gebruikersdocumentatie is dus nodig. Om achteraf geen tijd te verliezen zou heel wat uitgezocht moeten worden voor je de documentatie begint te maken:
Wat is het makkelijkste formaat? Moet het gedrukt worden? PDF? Of moet het online geraadpleegt worden (logisch bij een web-interface)? Schrijf je die dan als html? En bestaan daar vrije-software tools voor om dat te doen? Als er meer dan 1 taalversie van moet gemaakt worden zal dat ook invloed hebben op het maken van de documentatie; eerst in 1 taal? Welke? Moeten de gebruikers de handleiding kunnen aanvullen (zoals in wiki-systeem)? Moet de handleiding geïntegreerd zijn of afzonderlijk kunnen verspreid worden?
Ik heb helaas alleen nog maar de vragen…