Die oberen fünf Fehler, die Firmen hinsichtlich der technischen Unterlagen machen
Ich habe es oft gesehen. Eine der allgemeinsten Schwächen, die ich in Technik Firmen-in der Tat gesehen habe, ein fast Universal Störung-ist der Mangel an korrekten technischen Unterlagen. Einige würden dieses weg als kleines Detail lachen; jedoch sind die Rückwirkungen häufig streng. Die gesamte Zukunft einer Firma kann gebildet werden oder verloren werden gegründet worden auf der Menge von Aufmerksamkeit, die sie zu dieser Ausgabe zahlen.
Über den Jahren habe ich fünf Probleme gekennzeichnet, die ich gefunden habe, um besonders allgemein zu sein, wenn sie Schreiben zu den technischen Unterlagen kommt. Ich möchte diese Gedanken mit Ihnen, in der Hoffnung des Verhinderns teilen, daß andere hinunter die gleichen Wege fallen.
1. Keine Benutzerhandbücher haben
Lachen Sie nicht. Dieses kann wie ein ziemlich grundlegendes Fehler-absurdes scheinen, gleichmäßig-aber es ist überraschend Common. Ich habe viele Firmen angetroffen, die Benutzerhandbücher nicht für ihre Produkte zur Verfügung stellen oder deren Handbücher skeletally dünn oder die Jahre veraltet sind. Tatsächlich würde ich daß über Hälfte der kleinen Technikfirmen schätzen, denen ich Fall in diese Kategorie angetroffen habe. (selbstverständlich, trifft man selten dieses Problem an, wenn ab Lager Software oder Verbraucherelektronik gekauft wird. Unter Ingenieuren zwar, ist es eine erbärmlich vertraute Geschichte.)
Ich erinnere mich, an wie ein Ingenieur mir erklärte, warum seine Firma keine Benutzerhandbücher mit ihren Produkten versah. In beruhigten Tönen,sagte er, "es ist, weil wir kein Geld verdienen, indem wir Handbücher schreiben. Es ist nicht ein Geldverdienenwagnis, also möchte unser Management nicht Zeit auf diesem vergeuden." Ein gestörter Ausdruck kroch in sein Gesicht, dann lehnte er genaueres und besagt, "wir haben so viele Kunden verloren, weil wir nicht annehmbare Unterlagen haben. Sprechen Sie über Sein Penny-klug, zerstoßen-foolish!"
Es ist nicht die Kunden gerecht, die leiden, wenn Handbücher unzulänglich oder nicht vorhanden sind. Was über die Angestellten selbst? Was geschieht, wenn ein neuer Ingenieur an Bord kommt, und muß schnell erlernen? Oder was geschieht, wenn vorhandene Ingenieure sich mit nicht vertrauten Aspekten ihrer Produktserien mehr vertraut machen müssen? Die Benutzerunterlagen, wenn sie richtig geschrieben werden, können eine leichte und leistungsfähige Weise von die Geschwindigkeit bis holen zur Verfügung stellen. Ohne es werden sie gezwungen, um auf anderen Ingenieuren schwerer zu beruhen, um sie zu erziehen und so vergeuden die Zeit von betroffenem jeder. Wochen, wenn nicht Monate, der wertvollen menschlicher Arbeitskraft auf diese Weise verschwendet werden können.
2. Korrekte interne Unterlagen nicht haben
Es ist nicht die Benutzerunterlagen gerecht, denen Firmen auf unterschreiten. Interne Unterlagen sind häufig ein Unfall außerdem, da Firmen kriechen, um ein Produkt freizugeben. In ihre Eile, zum der Produkte zum Markt zu holen, lassen Firmen häufig ihre internen Designdokumente durch das wayside hoffnungslos fallen.
Es hilft nicht, daß Programmierer und Ingenieure für Haben der glanzlosen Kommunikation Fähigkeiten notorisch sind und daß Unterlagen eine Aufgabe sind, die sie selten genießen. Ich habe viele Software-Firmen z.B. angetroffen deren Software-Designs eine unlenksame Verwirrung wegen ihres Mangels an architektonischen Dokumenten, Schnittstelle Beschreibungen und Incode Anmerkungen waren. Traurig habe ich ähnliche Probleme, wenn er zu den mechanischen Designs kommt, elektronische Designs, Herstellungsverfahren gesehen? Sie nennen es.
Ich hatte mit Ingenieuren gesprochen deren Firmen entweder darunter gegangen sind, oder habe auf dem Rand geschaukelt. Fast unveränderlich, ist Mangel an ausreichenden Unterlagen ein Hauptfaktor in solchen Situationen gewesen.
Ich erkläre immer meine Chefs und Mitarbeiter, "ich möchte überprüfen, ob meine Arbeit gut dokumentierte gestopft wird. Wenn ich die Firma lasse oder wenn ich in einem Autounfall, denn in mir sterbe, möchten überprüfen, ob diese Firma ohne mich an marschieren kann." Der sollte einer der Hauptgründe hinter dem Halten sein vollständig Unterlage-zu überprüfen, ob die Firma nicht durch irgendeine Abwesenheit der Person verkrüppelt wird.
Leider nehmen viele Angestellte die gegenüberliegende Heftzwecke. Sie scrimp vorsätzlich auf den Unterlagen und denken, daß diese ihnen irgendeinen Job Sicherheit-und manchmal sicherstellt, diese, arbeiten. Jedoch weiß ein intelligenter Arbeitgeber, daß ein Ingenieur, der gut dokumentiert, weit mehr als ein anderer Ingenieur ist, der seine Karten nah an seiner Weste hält. Das letzte kann wesentlich kurzfristig sein, aber schließlich, ist er eine langfristige Verbindlichkeit.
3. Vergessen von von irgendjemandes Publikum
Dieses Problem tritt häufig auf, wenn es Benutzerunterlagen entwickelt. Programmierer und Ingenieure vergessen häufig, daß ihre Handbücher von den Leuten gelesen werden werden, die mit ihren Produkten nicht vertraut sind oder die nicht die gleichen technischen Fähigkeiten haben. Ich erinnere mich an eine Firma in der bestimmten-ein Maschine Steuerpultfirma auf der Westküste. Ihr "Benutzerhandbuch" war ein schrecklicher Hodge-podge der Akronyme, unbestimmte Bezeichnungen und scheinbar gelegentliche Gedanken, wenn ungefähr die Verfahren Dutzend in keinem bestimmten Auftrag verzeichnet sind. Ihre Benutzerunterlagen ermangelten solche grundlegende Details wie, wie man den Steuerpult oben beginnt oder wie man ihn im Fall von Dringlichkeit-kritische Details stoppt, die jeder möglicher Neophytbenutzer erwarten sollte, in einem Handbuch zu finden.
Ein in Verbindung stehendes Problem ist die Störung, korrekte Sprache zu verwenden. Betrachten Sie den Fall, in dem viele der Leser nicht gebürtiges Englisch Lautsprecher-sagen, wenn Marketing ein Produkt in Europa oder Asien sind, oder, wenn Versammlung Verfahren für foreign-born Arbeiter geschrieben werden. In solchen Fällen kann es notwendig sein, die Sprache ziemlich einfach zu halten. Wenn dieses nicht ist, möglich-sagen Sie, wenn Sie komplizierte Details besprechen, die viel Präzision-ein können häufig ausgleichen verlangen, indem sie einige passend-gewählte Diagramme, Diagramme oder Fotographien addieren. Jede Annäherung kann nützlich sein, wenn man komplizierten Text ein wenig einfacher aufzusaugen bildet.
4. Nicht seiend passend graphisch
Es ist unleugbar cliché, aber zutreffende nichtsdestoweniger-ein Abbildung malt tausend Wörter. Ähnlich ein Handbuch, das Marken vernünftiger Gebrauch von Bildern und Diagrammen viel einfacher ist, als eins zu verstehen, das völlig aus Textbeschreibungen besteht.
Einige betrachten dieses, childish und nicht notwendig zu sein. Ich nicht und meine Erfahrung hat gezeigt, daß die Mehrheit einen Benutzern Haben dieser ¢¢VISUAL GUIDE''-Testblätter schätzen. Erinnern Sie sich; egal wie verfeinert Ihren Lesern seien Sie, sind sie noch Mensch. Sogar kann ein intelligentes, andernfalls vorsichtiger Leser irgendein wichtiges Detail versehentlich vermissen, besonders wenn es für Zeit betätigt wird.
5. Bemühend nicht, um hervorragende Leistung
Es ist interessant, zu sehen, wie Programmierer und Ingenieure um hervorragende Leistung in vielen Aspekten ihrer Arbeit sich bemühen können, dennoch nimmt das genaue gegenüber von Annäherung, wenn sie zu den Unterlagen kommt. "wer sich interessiert für irgendwie abfassen?" Ich habe gehört, daß viele Ingenieure sagen. "wir schreiben nicht Poesie oder Drehbücher hier. Was ausmacht, ist, daß die Unterlagen technisch genau sein müssen."
Dieses ist eine entsetzlich kurzsichtige Ansicht. Technische Genauigkeit ist in der Tat wichtig, aber also sind Darstellung und Art. Wenige Ingenieure würden auf einen Jobbewerber, der oben in einem Bathrobe und in den Hefterzufuhren zeigt, oder einen Rechtsstreitrechtsanwalt, der wie eine Senke Mädchen-und dennoch irgendwie spricht, diese gleichen Ingenieure erwarten ihre Gefährtetechies hören (oder schlechter, ein Kunde!) slog durch Seiten des Schlängelns, schlecht ausgedrückter Text. Macht sogar so grundlegend aus, wie Rechtschreibung, Grammatik und das Korrekturlesen häufig als bloße Störung-herummachende Details, die nichts mehr sind, als ein flüchtiger flüchtiger Blick behandelt werden.
(zu meiner Entlastung, habe ich irgend solche Haltung nicht an meinem Beschäftigungsort angetroffen. Ich beeile, dieses zu sagen, aus Furcht daß jedermann denken, daß ich über die Leute mich beschwere, denen ich mit arbeite! Nr., habe ich gefunden, daß alle wir den Wert der hervorragender Leistung schätzen, für den ich immer dankbar bin. Aber ich schweife.) ab
Erinnern Sie sich: Beim Schreiben für irgendjemandes Gefährtetechies, sollte man bedenken, daß sie umfangreiche Mengen Informationen in den dürftigen Zeitmengen häufig aufsaugen müssen. Beim Schreiben für Laien, sollte man den Text so leicht und einfach bilden, zu verdauen, wie möglich, aus Furcht daß sie in einem Ozean von geekspeak verloren werden. Jede Weise, eine wenig Extrabemühung in Angelegenheiten von Eleganz und von Art setzend kann eine Welt vom Unterschied bilden.
Ich steige nicht in Detail über was gute Schreiben Technik festsetzt, wie ein, das über dem Bereich dieses Textes hinaus sein würde. Genügen Sie, zu sagen, daß ein guter Programmierer oder ein Ingenieur überprüfen sollten, ob sein Schreiben lesbar und gut-organisiert ist und daß es glatt von einem Thema zu anderen fließt.
Ich thrilled über Glauben hinaus, wenn ich nie ein anderes slipshod Handbuch sah oder wenn ich nie eine andere Geschichte über das Firmeneinstürzen wegen der nicht vorhandenen Unterlagen hörte. Eine hoffnungslose Phantasie? Möglicherweise. Noch hoffe ich, daß etwas techies heraus dort diese Anzeige lesen und daß sie sie zum Herzen nehmen.
Über Den Autor
V. Berba Velasco hat ein Doktorat in der Elektrotechnik und hat seinen Handel für fast eine Dekade ausgegübt. Während dieser Zeit hat er wiederholt den Wert des guten technischen Schreibens und die Gefahren entdeckt, die vom Ignorieren seines Wertes auftreten können.
Dr. Velasco arbeitet z.Z. als ältere elektrische und Software Engineer für die zellulare begrenzte Technologie (http://www.immunospot.com, http://www.elispot-analyzers.de), eine biotech Firma in Cleveland, Ohio. Während seiner Ersatzzeit hebt er Dodovögel an, errichtet menschliche Gehirne und Spiele mit seiner Ansammlung magnetischen monopoles.
Artikel Quelle: Messaggiamo.Com
Related:
» Credit Secrets Bible» Cash Making Power Sites
» Home Cash Course
» Automated Cash Formula
Holen Sie sich den HTML-Code fü Webmaster
Fügen Sie diese Artikel Ihrer Website jetzt hinzu!
Webmaster veröffentlichen Sie Ihre Artikel
Keine Anmeldung erforderlich! Füllen Sie das Formular aus und Ihr Artikel wird im Messaggiamo.Com Artikel-Verzeichnis aufgenommen!
