Technisches Schreiben für Terrified
Einleitung
Manchmal kann es über hinaus der Firmen- oder Einzelpersonenetat sein, zum eines professionellen Verfassers anzustellen, um ihre technischen Unterlagen zu adressieren. Obgleich in einer idealen Welt alle technischen Unterlagen von einem in hohem Grade ausgebildeten Experten produziert werden sollten, leider leben wir nicht in einem idealen. In der gleichen Weise, der viele Leute versuchen, ihre eigenen Haushaltsgeräte zu reparieren, versuchen viele Leute, Qualität technische Dokumente zu schreiben. Gerade wie, fiedelnd mit einem Toaster, electrocution ergeben, kann das Versuchen, technische Dokumente vom Kratzer ohne vorherigen Rat zu schreiben ergibt schließlich Ausfall. Wie eine rauhe Faustregel, das Sie immer suchen sollten, um einen Fachmann zu beschäftigen, aber wenn für was Grund Sie nicht können und Sie die schlechten unglücklichen sind, die die Unterlagen Aufgaben gehabt hat, die auf ihnen untergeschoben werden, verzweifeln Sie nicht. Dieser Schriftsatzführer umreißt einige der Kernfähigkeiten, die Sie zu Ihrem Schreiben holen müssen, der technischen Versammlung-, zum bewußt zu sein, Softwarepakete Sie betrachten können und der definitiven zu vermeiden Sachen. Hoffnungsvoll, selbst wenn Sie nie einen Satz in Ihr Leben über technisches alles vage geschrieben haben, haben Sie wenigstens, eine ausgedehntere Abbildung von, was technisches Schreiben zur Folge hat.
Was ist technisches Schreiben?
Technisches Schreiben unsurprisingly genug, bezieht sich auf Schreiben, das technisch ist. Obgleich dieses wie eine trügerische Definition scheinen kann, ist es ein wichtiges, zum sich zu erinnern. Zu viele technische Autoren machen den Fehler vom Verursachen der Unterlagen, die entweder zu technisch ist, oder auch ' literarisch '. Ein guter technischer Autor sollte in der LageSEIN, die Balance zwischen den zwei zu justieren, um dem Endbenutzer der Unterlagen zu entsprechen. Technisches Schreiben ist viel wie durchdringendes und doch hübsches viel unsichtbares der Frischluft. In der sonderbaren verdrahteten Welt, in der wir uns finden, ist technisches Schreiben überall. Software-Handbücher, Benutzerführer für Haushaltsgeräte, anweisende Blättchen, email, Buchstaben, Berichte, technische Nachrichtenreporte, Statistiken und Biographien über Fernsehensport stellt dar, daß alle Beispiele des technischen Schreibens sind, denen Leute an einer täglichen Grundlage ausgesetzt werden. Wenn Sie überhaupt versucht, die Zeiteinstellungen auf einem Hauptvideogerät zu programmieren und das Handbuch über dem Raum im Ekel geschleudert haben, warfen Sie ein Stück technisches Schreiben (obgleich offensichtlich nicht ein sehr gutes!).
Zu viele setzt Zeit technischen Literatur wird produziert von den Verfassern mit nicht einer großen genug Reichweite der Technologie oder von den Technologen fest, die eine Fähigkeit ermangeln zu schreiben. Wie ein zukünftiger technischer Autor Sie die sehr empfindliche Linie des Seins treten muß technisch kenntnisreich in Ihrem Fachmann, fangen Sie auf, sowie seiend ein ' guter ' Verfasser (im Vergleich mit ' schlechten ' Verfassern, die mugging normalerweise gefunden werden können süsse alte Damen oder etwas). Technische Unterlagen werden normalerweise für zwei eindeutige Benutzergruppen, nämlich sachverständige waagerecht ausgerichtete Benutzer und naive Benutzer produziert. Da ein technischer Autor einer Ihrer ersten Aufgaben aus, welchen Publikum sortieren soll Sie schreiben, dem mich geschickt für holt:
Kennen Sie thy Feind
Wie das alte cliché geht, jeder ein Kritiker. Dieses ist von der Reaktion der meisten gesunden Leute besonders zutreffend, wenn es mit technischem Schreiben gegenübergestellt wird. Wie im Beispiel des Videogerätes oben hervorgehoben wurde, kann technisches Schreiben zum Endbenutzer undurchdringlich sein. Wenn dieses der Fall ist, ist es, weil whoever die Unterlagen schrieb, störte nicht, ihre Publikum zu kennzeichnen und zu ihrem Niveau zu schreiben. Es scheint ein offensichtlicher zu bilden Punkt, aber einer, der häufig übersehen wird, daß der Benutzer der Ihrer Dokumente verursachen, kann möglicherweise nicht ein Experte wirklich sein. Offensichtlich, wenn Sie ein Dokument auf einem bestimmten Fachmannprodukt für eine bestimmte Benutzer mit Vorkenntnissengruppe erstellen (ein gutes Beispiel könnte Software für Computersystemverwalter revidieren) dann, das Sie dieses bestehen müssen sind eine völlig andere Weise als, wenn Sie zum Beispiel verursachen, ein technisches Handbuch für Massenmarkt-Computer-Software anstrebten den unerfahrenen Hauptbenutzer. Eine der ersten Aufgaben, die, Sie vollenden müssen, bevor Sie sogar Feder zum Papier, des Fingers zur Tastatur setzen, sollen kennzeichnen, wem der Benutzer Ihrer Dokumente die angestrebten Dokumente daß bestimmtes Ziel group(s) ist und konstruiert. Wenn Sie dieses Stadium korrekt erhalten, sollte es Ihre Dokumente vermeiden, die über Räume in der Störung geworfen werden!
Planung für Verkollkommnung
Sobald Sie den Zielmarkt für die Dokumente gekennzeichnet haben, die Sie erstellen werden, müssen Sie beginnen, zu planen, wie die Dokumente organisiert werden. Dieser Prozeß ist groß abhängig von, welchen Unterlagen produziert werden, aber Sie können einigen rauhen Faustregeln folgen. Erstens wenn die Dokumente ein besonders ausführliches Produkt stützen sollen (wie eine Computeranwendung) erhalten Sie Ihre grubby Hände auf ihr so schnell, wie Sie können. Indem Sie das Produkt im Detail überprüfen, können Sie einen Plan des Angriffs formulieren und anfangen, eine Organisationsstruktur zu bestehen. Während Sie das Produkt im Detail erforschen, können reichliche Anmerkungen des Nehmens, als Tun dies während der forschenden zuerststadien Sie Zeit speichern, die absolut lebenswichtig sein kann, wenn Sie zum Stichtag arbeiten. Sogar am Planung Stadium, das Sie sicherstellen müssen ist dort, eine Übereinstimmung zum Plan und Organisationsstruktur für das Dokument. Wählen Sie Numerierung Versammlungen vor, teilen Sie Arten in Paragraphen ein und erzeugen Sie rauhe Ideen zu den Planzwecken jetzt und außer lebenswichtiger Zeit später.
Lassen Sie einen Entwurf innen
Bevor in die Unterlagen zuerst verursachen kopfüber tauchen, Entwurf aus jedem Abschnitt. Dieses darf neuordnen, wenn die Dokumente, die verursacht werden, nicht einen logischen ' Fluß ' ohne ernsthaft Auswirkung auf das Projekt zu haben haben. Viele technische Dokumente (besonders für ausführlichere Produkte) bestehen die zahlreichen (und in einigen Fällen praktisch unzähligen) Wiederholungen. Dieses ist, weil das Produkt Überzeit verschiebt und ändert, und eine der Hauptaufgaben eines technischen Autors soll mit diese Änderungen Schritt halten, und sicherstellen, daß sie alle dokumentiert wohles sind. Gute technische Autoren drücken immer ihre Dokumente durch da viele Entwürfe, wie menschlich möglich, verfeinernd auf jedem Entwurf, bis sie eine Position erreichen, hingegen sie (und ihr Arbeitgeber) erfüllt ist, die die Unterlagen fristgerecht sind, genau und eine zutreffende Reflexion des Produktes oder es dokumentiert verarbeiten Sie.
Der Teufel ist ausführlich
Als bereits gekennzeichnetes, technisches Schreiben wird das benannt, weil es in der Natur technisch ist. Der Teil des Seins technisch soll exakt sein, und der Teil Präzision soll so ausführlich sein, wie menschlich möglich. Selbst wenn die Dokumente, die Sie erstellen, für ein vorgerücktes sind und technologisch verfeinerte Benutzergruppe, Ihre Unterlagen muß auf die Details eines Prozesses oder im Verwenden eines Produktes konzentrieren. Dieses kann ein schwieriges zu vollenden Meisterstück sein, aber, nicht wenn Sie Ihren Publikum schreiben. Nehmen Sie nie an, daß der Leser weiß, daß alles über das Produkt oder den Prozeß dokumentiert wird, aber im Fall vorgerückter/sachverständiger Benutzer haben Sie mindestens den gesunden Menschenverstand, die Tatsache zu erkennen, daß sie vermutlich nicht brauchen erklärt zu werden, wie man die Ausrüstung benutzt, die sie an eine tägliche Grundlage laufen lassen. Wenn Sie beschreiben, wie man eine bestimmte Tätigkeit oder eine Aufgabe durchführt sicherstellt, kennzeichnen Sie jedes betroffene Stadium (numerieren Sie sie, wenn dieses die Vereinbarungen der Dokumentpaßt art, die Sie verursachen) und die Genauigkeit von was Sie Test ihm sich schriftlich, oder sogar, Seil in einem Freiwilliger des gleichen Fähigkeiten Niveaus wie der Endbenutzer verbessert.
Wählen Sie das rechte Werkzeug für den Job
Obgleich es möglich ist, technische Dokumente mit Pergament und Blut zu erstellen, ist es nicht ratsam. Viele Fachmann-Software-Anwendungen bestehen, um Ihnen zu helfen, leistungsfähige Unterlagen zu verursachen, und der Teil Ihrer Aufgaben als technischer Autor, schließen das Vorwählen des rechten Werkzeugs für den Job ein. Groß hängt dieses von der Natur der Dokumente ab, die produziert werden, und von der Natur ihrer etwaigen Verteilung. Wenn die Dokumente mit dem Internet geliefert werden können, ist dieses zweifellos eine zu betrachten Allee. Gebrauchen Sie zu diesem Zweck Pakete wie Blitz MX und Dreamweaver, um dieses Ziel zu erzielen. Für integrierte on-line-Hilfe können Sie möchten rohe HTML Dokumente erstellen, oder ein Fachmannpaket wie RoboHelp wechselweise vorwählen oder ähnlich. Im Kasten der Basisdokumente des Druckes, müssen Sie ein Softwarepaket vorwählen, das genug, um anzufassen leistungsfähig ist, was Sie an ihm werfen.
Viele unerfahrene technische Autoren drehen sofort sich in Richtung zu Microsoft Word (da es kann innen kommerzielle und private Klimas überall vorhanden ist). Es sei denn Ihre Unterlagen unter 150 Seiten und Ihnen sein werden können Sie Schablonen verursachen und Makros zu bilden, vermeiden Sie MS Wort. Da jeder technische Autor Ihnen erklärt, hat es böse Gewohnheiten alle, die es besitzen soll und kann ein instabiles Paket häufig sein, zum mit zu arbeiten. Wenn Sie schwere Unterlagen der Graphiken verursachen, können Sie möchten Quark Xpress betrachten, oder wählen Sie möglicherweise den Industrieführer in auffangen, luftgetrockneten Ziegelstein Framemaker. Was Software Sie vorwählen, müssen Sie Sie sicherstellen werden unglaublich tüchtig mit ihr, entweder, indem Sie im Training investieren oder indem Sie Tag für Tag es nach Tag verwenden!
Stehen Sie in Verbindung - das ist, was Sie gezahlt werden, um zu tun!
Viele Leute erklären Ihnen, daß, technische Unterlagen zu verursachen langwierig und sich wiederholend ist. Diese Leute, sind falsch und vielleicht morons auch. Obgleich Sie den Prozeß des Verursachens der technischen ' bohrenden ' Unterlagen finden können (wenn Sie tun, sind Sie im falschen Job!) er ist nicht. Qualitätstechnische Dokumente zu erstellen ist ein lebenswichtiges Stadium, wenn es Leute erlaubt zu, ausreichend und verwenden richtig Technologie. Obgleich kein Benutzer den Unterlagen sich nähert, die Sie verursachen, genauso wie sie einem Roman sich nähern, können Sie ihnen schließlich helfen, zu erzielen, was sie erzielen möchten mit Technologie. Egal wie ' stumpf ' der Prozeß scheinen kann zu sein, sollte das Erlauben Benutzern, ihre Ziele, indem es Ihre Dokumente, zu erzielen liest Ihnen Anstürme des Stolzes geben und in der Tat, Glück. So lang, wie Sie an die positiven Effekte sich erinnern, die Technologie auf den Leben der Leute haben kann, wenn Sie Ihre Dokumente erstellen, können Sie effektiv in Verbindung stehen, da Sie im mitteilsamen Prozeß glücklicher sind. Während des Unterlagen Lebenszyklus sollten Sie suchen, mit Kollegen so häufig Verbindung aufzunehmen, wie möglich (wenn anwendbar). Lassen Sie sie Ihre Dokumente lesen, zu ihren Kritiken hören, und Ihre Dokumente justieren (wenn Sie nicht Ihre Ecke argumentieren können!). Ein technischer Autor wird gezahlt, um in Verbindung zu stehen, überprüft, ob Sie, und nie zu vergessen, zu warum Ihr in Verbindung stehen, und zu wem, in den Dokumenten selbst.
Allgemeine zu bilden zu vermeiden Fehler
Wenn Sie technische Dokumente dort erstellen, seien Sie eine Anzahl von tödlichen Fehlern, die Sie bilden können. Obgleich auf keinen Fall vollständig, schildert dieser Abschnitt einige der allgemeineren Fehler, die neue Autoren bilden, in den Hoffnungen genau, daß Sie vermeiden, sie auch zu bilden:
Patronising sein - obgleich technische Unterlagen klar sein sollten, sollte sie nie patronising. Sie erstellen nicht die von den morons aber von den Verbrauchern und von den Klienten gelesen zu werden Dokumente. Sie sollten zum Fähigkeiten Niveau Ihrer Publikum immer schreiben, aber, egal was technische waagerecht ausgerichtete Leute eingeschaltet sind, sind sie nicht morons. Sogar Kinder erhalten, als patronised, machen nicht diesen Fehler mit jemand beleidigt, das Ihr Gehalt, Kind oder anders zahlt.
Überbeanspruchung der Stimmung - Leute lesen nicht die technischen unterhalten zu werden Dokumente, lesen sie sie in den Hoffnungen einen Prozeß erfolgreich von durchführen oder von Extrahieren von von Informationen. Es sei denn es zum Endbenutzer relevant ist, vermeiden Sie Stimmung wo möglich. Wenn Sie ein Buch, eine Geldstrafe und ein gutes schreiben. Wenn Sie ein Handbuch schreiben, vermeiden Sie Stimmung wie die Pest, da meistens Benutzer den Witz und das gerechte Ende vermissen, die oben den patronising Idioten verabscheuen, der die Unterlagen schrieb.
Unbeständigkeit - sogar am zeichnenden Stadium, sollten Sie sichergehen, daß alle Elemente, die in Ihrem Dokument benutzt werden, gleichbleibend sind. Dieses wendet so viel am ' Ton ' des Dokumentes hinsichtlich des Plans von ihm an. Stellen Sie Ihnen Gebrauch gleichbleibende Richtungen sicher (erste Person, usw..) sowie Seitenaufstellung, Paginierungelemente, Überschriften und Seitenenden und alle weiteren Textelemente.
Beweis gelesen - Ende des Verursachens eines Stückes technischer Unterlagen, sind Sie vermutlich Kranker des Anblicks von ihm. Das macht nicht aus. Was ausmacht, ist Haupt was Ihr Büro oder verläßt, ist genau. Zu diesem Zweck las Beweis das Dokument während aller, die es Entwürfe ist, und bevor er verteilt wird, las Beweis ihn wieder und wieder und wieder. Bauen Sie nie auf Bannkontrolleure (sie nie Arbeit) und wenn Sie sie vermeiden können, bauen Sie nie nur auf Ihr eigenes Urteil. Erhalten Sie Ihr Dokument gelesen durch da viele Paare Augen, wie möglich vor Verteilung, schließlich konnten sie die eine Sache beschmutzen, die Sie während des Kreation Prozesses gefehlt haben.
Zusammenfassung/schamlose Selbstförderung
Technisches Schreiben ist nicht unabhängig davon was Sie denken können, ein einfacher Job. Es erfordert Sachkenntnis, Geduld und eine sehr ungerade Mischung von Fähigkeiten. Gerecht wie jeder möglicher andere Job, können Sie erlernen, wie zu ihn tun Sie, aber sogar bildet dieser Unterricht Sie kein gutes notwendigerweise an ihm. Um ein guter technischer Autor zu sein, müssen Sie anal dennoch kreativ sein, fokussiert dennoch mitteilsam und ein flexibler Experte. Dieses, wie Sie vermutlich sich vorstellen können, ist keine einfache Aufgabe. Obgleich Sie denken können, daß technische Dokumente erstellend, einfach ist, sind genaue, gleichbleibende und fristgerechte Unterlagen Verursachens zu einem hohen kommerziellen Standard eine in hohem Grade schwierige Rolle. Unabhängig davon Ihren Etat langfristig stellt es bedeutendes ROI zur Verfügung, wenn Sie einen Fachmann anstellen. SchließlichSIND sie in der Lage, an den Tagen zu tun, was Sie Ihr Haar unser Versuchen, in den Wochen zu vollenden wenn nicht Monate heftig zerreißen.
Über Den Autor
Über den Jahren Mike ist Kemp als unabhängiges ES der Journalist (arbeitend für Publikationen wie das Register, das Namesfacesplaces, den Sicherheit Fokus und das Packetstorm), ein Werbetexter, ein Videospielentwerfer, ein Sicherheit Revisor, ein Netzentwerfer, ein Graphikdesigner und ES Trainer eingesetzt worden. Er hat in einer Vielzahl der unabhängigen und dauerhaften Positionen für beide kleinen (z.B. zwei Männer und Hunde) Firmen zu den multinationalen Organisationen in Großbritannien und Europa gearbeitet. Beim Arbeiten nicht auf verschiedenen Artikeln, können Bücher, Handbücher und sortiert anderer Kopie für Klienten, auf einer Vielzahl, der unveröffentlichten Romane abzuplagen Mike normalerweise gefunden werden. Er hat mehrere seiner kurzen Drehbücher gehabt, die von den unabhängigen Produktion Firmen produziert werden und z.Z. auf mehreren Eigenschaft Länge Indexe bearbeitet.
Lebt Mike meistens glücklich in einem schrecklich un-böhmischen London Vorort mit seinem langfristigen (und lang-leiden) Partner, und zwei verwirrten Katzen. Um mehr ungefähr Mike zu erlernen, die Strecke der Projekte ist er innen miteinbezogen worden, und anderes sortiertes Material und Unsinn, besucht bitte sein persönliches homepage an www.clappymonkey.com.
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!
