Online handleiding (ideeen?)

[bsmpower]

Ik weet niet of dit onder Programming hoort of hier maar plaatst het even hier.

Ik heb een handleiding van ongeveer 80 pagina's voor een applicatie die meerdere instanties in Nederland gebruiken. Deze wordt af en toe geüpdate en digitaal (pdf) doorgestuurd naar de mensen die hem moeten gebruiken. Ik heb gezocht naar een betere oplossing. Ik heb daarom een Wiki (MediaWiki) opgezet. Ik heb alle pagina's aangemaakt en de navigatie en registreer rechten aangepast. Dit werkt best ok. Het zoek venster is makkelijk voor gebruikers om te zoeken naar een specifiek probleem.

Nu is het nadeel dat je voor Wiki een database en php nodig hebt. Er is een grote kans dat de Wiki niet op de server kan blijven staan. Dus als ik de hele Wiki heb gevuld moet deze later weer verhuist worden. Daarbij werkt niet alles vlekkeloos (foto's uploaden en toevoegen) en heb ik vaak een time-out error (server van mijn werkgever) waardoor ik continue moet in- en uitloggen. Hier kan vast iets aan gedaan worden maar ik ben niet de beheerder van de server en ook niet direct toegang. Komt er op neer dat het allemaal redelijk omslachtig is voor een paar pagina's handleiding.

Nu mijn echte vraag. Ik wil op een makkelijke manier de handleiding online hebben. Ik dacht zelf aan een hele basic html site zodat deze ook offline te raadplegen is (als de bestanden lokaal staan uiteraard). Tevens kan ik de bestanden heel snel overzetten naar een andere server als dat moet. Ik mis dan alleen het zoekvenster. Maar dit is op te lossen met een duidelijk inhoudsopgave op de homepagina of het gebruik van ankerpoints.

Maar misschien hebben jullie nog ideeën? Bestaan er scripts/applicaties waarbij ik op een eenvoudige manier een handleiding online kan zetten? Het liefst met zoekfunctie maar dan is een database verplicht?

[Sypher]

Voor documentatie en wiki's kan ik je dokuwiki aanraden. Bijkomstig voordeel hiervan tov mediawiki is het feit dat je geen database nodig hebt. Dus je kan hem eenvoudig verplaatsen.

Goed, je blijft wel PHP nodig hebben maar ja.

En dokuwiki heeft een prima zoekmachine

quote: http://www.dokuwiki.org/

DokuWiki is a standards compliant, simple to use Wiki, mainly aimed at creating documentation of any kind. It is targeted at developer teams, workgroups and small companies. It has a simple but powerful syntax which makes sure the datafiles remain readable outside the Wiki and eases the creation of structured texts. All data is stored in plain text files – no database is required.

Werkt perfect. Ik heb er al diverse opgezet om documentatie (en eigenlijk alles wat centraal opgeslagen moet worden) beschikbaar te maken.

Overigens kan je het ook uitbreiden met diverse plugins waaronder ODT, PDF export etc.

[ Voor 60% gewijzigd door Sypher op 18-06-2009 14:47 ]

[g0tanks]

Je kan ook een online pdf reader op je site zetten (daar zijn vast wel zat scripts voor), of Google Books gebruiken.

[Janoz]

Met iets als wget (of wat voor tool dan ook) is het wel mogelijk om je huidige mediawiki te kunnen exporteren naar een enorme berg statische HTML pagina's. Bewerkingen blijf je dan gewoon in de wiki doen en als je de handleiding dan wilt 'releasen', draai je een nieuwe export. Statische HTML kun je dan vervolgens neerzetten waar je wilt, of eventueel zelfs aanbieden als download (in een zipje).


Een andere mogelijkheid is het gebruik van Latex (is wel een groot topic over). Deze heeft de mogelijkheid om naast naar een pdf, ook naar html te kunnen 'renderen'.

[moozzuzz]

Als je je documentatie openbaar mag hosten, kan je de search evt. via google laten verlopen. (searchbox maken die een form post naar
http://www.google.be/search?hl=nl&q=WatIkZoek&btnG=Google+zoeken&meta=&aq=f&oq=test

[Wortelsoep]

Kun je niet gewoon op zoek naar betere hosting? Zo spannend is een php wiki+database niet.

[ Voor 31% gewijzigd door Wortelsoep op 18-06-2009 17:45 ]

[Borizz]

Je zou eens naar Docbook kunnen kijken, dat is een formaat waarin je je handleiding kan opslaan. Vanuit Docbook heb je dan ook de mogelijkheid om bijvoorbeeld HTML en PDF te genereren. Wellicht dat er ook nog andere vergelijkbare formaten zijn.

[bsmpower]

Bedankt voor jullie reacties! Ik zal er een aantal proberen. DocuWiki klinkt interessant. Qua server. De organisatie heeft een aantal bureaus in Nederland die een intern netwerk hebben. Hier wil ik de documentatie plaatsen zodat deze zichtbaar is voor de bureaus maar niet voor buitenstaanders. Ik ga vandaag eens aan de slag met jullie tips. Thanks.