Onze nieuwe documentatie app
Gendocs is ontstaan omdat we een documentatie tool nodig hadden voor onze opensource projecten. Nu hopen we het ook te kunnen gebruiken voor klantprojecten.
Marketing site
Gendocs is volledig gedocumenteerd in Gendocs zelf. Deze documentatie dient dus meteen ook als demo voor de applicatie. Natuurlijk was het ook nog nodig om een marketing site te maken wat origineel niet mogelijk was met Gendocs. Dus hebben we aan Gendocs de functionaliteit om een custom front page te maken toegevoegd. En dus gebruikt de website gendocs.io nog steeds volledig met Gendocs.
Het hoofddoel van Gendocs is om een simpele en propere oplossing te bieden om publieke documentatie te schrijven. Dit was dus ook het belangrijkste principe bij het ontwerpen van de marketing site. Alle overbodige informatie hebben we daarom van de marketingsite gehaald om bij het bare-minimum te blijven en zo een site te maken die duidelijk en simpel uitlegt wat Gendocs doet en wat het kan.
Zoekmachine
Veruit het belangrijkste deel van documentatie is de zoekfunctionaliteit. Je mag een prachtig ontwerp hebben, een vliegensvlugge site en zelfs de beste geschreven documentatie hebben die er bestaat. Als de gebruiker niet vindt waar hij naar zoekt is het allemaal nutteloos.
Meestal gebruiken we hiervoor de Elastic Stack. Het nadeel hiervan is dat er veel setup nodig is en dat de kost relatief hoog ligt. Daarom hebben we bij Gendocs MeiliSearch gebruikt.
Ondanks dat we MeiliSearch voordien al verschillende keren hadden uitgetest in proof of concept applicaties heeft het ons toch verbaasd in hoe makkelijk het is om te gebruiken alsook hoe snel het werkt. Ik kan al met zekerheid zeggen dat we MeiliSearch nog zullen gebruiken in toekomstige applicaties waarbij de Elastic stack iets te heavy weight is.
Wij horen graag van u!
Contacteer ons