Hey,
Ik ben bezig met het schrijven van een script die tcp services monitored en als er eentje down gaat een email/sms stuurt om te gebruiker te laten weten dat een van zijn services down is. Het systeem zelf is bijna af. Ik zit nu nog met het stukje documentatie. Wat wil de doelgroep, de doelgroep zijn webmasters waarvan genoeg op deze forums, allemaal in de documentatie hebben.
Ik denk zelf het volgende:
Veel meer dan dit kan ik niet bedenken. Kunnen jullie met mij meedenken?
- Quick start guide, hoe kan je snel aan de slag met het systeem.
- Installatie handleiding, hoe moet ik het systeem installeren.
- Aanpassing/integratie, hoe kan ik het systeem het makkelijkst integeren met mijn bestaande codebase..
Alvast bedankt!
- Documentatie
-
10-07-2012, 11:35 #1
- Berichten
- 31
- Lid sinds
- 15 Jaar
Documentatie
-
11-07-2012, 14:01 #2Particulier
- Berichten
- 131
- Lid sinds
- 16 Jaar
Re: Documentatie
Met deze drie heb je volgens mij de documentatie al beter voor elkaar dan 95% van de (maatwerk)systemen waar ik mee werk, maar zorg in ieder geval voor een soort 'troubleshooting FAQ', dit kan eventueel bij de installatiehandleiding. Maar misschien nog handiger is om een support-site in te richten en deze goed bij te houden.
Ik vind het zelf altijd wel prettig als ik zie dat men nog actief met de applicatie bezig is, en andersom zakt mij soms de moed in de schoenen als ik op een support site kom en ik zie dat de laatste release een bugfix is van drie jaar geleden is en de site 2 jaar niet is bijgewerkt.
Just my 2 cents :-)
Plaats een
- + Advertentie
- + Onderwerp
Marktplaats
Webmasterforum
- Websites algemeen
- Sitechecks
- Marketing
- Domeinen algemeen
- Waardebepaling
- CMS
- Wordpress
- Joomla
- Magento
- Google algemeen
- SEO
- Analytics
- Adsense
- Adwords
- HTML / XHTML
- CSS
- Programmeren
- PHP
- Javascript
- JQuery
- MySQL
- Ondernemen algemeen
- Belastingen
- Juridisch
- Grafisch ontwerp
- Hosting Algemeen
- Hardware Info
- Offtopic