De waarde van het toevoegen van afbeeldingen aan de technische documentatie
Het is clichÃÆ'Ã,  ©, maar waar-een foto heeft meer dan duizend woorden schilderen. Dit is een belangrijke boodschap te onthouden bij het schrijven van elke vorm van documentatie, zoals een installatie handleiding of een gebruiksaanwijzing. Een document dat van verstandig gebruik van beelden en schema's zal veel gemakkelijker te begrijpen dan een die geheel uit tekst bestaat maakt descriptions.I waargenomen deze eerste hand jaar geleden, toen een junior programmeur bij een onderneming werd gevraagd om actualisering van de software-installatie handleiding voor hun machine controllers. Een van de eerste dingen die hij deed was om weg te strippen alle schermopname beelden, waardoor het hele document naar platte tekst. "Deze beelden zijn gewoon dom!" zei hij. "Ze nemen de ruimte, en ze zijn gewoon niet nodig. Ik hoop dat iedereen die dit leest document zal worden slim genoeg om uit het uit." Dit bleek een enorme vergissing. De technici die gebruik moest maken van de handleiding had een moeilijke tijd om gevoel van de instructies. Ze moesten herhaaldelijk vragen om verduidelijking, en een van hen vertelde me dat de pure tekst beschrijvingen waren gewoon te omslachtig om te volgen. Ze waren bang voor het gebruik van deze instructies op alle, wetende dat een enkele misstap de controllers kan sluis in een oninbaar staat. Het was een lelijke situatie alle around.The probleem was dat deze programmeur niet proberen om dingen makkelijk voor de gebruikers. Voor een ding, slaagde hij er niet aan te nemen dat sommige technici waren niet Engels als moedertaal, en dat ze zouden kunnen worstelen met de formulering. Belangrijker nog is dat deze programmeur te veel van zijn publiek verwacht. Hij wilde deze instructies te beperken tot hun naakte essentie, denkend dat toereikend zou zijn. Hij niet van mening dat zelfs een intelligent, anders zorgvuldige lezer verleiding kunnen komen om over heen te springen instructies, of zou verdoezelen enkele kritische details. Dit is een veelvoorkomende valkuil wanneer de tijd is kort, en als de gebruikers worden geconfronteerd met pagina's en pagina's van bland text.A paar zorgvuldig gekozen beelden, met geschikte bijschriften, kan een lange weg te gaan naar het voorkomen van dat. Toen ik zag dat de junior programmeur was strippen weg al de screen capture beelden, ik waarschuwde hem tegen. "Deze beelden niet strikt noodzakelijk zijn, 'zei ik,' maar ze helpen te verduidelijken veel details. Voor een ding, laten ze de gebruiker precies welke knop te duwen, of die venster om te selecteren. Dit maakt de instructies veel gemakkelijker te begrijpen, en vermindert de waarschijnlijkheid van een menselijke fout. "Tot op de dag, ik wil dat hij mijn warning.Were de gebruikers intelligent genoeg om de handleiding, te begrijpen was opgevolgd als hij beweerde? Zeker, maar intelligentie is geen garantie tegen menselijke fouten. Kan de afbeeldingen zijn opgevat als praten tot de gebruiker? Misschien, maar in mijn ervaring, geavanceerde gebruikers zelden reageren op die manier. Integendeel, de meeste van hen lijken te begrijpen de waarde die deze beelden brengen naar de tafel. Misschien is het omdat de meeste van hen weten hoe het is om te frazzled en geperst voor tijd, en hoe gemakkelijk belangrijke details kunnen verloren in de text.So herinneren-een foto zegt meer dan duizend woorden, en een screen capture kan worden meer waard dan een dozijn pagina's tekst. Het is een les die de moeite waard learning.V. Berba Velasco heeft een doctoraat in de Elektrotechniek en is het beoefenen van zijn vak voor bijna een decennium. Gedurende die tijd heeft hij herhaaldelijk vastgesteld dat een goede technische schrijfvaardigheid bijna zo belangrijk als goede technische vaardigheden. Dr Velasco werkt momenteel als senior software engineer elektrische en voor Cellulaire Technology Limited (http://www.immunospot.com), een biotechbedrijf in Cleveland, Ohio.
Artikel Bron: Messaggiamo.Com
Related:
» Credit Secrets Bible» Cash Making Power Sites
» Home Cash Course
» Automated Cash Formula
Webmaster krijgen html code
Voeg dit artikel aan uw website!
Webmaster verzenden van artikelen
Geen registratie vereist! Vul het formulier in en uw artikel is in de Messaggiamo.Com Directory!
