Documentatie, handleiding: hoe?
- documentatie die zeker werkt is html: te schrijven met een eenvoudige txt-verwerker tot Webeditor als Quanta. Raadplegen kan met eender welke browser, er kan uit gekniopt en geplakt worden, een copy op CD kan zelfs als documentatie gebruikt worden. Maar moet je zelf alles organiseren: inhoud, verwijzingen, … en als je wil werken vanop verschillende locaties of met meer deelnemers wordt het omslachtig.
- om gemakkelijk tekst online te krijgen, te raadplegen via browser, en waarbij de inhoud ook gevuld kan worden via een browser lijkt het gebruik van een wcms voor de hand te liggen, bv phpbb, waarbij je rubrieken zo indeelt dat ze overeenkomen met wat je nodig hebt. Hier is het wel moeilijk om er bv een pdf-handleiding uit te halen nadien en ook de applicatie aanpassen aan je noden is extra werk.
- wiki: web-interface lezen, en even web-interfaced online schrijven; plaatselijk (online) te installeren, bijdragen en uitbreidingen doorlopend mogelijk ook door gebruikers van de documentatie.
Dit zijn command-line systemen, voor een LAMP project minder geschikt:
- Texinfo: gebruikt door de free software foundation (GNU) om documentatie te schrijven bij hun software. Bedoeld voor het gebruik met “info”, de command prompt lezer (bv “info tex” geeft op command prompt uitleg over tex). Heeft goede uitvoer voor gedrukt werk. Niet duidelijk of er goede html uitvoer is.
- man: standaard systeem op linux om “manuals” te maken die geraadpleegd worden met het command line programma “man”, bv “man help” om uitleg over “help” te krijgen. (vgl info)
- Docbook ziet er interessant uit. Is het makkelijk aan te leren of te beginnen gebruiken?
- …