Letztes Feedback

Meta





 

Fünf Tipps, um große Entwicklerdokumentation zu schreiben

Das Schaffen der Entwicklerdokumentation ist ein Teil, in IHM Industrie verwendet zu werden. Technische Handbücher, technische Spezifizierungshandbücher, Unterstützungshandbücher, Durchführungshandbücher - sind alle Typen der Entwicklerdokumentation und sind ein Teil des Jobs. Viele technische Rollen in IHM Industrie werden am Dokumentationsprozess beteiligt. Es könnte eine leichte Aufgabe scheinen, gerade einige Wörter und Diagramme, eine Inhaltsübersicht zusammenzustellen, und es als ein technisches Dokument kennzeichnen, aber es ist viel mehr als das. Ich habe fünf Tipps unten darauf entworfen, wie man den großen technologischen Doktoren schreibt.

Verwenden Sie eine gut strukturierte Inhaltsübersicht

Die Inhaltsübersicht ist unter dem wichtigsten Teil eines Dokumentes. Die Inhaltsübersicht-Details, was wirklich im Dokument ist, und wie es eingeordnet wird. Es wird verwendet, um Benutzern zu helfen, zu begreifen, dass das Dokument die Information liefert, nach der sie suchen. Die Inhaltsübersicht durchgehend, sind sie im Stande leicht zu überprüfen, ob sie enthält, was sie brauchen, oder wenn sie ein anderes Dokument lesen müssen.

Ein anderer Vorteil, eine gut strukturierte Inhaltsübersicht zu haben, ist er erlaubt dem Leser, die Information zu finden, die sie schnell brauchen. Microsoft Word, Adobe PDF sowie andere Dokumentenanwendungen erlauben clickable Verbindungen der Inhaltsübersicht. Das erlaubt Ihnen, auf den Artikel oder die Seitenummer zu klicken, und es wird Sie zu dieser Seite bewegen. Sehr nützlich, um Themen schnell zu finden.


Seien Sie kurz gefasst, aber gründlich

Für einen technischen Dokumentenautor ist es hart, wirklich was Betrag und welcher Details zu wissen, in dieses Dokument zu stellen. Um ein großes Dokument zu schreiben, versuchen Sie, kurz, aber gründlich zu sein. Was das bedeutet, soll nicht fortsetzen und in alle Arten des Details über bestimmte Gebiete, die für den Leser nicht notwendig sind. Es ist nicht leicht zu erzählen, was wichtig ist, und was ist nicht - aber machen Sie einen Versuch, an den Leser und das Zielpublikum zu denken, wenn Sie das Dokument schaffen. Wenn Sie "zu wortreich" sind oder zu viel Information verwenden, wo sie nicht erforderlich ist, wird sie die Leser abdrehen, und es wird kein wirksames Dokument sein.

Entsprechen Sie überall im Dokument

Konsistenz ist eine große Weise, ein Dokument zu erhöhen. Es lässt es mehr beruflich, und in der wirklichen dem Benutzer lesbareren Tatsache aussehen. Wenn ich Konsistenz sage, spreche ich über die Regelmäßigkeit sowohl im Vokabular, das Sie verwenden als auch die Formatierung von Ihnen, gelten. Einige Menschen werden das nicht bemerken. Trotzdem, wenn Sie ein technisches Dokument zusammensetzen, ist es wahrscheinlich für andere technische Leute, die gewöhnlich Detail-eingestellte Leute sind. Stellen Sie sicher, dass Ihr Dokument denselben Stil überall verwendet. Versuchen Sie, die Information zu zerbrechen und sie leicht lesbar den Benutzern zu machen, indem Sie Leerraum effektiv verwerten.

 

Beschäftigung derselben Begriffe wird auch empfohlen. Das sollte sicherstellen, dass der Benutzer weiß, dass Sie über dasselbe Ding schreiben, indem Sie dieselben Wörter verwenden. Wenn Sie Wörter austauschbar, zum Beispiel "Arbeitsfläche", "PC", "Computer" verwerten, konnte es vielleicht den Benutzer verwirren, wenn Sie wirklich dasselbe Ding vorhaben. Es ist ein schnelles Beispiel, aber die Idee besteht darin, dass Sie einen Begriff auswählen und dabei bleiben sollten.

Halten Sie es genau und fehlerfrei

Es geht fast ohne zu sagen, dass Entwicklerdokumentation freier Fehler sein sollte. Als ich angegeben könnten viele Leser des Dokumentes andere technische Benutzer sein, und es gibt eine ziemlich gute Chance die Fehler werden zu ihnen bemerkt. Zusätzlich dazu, wenn die Fehler nicht hervortreten, dann wird es sie mit der falschen Information bezüglich des Systems oder Gebiets versorgen, das Sie dokumentieren - der das Ziel des Dokumentes vereitelt!

Vermeiden Sie große Schirm-Festnahmen

Verwendung von Schirm-Festnahmen oder Screenshots als ein Teil Ihrer Entwicklerdokumentation ist eine wirklich wirksame Weise, Ihren Punkt dem Leser zu entwerfen. Es ist für die Softwaredokumentation oder Unterstützungsprozesse besonders nützlich, die leicht sind, Screenshots dessen zu nehmen. Jedoch sind Computerschirme viel größer mit der Zeit geworden, aber A4 Platten haben fortgesetzt, dieselbe Größe zu sein.

Das verlässt eine Tendenz, große Screenshots in einem Dokument zu vereinigen, das die Screenshots klein und unwirksam macht. Das Verbinden von Screenshots ist eine große Idee - verstehen mich nicht falsch - aber bemühen sich, nur die Gebiete einzuschließen, die mit der Abteilung verbunden werden, die Sie erklären. Es könnte zu mehr Screenshots führen, aber sie werden auch wirksamer sein und das Dokument lesbarer machen.

7.8.13 12:34

Letzte Einträge: Häufige Fehler, wenn man eine Karriere wählt

bisher 0 Kommentar(e)     TrackBack-URL