Grundlegende Schritte zum Erstellen eines technischen Berichts

Solid Edge Tutorial: Animierte PDF-Anleitung für die Technische Dokumentation (November 2024)

Solid Edge Tutorial: Animierte PDF-Anleitung für die Technische Dokumentation (November 2024)

Inhaltsverzeichnis:

Anonim

Wenn Sie jemals das Handbuch zum Zusammenbauen oder Bedienen eines neuen Kaufs gelesen haben und verwirrter gegangen sind als zu Beginn, sind Sie nicht alleine. Technisches Schreiben kann selbst für den erfahrensten Fachmann schwierig sein. Beim Verfassen eines technischen Berichts ist es jedoch wichtig, sachdienliche Inhalte einzubeziehen, klar und präzise zu sein und Ihre Informationen so zu organisieren, dass der Leser sie leicht verstehen kann.

Auswählen der Betreffsache

Menschen schreiben im Allgemeinen technische Berichte, wenn sie Nachforschungen angestellt haben und die Ergebnisse einem bestimmten Publikum präsentieren müssen. Diese Forschung kann Feldforschung - Umfragen, Interviews und Beobachtungen - oder Buchforschung sein. Unabhängig von der Art der Recherche können Sie nicht alle gesammelten Informationen weitergeben. In „Einige Ratschläge zum Verfassen eines technischen Berichts“ schlägt Alan Sherman von der University of Maryland im Baltimore County vor, dass sich Ihr Bericht auf wichtige Erkenntnisse konzentrieren sollte, die zeigen, dass das Thema Ihrer Forschung interessant und wichtig ist. Sie sollten auch Elemente wie das Forschungsdesign und Empfehlungen hinzufügen, wenn diese erforderlich sind.

Klar und prägnant sein

Menschen lesen keine technischen Berichte für blumige Sprache oder Bilder. Stattdessen lesen die Leute technische Berichte, weil sie nach bestimmten Informationen suchen. Seien Sie klar und präzise, ​​wenn Sie Ihren Bericht schreiben. Denken Sie über Ihr Publikum und Ihre Ziele nach und schreiben Sie auf eine Art und Weise, in der die Leser am besten verstehen können, was Sie zu kommunizieren versuchen. Wenn Sie beispielsweise wissen, dass viele Personen, die Englisch als Zweitsprache sprechen, Ihren Bericht lesen, vermeiden Sie Klischees und Redewendungen. Wann immer es möglich ist, Wörter, Sätze und Absätze ausschneiden, müssen Sie die gesammelten Informationen nicht melden.

Organisieren Sie Ihre Informationen

Organisation ist kritisch in technischen Berichten. Unabhängig davon, ob Sie einen Artikel zur Vorgehensweise oder einen Finanzbericht am Arbeitsplatz verfassen, können unorganisierte Informationen den Lesern die Verwendung dieser Informationen erschweren. Zielgruppe und Zweck haben großen Einfluss auf die Organisation Ihres Berichts. Was Ihre Zielgruppe bereits über das Thema weiß, bestimmt, ob Sie Hintergrundinformationen hinzufügen müssen, bevor Sie bestimmte Details angeben. Wenn der Zweck Ihres Berichts darin besteht, die Verwendung von Geld zu rechtfertigen oder sich für eine durchzuführende Maßnahme einzusetzen, schließen Sie mit einem Vorschlag oder Rechtsmittel ab und ordnen Sie den Bericht Ihres Berichts rund um Ihre Unterstützung für diese Maßnahme. Personen, die Anleitungen schreiben, müssen sicherstellen, dass die Schritte in einer richtigen chronologischen Reihenfolge angeordnet sind.

Externe Quellen zitieren

Da in technischen Informationsberichten häufig die Ergebnisse der Forschung aufgedeckt werden, zitieren Sie möglicherweise die Ideen anderer in Ihren Texten. Unabhängig davon, ob Sie diese Quellen zitieren oder umschreiben, müssen Sie sie durch Zitieren anerkennen. Wenn Sie Ihren Bericht für die Arbeit schreiben, wird für dieses Zitat möglicherweise eine Fußnote oder eine Endnote empfohlen. Wenn Sie jedoch den Bericht für die Schule schreiben, müssen Sie für Ihren Lehrer oder Professor normalerweise einen vorhandenen Zitierstil verwenden, z. B. die Modern Language Association oder den American Psychological Association-Stil.