Wie schreibe ich technische Dokumente?

1. Vorbereitung Vorbereitungsphase

Die Arbeit in der Vorbereitungsphase umfasst hauptsächlich die folgenden Punkte:

·Dokumentanforderungen klarstellen

·Zielgruppe des Dokuments klarstellen

·Dokumentumfang definieren

Bevor Sie ein Dokument schreiben, Es muss klare Dokumentationsanforderungen geben. Sie müssen verstehen, warum Sie dieses Dokument schreiben möchten und welchen Zweck Sie mit dem Schreiben dieses Dokuments erreichen möchten.

Klären Sie auch die Zielgruppe des Dokuments. Der Inhalt dürfte je nach Zielgruppe unterschiedlich sein. Beispielsweise weist die Dokumentation für Entwickler und für Nicht-Entwickler/normale Benutzer eine unterschiedliche Organisation der Inhalte auf.

Definieren Sie außerdem den Umfang des Dokuments. Überlegen Sie, welche Inhalte oder Module dieses Dokument abdecken muss und welche nicht. Auf diese Weise haben Sie beim späteren Sammeln von Informationen eine gewisse Konzentration und bleiben beim Schreiben nicht vage.

Verwandte Empfehlungen: „php-Einführungs-Tutorial“

2. Forschungsphase

Diejenigen, die Erfahrung im Schreiben technischer Dokumente haben Freunden geht es auf jeden Fall genauso. Wenn man etwas nicht versteht, ist es einfach zu mühsam, eine Dokumentation dafür zu schreiben.

Wie können Sie also den Schmerz vermeiden, wenn Sie auf ein unbekanntes Thema stoßen, von dem Sie keine Ahnung haben? Natürlich versuche ich einfach mein Bestes, es zu verstehen.

Aber wie geht das konkret? Kurz gesagt bedeutet es, Informationen zu sammeln. Wie sammelt man also Informationen? Der Autor glaubt, dass wir von den folgenden Punkten ausgehen können:

(1) Recherchieren Sie die relevanten Dokumente repräsentativerer ähnlicher Produkte oder ähnlicher Produkte, um zu sehen, wie die Dokumente anderer Personen erstellt werden.

Wenn Sie nichts wissen, ist es eine gute Wahl, aus den Erfahrungen und Praktiken anderer Menschen zu lernen. Durch den Vergleich der Dokumentationen mehrerer Produkte können Sie einen groben Rahmen für die Dokumentation erstellen, die Sie schreiben möchten.

Es ist zu beachten, dass es sich bei der Referenz nicht um eine Kopie handelt, sondern nur zur Bereitstellung von Ideen. Verschiedene Produkte haben unterschiedliche strukturelle Planungen des Dokuments.

(2) Nutzen Sie die effektivsten Methoden, um alle Arten von Informationen im Zusammenhang mit dem Dokument, das Sie schreiben, zu sammeln.

Die gesammelten Informationen werden wahrscheinlich Teil des veröffentlichten Dokuments, nachdem sie vom technischen Redakteur extrahiert und organisiert wurden.

Es gibt viele Möglichkeiten, Informationen zu sammeln, z. B. Internetrecherchen, Fragebögen, Interviews, Experimente sowie E-Mail-Diskussionen, Berichte, technische Artikel usw. Welche Methode verwendet werden soll, erfordert eine detaillierte Analyse. Sie müssen eine Methode auswählen, die die erforderlichen Daten basierend auf Faktoren wie Dokumentanforderungen, Fristen und der Fülle der vorhandenen Daten schnell und genau erfassen kann.

Bei einigen Schreibthemen kann Ihnen die Suche im Internet möglicherweise kaum weiterhelfen. Auch für diese Art von Inhalten können Sie einige Informationen von den Entwicklern einholen. Sie können sie bitten, Ihnen entsprechend Ihren Anforderungen zu helfen, oder Sie können die benötigten Informationen durch Entwicklungsnotizen und Diskussionen im internen System erhalten.

Für die Dokumentation von Softwareprodukten muss der Technische Redakteur, selbst wenn es einige technische Informationen gibt, diese häufig selbst verwenden, damit er die Arbeitsschritte intuitiv verstehen und Informationen zum Schreiben von Dokumenten aus erster Hand erhalten kann.

3. Struktur des Organisationsdokuments

Wenn die Daten fast erfasst sind, können Sie die spezifische Struktur dieses Dokuments hier organisieren eine helfende Hand.

Gemeinsame Produktnutzungshandbücher sind im Allgemeinen in der Reihenfolge der Installation oder Verwendung organisiert. Bei anderen Dokumenten, die keine Leitfäden sind, sollten sie ebenfalls einer bestimmten Reihenfolge oder Logik folgen.

Darüber hinaus müssen Sie auch berücksichtigen, ob dem Dokument Bilder beigefügt werden müssen und ob Tabellen verwendet werden müssen. Wenn Sie Bilder hinzufügen müssen, machen Sie deutlich, ob Sie die Hilfe anderer benötigen oder ob Sie es selbst vervollständigen müssen. Auch das Zeichnen eines komplexeren Bildes ist eine zeitaufwändige Aufgabe, und auch der Zeitaufwand muss berücksichtigt werden.

Sobald Sie eine detaillierte Dokumentstruktur haben, können Sie mit dem nächsten Schritt des Schreibens fortfahren.

4. Schreiben von Dokumenten

Wenn Sie die ersten Schritte gut gemacht haben, wird das Schreiben sehr einfach. Sie müssen nur den entsprechenden Inhalt genau ausfüllen. in das Dokumentschema. In diesem Prozess müssen Sie Absätze oder bestimmte Schritte schreiben. Dies ist eine Zeit, um über Ihre Sprach- und Schreibfähigkeiten nachzudenken.

In einigen Büchern zum Technischen Schreiben heißt es, dass man sich beim Schreiben von Dokumenten keine Gedanken über Grammatik, Wortlaut und Zeichensetzung machen muss, und ist der Meinung, dass diese Details in der Überarbeitungsphase verbessert werden sollten.

Expand your outline into paragraphs, without worrying about grammar, refinements of language usage, or 
punctuation. 
Writing and revising are different activities; refinements come with revision. - Handbook of Technical 
Writing

Ich sehe das anders. Ein qualifizierter Technischer Redakteur sollte über gute Sprachkenntnisse wie Grammatik, Wortlaut und Zeichensetzung verfügen, sollte nicht zu einem Problem werden, das allein gelöst werden muss. Standardgrammatik, anständige Formulierungen und korrekte Zeichensetzung sollten zu einer Schreibgewohnheit geworden sein, die keinen zusätzlichen Aufwand erfordert und fast keine zusätzliche Zeit in Anspruch nimmt.

Wenn der erste Entwurf des Schreibens grob ist und viele kleine Details enthält, die geändert werden müssen, erhöht dies definitiv den Arbeitsaufwand und den Zeitaufwand bei der Überprüfung und verzögert dadurch den Dokumentenprozess.

Vielleicht kann diese Methode für große Unternehmen übernommen werden, die eine ausgefeilte Arbeitsteilung haben und jede Person nur für einen kleinen Link verantwortlich ist. Dies gilt jedoch nicht für Startups, die sich schnell entwickeln und eine agile Entwicklung der Dokumentation erfordern.

5. Überarbeitung

Nachdem der erste Entwurf des Dokuments geschrieben wurde, bedarf es normalerweise einer weiteren Überarbeitung und Verbesserung. Unter „Revision“ versteht man hier die Änderung nach der Überprüfung, daher kann dieser Schritt auch „Überprüfung und Überarbeitung“ genannt werden.

Wer muss es also überprüfen? Technische Dokumente erfordern in der Regel zwei Arten von Überprüfungen durch andere Partner, nämlich:

·Technische Überprüfung: Überprüfen Sie aus technischer Sicht, ob die Beschreibung im Dokument korrekt und wirksam ist

·Sprachprüfung: Überprüfen Sie, ob der Ausdruck im Dokument prägnant und dem Sprachniveau angemessen ist

Nachdem der Technische Redakteur das Feedback des Prüfers erhalten hat, muss er zeitnah Beurteilungen und Änderungen vornehmen. Alle unklaren Punkte müssen mit dem Gutachter besprochen werden. Nachdem Sie die Änderungen vorgenommen haben, bitten Sie den Prüfer, einen Blick darauf zu werfen. Wenn neue Probleme entdeckt werden, müssen diese erneut geändert werden. Dieser Überprüfungs- und Überarbeitungsprozess kann sich mehrmals wiederholen, was normal ist.

Bevor er andere um eine Überprüfung bittet, kann der technische Redakteur natürlich auch selbst eine Überprüfung durchführen, um geringfügige Fehler zu vermeiden und die Zeit anderer Leute zu verschwenden.

Haha, hier kommt das Problem wieder ~ Normalerweise sind Leute, die gerade mit dem Schreiben eines Artikels fertig sind, sehr zurückhaltend beim Lesen des Geschriebenen. Zu diesem Zeitpunkt können Sie einige Tools zur Grammatik- und Rechtschreibprüfung verwenden. Du hast es verstanden.

Wenn Sie der Meinung sind, dass Sie vorsichtig genug sind und keine Geräte zur Unterstützung benötigen, bewundere ich Ihre Fähigkeiten, empfehle aber dennoch die Verwendung von Geräten. Denn es kann auch vorkommen, dass es Ihnen schlecht geht, Sie müde sind und einnicken und manchmal nicht wissen, was zum Teufel Sie geschrieben haben ... Seien Sie nicht streng zu sich selbst und Ihren Geräten.

6. Lieferung des Dokuments

Nachdem das Dokument fertiggestellt ist, kann es auf der Plattform veröffentlicht werden, die im Allgemeinen einfach zu bedienen ist. Verschiedene Unternehmen verfügen über unterschiedliche Plattformen für die Veröffentlichung von Dokumenten, und auch die von Technischen Redakteuren verwendeten Schreibwerkzeuge sind unterschiedlich.

Nachdem das Dokument veröffentlicht wurde, bedeutet dies nicht das Ende. Nach meiner Berufserfahrung kann es auch bei veröffentlichten Dokumenten immer noch zu Problemen kommen, egal ob es sich um Dokumente von großen oder kleinen Unternehmen handelt. Zum Beispiel: unentdeckte Textfehler, defekte Links, Beschreibungen und Schritte, die nicht mehr zu den neuesten Produkten passen usw. Technische Redakteure müssen mit den Produktentwicklungen Schritt halten, um Dokumente zeitnah zu aktualisieren.

Das obige ist der detaillierte Inhalt vonWie schreibe ich technische Dokumente?. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!