De horizontale standaard IEC/IEEE 82079-1 voor gebruikershandleidingen kreeg een update! Zorg dat ook jouw handleidingen hieraan voldoen!
03/06/2020 - 10:08
Of je nu software of machines produceert, je gebruikershandleiding of webhelp en de ontwikkeling ervan moet met de nieuwe update aan heel wat extra vereisten voldoen. Wij zochten voor u uit wat de verschillen zijn met de vorige editie. We implementeerden ze in onze workflow én in die van onze klanten die op hun beurt hun klanten een veilig en kwaliteitsvol product willen afleveren dat voldoet aan de nieuwe regelgeving.
Voor wie?
Aangezien het over een horizontale standaard gaat, is hij geldig voor alle handleidingen. Dus zowel voor de gebruikershandleiding voor software als die voor machines!
Wat zijn de verschillen met de vorige editie?
Er wordt nu voor het eerst melding gemaakt van de toe te passen informatietypes: concepten, taken en referenties. Je handleiding moet nu ook aan volgende extra kwaliteitseisen voldoen:
- minimalisme: enkel tonen van relevante informatie, inclusief het veilig gebruik van het product, beveiliging van de informatie en de privacy van de gecreëerde of opgeslagen informatie
- beknoptheid qua inhoud en presentatie: bondige formulering, tekst en illustraties zonder overbodige details, …
- scheiding van inhoud en lay-out
Niets nieuws onder de zon voor dus voor DocWriter: dit zijn al jaren de fundamenten van elke handleiding die we schrijven met onze DITA-software. Gebruikershandleidingen moet worden ontwikkeld, geproduceerd en ondersteund met behulp van gedefinieerde, herhaalbare informatieprocessen zodat planning, implementatie, controle, corrigeren en verbeteren vergemakkelijkt wordt:
- goed inplannen van ervaren technische schrijvers
- kwaliteitsbeheer en -borging
- single-source informatiebeheer om inconsistenties discrepanties te verminderen
Informatie-inhoud moet worden bewaard voor hergebruik gedurende de hele levenscyclus van het product en aanpasbaar zijn voor vergelijkbare producten en toekomstige versies.
Bij verschillende van onze klanten integreerden we deze procesprincipes al in hun eigen workflow, bijvoorbeeld in samenwerkingstools zoals Confluence en Jira of in kennisdatabanken zoals die van ServiceNow. We kunnen ook zelf ondersteuning bieden bij het beheren van de documentatie, zoals het versie-, review- en vertaalbeheer.
