De top vijf fouten die bedrijven maken met betrekking tot technische documentatie
Ik heb het gezien de tijd en weer. Een van de meest voorkomende zwakke punten die ik heb gezien in de engineering-bedrijven inderdaad, een bijna universeel-fout is het ontbreken van de juiste technische documentatie. Sommigen zouden lachen dit af als een klein detail, maar de gevolgen vaak ernstig zijn. Hele toekomst van een onderneming kan worden gemaakt of verloren op basis van de hoeveelheid aandacht die zij besteden aan dit issue.Over de jaren heb ik werden vijf problemen die ik heb gevonden bijzonder gebruikelijk als het gaat om het schrijven van technische documentatie. Ik zou willen delen deze gedachten met u, in de hoop te voorkomen dat anderen vallen dezelfde paths.1. Niet met een gebruiker manualsDon't lachen. Dit lijkt misschien een vrij fundamentele fout-absurd, zelfs-maar het is verrassend vaak voor. Ik heb veel bedrijven die geen handleidingen te bieden voor hun producten, of waarvan de handleidingen zijn aangetroffen skelet dun of jaren verouderd. In feite zou ik schatten dat ongeveer de helft van de kleine engineering bedrijven die ik heb ondervonden vallen in deze categorie. (Natuurlijk stuit dit zelden een probleem bij het kopen off-the-shelf software of consumentenelektronica. Onder ingenieurs al is het een deprimerend bekend verhaal.) Ik herinner me hoe een ingenieur vertelde me waarom zijn bedrijf niet geven alle gebruiksaanwijzingen bij hun producten. In gedempte toon, zei hij: "Het is omdat we geen geld te verdienen door het schrijven van handleidingen. Het is niet een geld-making venture, zodat onze management wil geen tijd verspillen aan dit." Een geërgerd uitdrukking kroop in zijn gezicht, toen hij leunde dichter en zei: "We hebben zo veel klanten verloren omdat we geen fatsoenlijke documentatie. Overleg over het feit dat penny-wise, pound-dwaas!" Het is niet alleen de klanten die te lijden hebben wanneer handleidingen zijn onvoldoende of non-existent. Hoe zit het met de werknemers zelf? Wat gebeurt er wanneer een nieuwe ingenieur komt aan boord, en is snel te leren? Of wat er gebeurt wanneer de bestaande ingenieurs moeten vertrouwd zich meer met onbekende aspecten van hun product lijnen? De gebruiker documentatie, indien goed geschreven, kan zorgen voor een zachte en efficiënte manier om het op snelheid. Zonder dat zullen ze gedwongen worden een beroep te doen zwaarder op andere technici op te voeden hen, waardoor verspillen de tijd van alle betrokkenen. Weken, zo niet maanden, van waardevolle arbeidskrachten kan worden verspild in deze fashion.2. Niet met een goede interne documentationIt's niet alleen de gebruiker documentatie die bedrijven te kort op. Interne documentatie is vaak een ongeval zo goed, als bedrijven klauteren om een product vrij te laten. In hun haast om producten de markt te brengen, bedrijven vaak laten hun interne ontwerp-documenten vallen hopeloos door de wayside.It helpt niet dat programmeurs en ingenieurs zijn berucht voor het feit dat glansloos communicatieve vaardigheden, documentatie en dat is een taak die zelden genieten. Ik heb ondervonden veel software bedrijven, bijvoorbeeld, wiens software ontwerpen waren een hardnekkig puinhoop vanwege hun gebrek aan architectonische documenten, interface beschrijvingen en in-code commentaar. Helaas, ik heb dezelfde problemen als het gaat om mechanische ontwerpen, elektronische ontwerpen, fabricage procedures? je naam ve it.I 'gesproken ingenieurs waarvan de bedrijven hebben, hetzij onder gegaan, of zijn wankelen op het randje. Bijna altijd is het ontbreken van adequate documentatie is een belangrijke factor in deze situations.I altijd zeg tegen mijn bazen en collega's, "Ik wil ervoor zorgen dat mijn werk gestopte is goed gedocumenteerd. Als ik het bedrijf verlaten, of als ik sterven in een auto-ongeluk, want ik wil ervoor zorgen dat dit bedrijf kan mars op zonder mij. "Dat moet een van de belangrijkste redenen achter te houden grondige documentatie-om ervoor te zorgen dat het bedrijf zal niet worden gefnuikt door een persoon absence.Unfortunately veel werknemers de tegenovergestelde tack. Ze opzet karig op de documentatie, denken dat dit ervoor kan zorgen dat sommige werkzekerheid-en soms, dit werkt. Echter, een slimme werkgever weet dat een ingenieur die documenten zeer de moeite waard is veel meer dan een ingenieur die houdt zijn kaarten dicht bij zijn vest. Dit laatste kan van essentieel belang op de korte termijn, maar uiteindelijk, hij is een lange-termijn liability.3. AudienceThis probleem Forgetting je komt vaak bij het ontwikkelen van gebruikersdocumentatie. Programmeurs en ingenieurs vaak vergeten dat hun handleidingen zullen worden gelezen door mensen die onbekend zijn met hun producten, of die niet over dezelfde technische vaardigheden. Ik herinner me een onderneming in het bijzonder-een machine controller bedrijf op de westkust. Hun "handleiding" was een verschrikkelijk ratjetoe van acroniemen, ongedefinieerde termen en schijnbaar willekeurige gedachten, met ongeveer een dozijn procedures opgesomd in willekeurige volgorde. Hun documentatie ontbrak dergelijke fundamentele gegevens hoe te beginnen met het controller omhoog of hoe het te stoppen in het geval van een nood-kritische details die een neofiet gebruiker moet verwachten in een handleiding in verband probleem is het gebrek aan correcte taal te gebruiken. Beschouw het geval dat veel van de lezers niet Engels als moedertaal-zeggen wanneer de marketing van een product in Europa of Azië, of bij het schrijven van procedures voor de montage in het buitenland geboren fabrieksarbeiders. In dergelijke gevallen kan het nodig zijn om de te houden taal vrij eenvoudig. Indien dit niet mogelijk, bijvoorbeeld bij de bespreking van complexe details dat de vraag veel van precisie-een vaak kunnen compenseren door het toevoegen van een aantal treffend gekozen grafieken, diagrammen of foto's. Een van beide aanpak kan nuttig zijn bij het maken van complexe tekst een beetje makkelijker te absorb.4. Niet voldoende graphicIt ontegenzeggelijk clichÃÆ'Ã,  ©, maar waar toch-een foto heeft meer dan duizend woorden schilderen. Ook een handboek dat verstandig gebruik van beelden en schema's zal veel gemakkelijker te begrijpen dan een die geheel van de tekst descriptions.Some bestaat dit beschouwen als kinderachtig en onnodig maakt. Ik niet, en mijn ervaring is gebleken dat de meerderheid van de gebruikers waarderen met deze visuele gidsen. Vergeet; ongeacht hoe geavanceerd je lezers zijn, ze nog steeds de mens bent. Zelfs een intelligente, anders zorgvuldige lezer kan per ongeluk een aantal belangrijke details, vooral wanneer ingedrukt time.5. Niet streven naar excellenceIt is interessant om te zien hoe de programmeurs en ingenieurs kunnen streven naar uitmuntendheid in veel aspecten van hun werk, maar toch nemen precies het tegenovergestelde aanpak als het gaat om documentatie. "Who cares about formulering eigenlijk?" Ik heb gehoord dat veel ingenieurs zeggen. "We zijn het schrijven van poëzie of scenario's hier. Waar het om gaat is dat de documentatie moet technisch nauwkeurig zijn. "Dit is een ontzettend kortzichtig bekijken. Technische nauwkeurigheid is inderdaad belangrijk, maar zo zijn presentatie en stijl. weinig ingenieurs zou luisteren naar een sollicitant die toont in een badjas en slippers, of een advocaat geschillen die spreekt als een vallei meisje en toch een of andere manier, deze zelfde technici verwachten dat hun collega-techneuten (of erger nog, een klant!) slog om door de pagina's van meanderende, slecht geformuleerd tekst. Zelfs zaken als fundamenteel als spelling, grammatica en proeflezen worden vaak behandeld als louter ergernissen-onbenullig details die de moeite waard zijn niets meer dan een vluchtige blik. (Tot mijn opluchting, heb ik niet ondervonden dergelijke houding op mijn plaats van tewerkstelling. Ik haast me om dit te zeggen, opdat iedereen denk dat ik klagen over de mensen die ik werk! Nee, ik heb geconstateerd dat we allemaal waarderen de waarde van excellentie, waarvoor ik ben altijd dankbaar. Maar ik dwaal af.) Let op: Bij het schrijven voor zijn collega-techneuten, moet men rekening mee houden dat ze vaak moeten absorberen omvangrijke hoeveelheden informatie in geringe hoeveelheden van de tijd. Wanneer schrijven voor leken, moet men de tekst zo zacht en gemakkelijk te verteren mogelijk, opdat ze verloren in een oceaan van geekspeak. Hoe dan ook, waardoor een beetje extra inspanning in het gebied van elegantie en stijl kan een wereld van difference.I zal niet in detail treden over wat goed schrijven techniek, als dat zou buiten het bestek van deze tekst. Het volstaat te zeggen dat een goede programmeur of ingenieur moet ervoor zorgen dat zijn geschriften is leesbaar en goed georganiseerd, en dat het stroomt soepel van het ene onderwerp naar another.I zou zijn enthousiast niet te geloven als ik nooit een ander slordig handleiding, of als ik nog nooit van gehoord een ander verhaal over zagen bedrijven instorten als gevolg van niet-bestaande documentatie. Een hopeloze fantasie? Misschien. Toch hoop ik dat sommige techneuten daar wordt dit bericht leest, en dat ze zullen nemen aan de AuthorV heart.About. Berba Velasco heeft een doctoraat in de Elektrotechniek en is varen zijn handel bijna een decennium. Gedurende die tijd heeft hij herhaaldelijk ontdekte het belang van goed technisch schrijven, en de valkuilen die kunnen optreden uit negeren haar value.Dr. Velasco werkt momenteel als senior software engineer elektrische en voor Cellulaire Technology Limited (http://www.immunospot.com, http://www.elispot-analyzers.de), een biotechbedrijf in Cleveland,
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!
