Deze website maakt gebruik van cookies. Klik hier voor meer informatie.

Artikelen

Artikel afbeelding

Software documentatie

Uitleg van uw software-product

Software documentatie wordt gebruikt bij alle software-producten, van traditionele handleidingen op papier tot contextgevoelige onlinehelpsystemen, voor alle typen gebruikers – onervaren eindgebruikers, applicatiebeheerders, functionele specialisten en technisch architecten.

Technisch schrijvers

Technisch schrijvers die technische documentatie schrijven bij machines, apparaten en gereedschappen zijn nogal eens specialisten die een achtergrond hebben in de techniek; ze hebben zelf een technische opleiding afgerond – werktuigbouw, elektrotechniek, … – en zijn daarna in de wereld van technisch schrijven terecht gekomen.

Software schrijvers

Schrijvers van software documentatie hebben doorgaans een veel gevarieerder en nogal eens minder technische achtergrond; ze komen van alle opleidingsrichtingen: biologie, psychologie, medicijnen, talen, communicatiewetenschappen, …. Niet zo vreemd wanneer je bedenkt dat software overal en door iedereen wordt gebruikt en inmiddels tot in alle sectoren en lagen van de bevolking is doorgedrongen!

Afhankelijk van de software die u ontwikkelt of in de markt zet, zorgen wij voor de juiste specialist, die volwaardig gesprekspartner is voor uw ontwikkelaars en kan meepraten over technische zaken, zoals ontwerp en architectuur. Bovendien kan deze specialist functionele specificaties lezen en schrijven en stelt hij vooral ook de gebruiker van de software centraal, door doelgroepgerichte documentatie te verzorgen. Van structuur tot uiteindelijke realisatie; niet alleen tekstueel, maar ook in de juiste mix van beeld, visualisatie en tekst. Precies afgestemd op de behoefte van de gebruiker.

Documentatie

Wanneer we het hebben over documentatie, bedoelen we niet alleen het structureren en produceren. Onderhoud en beheer is ook van groot belang. Immers, u wilt er zeker van zijn dat bij een nieuwe versie van uw software de juiste documentatie wordt meegeleverd. Op papier of online, als contextgevoelige help, geïntegreerd in de software. Om dit te kunnen realiseren, beschikken gespecialiseerde schrijvers over diepgaande kennis van de meest gangbare tools en hulpmiddelen: XML-editors, software voor document en component content management, grafische pakketten (waarmee illustraties worden gemaakt) en software om schermen te integreren in technische en gebruikersdocumentatie. Zij kunnen u adviseren over de juiste keuze die past bij uw specifieke situatie.

Content Management

Wat is het belang van content management: het beheren van content, zodat hergebruik snel en eenvoudig te realiseren is. Dit betekent dat dezelfde informatie – tekst, illustratie, foto, tekening, video of film – in heel verschillende documenten kan worden toegepast. Om adequaat hergebruik te kunnen realiseren moet een technisch schrijver context-onafhankelijk kunnen schrijven. Vergelijk het maar met lego-blokjes: steeds dezelfde blokjes, waarmee heel verschillende huisjes kunnen worden gebouwd.

Zij kunnen – net als softwareontwikkelaars dat doen als ze software schrijven en samenstellen – object georiënteerd documenteren. Hierdoor bent u verzekerd van optimaal hergebruik: dezelfde content in documenten, specificaties, release notes, instructies, procedures en leercontent (e-learning). Komt de kwaliteit en consistentie ten goede en scheelt aanzienlijk in de kosten.

Op June 21, 2017


Ingediend door Triview Technical Communication

Amersfoortsestraat 124D, Soesterberg