Documentatie PDF Afdrukken E-mail
Maandag 08 Januari 2007 17:18

ICT Rendement;NR 1/2 JANUARI/FEBRUARI 2005

documentatieAls het loopt dan loopt het totdat... iemand anders het werk moet doen. Zoals bijvoorbeeld het overzenden of inlezen van data, het maken van een specifieke rapportage, het uitvoeren van werk dat Pietje altijd deed maar Pietje is ziek en dat kan nog wel even duren. Vaak komt er in deze situaties niet veel meer boven water dan een paar kladjes met aantekeningen hoe het moet. Hieronder enkele nuttige tips deels uit ICT rendement en tips van mij (WB: QIB)

Hoe te documenteren:

  • Stel alles overzichtelijk samen.
  • plus eventueel noodprocedures, noodtelefoonnummers van medewerkers/organisaties, leveranciers, helpdesks , en dergelijke
  • Schrijf in begrijpelijk taal,actiegericht en leg alles duidelijk uit
  • voorkom technische taal en stem af op de lezer.
  • Sluit in de beschrijving van het bedoelde gebruik ook het onbedoelde gebruik uit.
  • Gebruik Stijldocumenten of sjablonen.
  • voor herkenbaarheid en leesbaarheid
  • gebruik hulpmiddelen van de tekstverwerker zoals indez en inhoudsopgave om de documentatie te onsluiten
  • Gebruik zoveel mogelijk grafische voorstellingen
  • flow-charts, grafieken, figuren etc. maken dingen duidelijker en prettiger leesbaar. Overdrijf niet!
  • Bepaal doelgroep van de handleiding/documentatie en richt de documentatie hierop in. Maak indien nodig een technische - en een gebruikershandleiding.

en als adviseur van mij (wim bartol) nog enkele adviezen:

  • Zorg voor versie beheer van het document. Met andere woorden als er aanpassingen zijn aan het product en/of dienst en de handleiding wordt aangepast. Maak een nieuw document en geef aan wat de verschillen zijn met de vorige versie. Geef de versie een nummer en een datum of andersom
  • Maak documentatie toegankelijk bijvoorbeeld door gebruik te maken van een document management systeem. Dit hoort ingewikkelder dan het werkelijk is. Je kunt hiervoor een Content Management Systeem gebruiken waarin je alle documentatie beschikbaar stelt via webpagina's. Andere documenten die gemaakt zijn ms-excell, powerpoint o.id. kun je hierin ook opslaan.

Voor een tweetal klanten gebruik ik hiervoor het CMS Joomla. Naast de praktische toegankelijkheid biedt het ook de mogelijkheid om externen (en externe medewerkers) toegang te geven tot documentatie en/of handleidingen. Verder kun je extra's in deze website opnemen zoals de mogelijkheid om commentaar te geven op de documentatie , vragenlijsten op te nemen en mensen de verantwoordelijkheid te geven de voor hun noodzakelijke documentatie te onderhouden.

 

Willekeurig Artikel

  • Drukke manager Laat je eens verrassen door de metafoor over de hoofdmier.
    Lees meer...
  • calimero.jpgKaren Romme schreef met Calimeromarketing een boek voor het mkb. Oftwel zonder geld toch aandacht voor je product of dienst krijgen.

    Lees meer...
  • Foppe de Haan was jarenlang trainer van profvoetbalclub SC Heerenveen. Met deze club behaalde hij successen. Eigenlijk mag je wel zeggen grote successen. Hij (hij zou zeggen WIJ) bracht de club naar de ere divisie en inmiddels is er zelfs een keer champions League voetbal gespeeld.

    Gisteravond (Di 14 Oktober 2004) mocht ik vanuit de Bedrijven Vereniging Leek visie horen op voetbal en (voetbal) mensen in het bijzonder tijdens een sessie te Grootegast. Zeer genoten heb ik van de prachtige verhalen over de gebeurtenissen in en om het voetbal. Hieronder de reactie die ik naar aanleiding van de presentatie aan Foppe heb gestuurd.

    Frappant vond ik de parallel die u naar voren bracht inzake het omgaan en voorbeelden stellen naar spelers. U gaf onder andere het voorbeeld van Romano Denneboom inzake het opruimen van zijn kleding na de training, het respectvol omgaan met medespelers/tegenstanders ('bij een elleboog door een van mijn spelers gaat hij 3 week op de bank'; ongeacht of de scheidsrechter dit wel of niet heeft gezien).

    Onderwijl naar u luisterend herkende ik een mooie parallel die ik natijd nog aan u heb verteld. Het betreft hier de logische niveaus (ook wel piramide van Dilts genoemd). Het is een techniek die tegenwoordig als onderdeel van de NLP wordt gezien en ook wordt getraind.

    Lees meer...
  • ICT Rendement;NR 1/2 JANUARI/FEBRUARI 2005

    documentatieAls het loopt dan loopt het totdat... iemand anders het werk moet doen. Zoals bijvoorbeeld het overzenden of inlezen van data, het maken van een specifieke rapportage, het uitvoeren van werk dat Pietje altijd deed maar Pietje is ziek en dat kan nog wel even duren. Vaak komt er in deze situaties niet veel meer boven water dan een paar kladjes met aantekeningen hoe het moet. Hieronder enkele nuttige tips deels uit ICT rendement en tips van mij (WB: QIB)

    Lees meer...
  • Bloed is dikker dan water
    De afgelopen 2 jaar heb ik regelmatig contact gehad met familiebedrijven. Altijd is dit iets bijzonders metname de betrokkenheid van de familie bij het bedrijf is vaak ontroerend. Echter ook vaak de angel van moeilijkheden.

    Daarom met behulp van Garry Robinson en zijn serie " I' ll show them who is the boss" en mijn eigen ervaringen hieronder wat typeringen die bij mensen die werken in een familiebedrijf toch echt herkenbaar moeten zijn. Doe er iets goeds mee!




    Lees meer...

JOBCoaching hoe gaat dat?

hands.png

Tja, vaak krijgt coaching geen handjes en voetjes daarom geef ik hier in het kort mijn benadering, de werkwijze, privacy, locatie aspecten en een kosten/doorlooptijd indicatie aan.
lees

Tools

Kwaliteitszorg

kwaliteitssysteem voor HDRT Hits - 1401
Blik op Werk Hits - 1793
ISO plus Hits - 3686

Metaforen