Interne, externe, product-, proces-, technische en gebruikersdocumentatie

Heeft u altijd al verduidelijking nodig gehad met veel termen die naar verschillende soorten documentatie verwijzen? Kijk eens naar de volgende vragen.

Wat betekenen handleiding en gebruikersdocumentatie? Wat is een gebruikershandleiding? Wordt het schrijven van een gebruikershandleiding beschouwd als technische documentatie? Wat zijn de verschillen tussen een trainingshandleiding en een instructiehandleiding? Externe en interne documentatie? Product- en procesdocumentatie?

Hier zullen we al deze gerelateerde termen classificeren en definiëren op een manier die het meest logisch is, zodat u leert hoe ze op elkaar lijken of verschillen. Documentatietermen kunnen echter door elkaar worden gebruikt; We zullen ze ook dekken. Laten we beginnen met het definiëren van de meest algemene term in dit onderwerp:

Documentatie

Documentatie is communiceerbaar materiaal dat formeel informatie verschaft voor introductie, beschrijving, training en instructie met betrekking tot een systeem, product, dienst, organisatie, procedure of technisch proces. In veel gevallen worden deze formele en informatieve documenten ook wel handleidingen genoemd.

Laten we naar het volgende niveau gaan.

Bij het bespreken van een product of dienst kan een goede classificatie documentatie of handleidingen in twee hoofdgroepen verdelen; Technische documentatie en gebruikersdocumentatie . Een andere categorie kan documenten opdelen in Productdocumentatie en Procesdocumentatie, vergelijkbaar met de eerste categorie. Een andere redelijke methode om documentatie te classificeren, vooral als het gaat om organisatorische instellingen, is het organiseren van documentatie op basis van intern of extern.

We bespreken ze allemaal en beginnen met de breedste.

Externe documentatie

Zoals u uit de naam kunt afleiden, is externe documentatie bedoeld om te worden gedeeld met mensen buiten een organisatie (bedrijf, bedrijfseenheid, enz.) om informatie en handleidingen te bieden over een product of dienst. Daarom zou externe documentatie ook Productdocumentatie kunnen worden genoemd. De externe/productdocumentatie van een bedrijf kan worden onderverdeeld in gebruikersdocumentatie en systeemdocumentatie .

A. Gebruikersdocumentatie

Gebruikersdocumentatie, ook wel eindgebruikersdocumentatie genoemd, is bedoeld voor eindgebruikers om uitgebreide informatie over een product of dienst te verstrekken. Documenten in deze groep worden ook wel Gebruikersondersteuning genoemd. Hun primaire doel is om de gebruikers te helpen met nuttige informatie over een product, zoals een algemene introductie, een beschrijving van de functies ervan en instructies voor de installatie, het gebruik en het onderhoud ervan.

Handleidingen in deze groep leren onderwerpen door middel van een technische uitleg. Maar aangezien het doel eindgebruikers zijn, moeten zij gedetailleerde technische informatie beperken en eenvoudige taal gebruiken met standaardtermen en -uitdrukkingen in plaats van technisch jargon. Daarom bieden ze gebruiksvriendelijke handleidingen en stapsgewijze instructies voor praktisch gebruik. Hoewel gebruikersdocumentatie het domein is van een technisch schrijver (iemand die de technische informatie gebruikt, begrijpt en vertaalt in kortere en eenvoudigere inhoud voor de eindgebruikers), wordt het dus niet altijd als technische documentatie beschouwd. Omdat ze zich doorgaans niet op experts en professionele mensen richten. We bespreken de technische documentatie verderop in dit artikel.

Laten we verschillende vormen van gebruikersdocumentatie bekijken:

• Installatie- en configuratiehandleiding
  • De installatie- en configuratiehandleiding bevat gedetailleerde informatie over het installeren, instellen en starten van een product.
• Handleiding
  • Een handleiding die de gebruikers instrueert hoe ze het product op de juiste manier kunnen gebruiken.
• Handmatig problemen oplossen

  • Een handleiding waarin wordt beschreven hoe u veelvoorkomende problemen met het product kunt oplossen.

• Handleiding
  • Een typische gebruikershandleiding bevat vaak alle bovengenoemde handleidingen op één plek. Gebruikershandleidingen zijn gericht op verschillende gebruikers, zowel geschoold als ongeschoold, en geven instructies over de installatie, bediening en onderhoud van het product. Ze introduceren het product bij de gebruikers en schetsen de standaardfunctionaliteit en de verschillende kenmerken en toepassingen ervan. Ze bevatten meestal voorzorgsmaatregelen met betrekking tot het gebruik van het product en kunnen ook algemene veelgestelde vragen en probleemoplossing bevatten.

B. Systeemdocumentatie

Systeemdocumentatie kan de vorm hebben van een servicehandleiding of een reparatiehandleiding . Systeemdocumentatie bevat een overzicht van de onderliggende systemen, meer gedetailleerde technische informatie en reparatie-instructies om monteurs, ingenieurs en andere geavanceerde gebruikers te helpen het product te repareren.

Interne documentatie

Het is niet de bedoeling dat interne documentatie extern wordt gedeeld. Het bevat technische details en organisatorisch beleid, procedures, enz., die onnodig of productief zijn voor gebruikers. Over het algemeen fungeren documenten in deze groep als referentie voor werknemers, technische teams, managers of ander kantoorpersoneel, zodat ze hun werk efficiënter kunnen uitvoeren. Zoals hierboven vermeld, kan interne documentatie worden onderverdeeld in technische/procesdocumentatie en organisatie-ondersteunende documentatie .

A. Technische documentatie

Wanneer we de term technische documentatie gebruiken, bedoelen we die interne documenten die voornamelijk onder het technische team van een organisatie worden verspreid. Ze behandelen onderwerpen als testplannen, ontwikkelprocessen, ontwerpspecificaties, projectplannen, onderhoud en verbetering van het systeem, etc. en veel technische termen. De term Procesdocumentatie verwijst vrijwel naar hetzelfde soort documenten. Technische documentatie en procesdocumentatie kunnen door elkaar worden gebruikt.

B. Organisatie-ondersteunende documentatie

In elke organisatie zijn er verschillende handleidingen en documentatie voor het trainen van medewerkers en het definiëren van interne organisatorische richtlijnen, en de meeste van deze documenten bevinden zich op het gebied van HR . Laten we enkele van de meest voorkomende handleidinggerelateerde termen bespreken die u in een organisatie tegenkomt:

1. Bedieningshandleiding:

Deze handleiding bevat normen en richtlijnen van een bedrijf waarin wordt uiteengezet wat en hoe er moet worden gedaan. Daarom helpt het het personeel hun werk correcter en efficiënter uit te voeren, vooral met betrekking tot de kwaliteit en veiligheid van goederen en diensten.

2. Handleiding voor crisisbeheersing:

Het is een handleiding om werknemers te instrueren hoe ze moeten reageren op crises op de werkplek.

3. Audithandleiding:

Het beschrijft het auditbeleid en de auditprocedures van een bedrijf.

4. Trainingshandleiding:

Een trainingshandleiding is in de eerste plaats bedoeld om de uitgevoerde taken te verbeteren en kan instructies bevatten voor het trainen van medewerkers. Trainingshandleidingen kunnen worden gebruikt als naslagwerken voor zowel beginners als bekende/ervaren medewerkers.

5. Beleidshandleiding:

Een beleidshandleiding of een beleids- en procedurehandleiding is doorgaans een goed naslagwerk voor managers en supervisors om hen te helpen bij het nemen van beslissingen en het effectief runnen van het bedrijf. Het bevat alle bedrijfsrichtlijnen, regels en beleid, evenals de exacte procedures om dit beleid en deze normen te volgen.

6. Organisatiehandleiding:

Het definieert de organisatiestructuur en omvat alle informatie over de posities, taken, plichten, functiebeschrijvingen, verantwoordelijkheden, relaties en hiërarchieën van een organisatie. Het helpt werknemers dus om hun functie beter te leren kennen en uit te voeren.

Gidsen

Wat is nu een gids?

Vergeleken met de handleidingstermen die we hebben besproken, is een gids een algemenere term, die verwijst naar elke handleiding met handleidingen en hulp. Een handleiding gaat niet noodzakelijkerwijs over het gebruik van een product. Een gebruikershandleiding hoeft niet allesomvattend te zijn en kan zo eenvoudig zijn als een kaartje, waarin gebruikers nuttige instructies krijgen.  

Conclusie

Documentatie van een organisatie kan op verschillende manieren worden onderverdeeld. Eén methode is om te beslissen welke documenten extern worden gedeeld en welke niet. Gedetailleerde technische en bedrijfsbeleidslijnen en -procedures zijn niet bedoeld om onder buitenstaanders te worden verspreid. Aan de andere kant kunnen systeem- en gebruikersdocumentatie gebruikers helpen om, indien nodig, meer te weten te komen over het product van een bedrijf. Laten we dus een kort overzicht geven van de belangrijkste punten:

Gebruikersdocumentatie bestaat hoofdzakelijk uit het volgende:

• Handleiding
• Installatie handleiding
• Handmatig problemen oplossen
• Handleiding

Het doel van de gebruikersdocumentatie is:

Help gebruikers meer te leren over een product en hoe ze:

• Installeren
• Bedienen
• Problemen oplossen
• Houd gebruikers uit de buurt van mogelijk gevaar

Technische documentatie heeft voornamelijk betrekking op:

• Testplannen
• Technische ontwerpspecificatie
• Projectplannen

Het doel van de technische documentatie is:

Houd gegevens bij van het technische proces en de onboarding-technici van een organisatie voor:

• ontwikkeling
• Testen
• Onderhoud
• Verbetering