Dieses Online-Buch für technisches Schreiben verwendet jetzt technisches Dokument (Technische Dokumentation abgekürzt) um auf ein beliebiges Dokument zu verweisen, das technische Informationen—anstatt zu verwenden Bericht. Der Bericht ist eine Unterkategorie neben den anderen Arten technischer Dokumente, die in diesem Buch behandelt werden.
Hinweis: Dieses Lehrbuch zum technischen Schreiben konzentriert sich auf Technische Schreibfähigkeiten. Die technischen Inhalte hier sind nicht garantiert korrekt oder aktuell.
Hintergrund-/Informationsberichte
Dieser Typ ist am schwierigsten zu definieren, aber derjenige, den die meisten Leute schreiben. Er konzentriert sich auf ein technisches Thema, liefert Hintergrund zu diesem Thema für eine bestimmte Leserschaft, die dafür spezielle Bedürfnisse hat. Dieser Bericht liefert weder Anleitungen, noch Empfehlungen in irgendeiner systematischen Weise, noch berichtet er neue und originäre Daten.
Für ein vollständiges Kapitel zu dieser Art von Techdokumentation, siehe Hintergrund/Informationsberichte
Geschäftspläne
Ein Geschäftsplan ist ein Dokument, das dazu dient, ein neues Unternehmen zu gründen oder Finanzierung für ein Unternehmen zu erhalten, das sich in wesentlicher Weise verändert. Geschäftspläne sind wichtige Dokumente für Geschäftspartner, die sich auf ihre Pläne einigen müssen, für Regierungsbeamte, die diesen Plan genehmigen müssen, und natürlich für potenzielle Investoren wie Banken oder Privatpersonen, die das Unternehmen finanzieren könnten.
Sieh dir das komplettes Kapitel Über diese Art von technischer Dokumentation.
Technologie-orientierte Benutzerhandbücher
Kurz gefasst, ein Computer-Benutzerhandbuch bietet technische Informationen darüber, wie man Computer‑Hardware oder ‑Software verwendet, einschließlich Anleitungen für Aufgaben wie Einrichtung, Konfiguration und andere wesentliche Tätigkeiten.
Sieh das vollständiges Kapitel bei dieser Art von technischer Dokumentation.
Datenberichte
Ein Datenbericht ist ein technisches Dokument, das viele Daten in Form von Tabellen enthält. Er kann außerdem Diagramme und Grafiken enthalten, die die Daten in diesen Tabellen anschaulicher darstellen, sowie erklärende Querverweise, die wichtige Trends und Schlussfolgerungen in den tabellarischen Daten aufzeigen.
Sieh dir das Vollständiges Kapitel bei dieser Art von Tech-Dokumentation.
Konstruktionsberichte
Ein Bericht über ein ingenieurtechnisches Designprojekt stellt das Projekt vor und dokumentiert es, damit andere nachvollziehen können, wie das Design angewendet und kommerzialisiert werden kann. Ingenieurstudierende haben zum Beispiel über die Auslegung eines Temperaturmess- und Anzeigesystems unter Verwendung eines Mikrocontrollers geschrieben.
Siehe das Vollständiges Kapitel bei dieser Art von Techdokument.
Leitfäden und Richtliniendokumente
Kurz definiert, ein Leitfaden ist eine Publikation, die Schritt-für-Schritt-Anleitungen, Tipps, verwandte Konzepte bietet. Sie kann auch Informationen zur Fehlerbehebung, Links zu verwandten Communities, und Links zu verwandter Forschung enthalten.
A Leitfaden ist ein Regierungsdokument, das dazu bestimmt ist, der Öffentlichkeit nützliche Informationen bereitzustellen, wie zum Beispiel zur Klarstellung von Verpflichtungen nach einem bestehenden Gesetz oder einer Vorschrift. Es versucht, die komplexe rechtliche Sprache administrativer Regeln zu übersetzen, damit die Öffentlichkeit diese Regeln einhalten kann.
Siehe das Vollständiges Kapitel auf diese Arten technischer Dokumentation.
Handbücher
Kurz definiert, ist ein Handbuch eine einzige Quelle, die konzeptionelle Informationen (grundlegende Theorien, Prinzipien, Grundlagen), Anleitungsinformationen (Schritt-für-Schritt-Anleitungen) und Nachschlageinformationen (zum schnellen Nachschlagen) enthält.
Siehe die Komplettes Kapitel zu dieser Art von technischer Dokumentation.
Anweisungen
Kurz definiert, Anleitungen sagen dir, wie man Dinge baut, Dinge bedient, Dinge repariert—der klassische "how-to." Für Studierende des technischen Schreibens empfiehlt sich "Technologieorientierte Benutzerhandbücher."
Siehe die Komplettes Kapitel bei dieser Art von Tech-Dokumentation.
Literaturübersichten
Kurz gesagt, eine Literaturübersicht fasst zusammen, was über ein bestimmtes Forschungsthema bekannt ist, schildert die Meilensteine der Forschungsgeschichte, weist darauf hin, wo der aktuelle Wissensstand widersprüchlich ist, und diskutiert Bereiche, in denen noch Unbekanntes besteht.
Sieh das Vollständiges Kapitel bei dieser Art von Tech-Dokumentation.
Primärforschungsberichte (Laborberichte)
Kurz definiert, stellt ein primärer Forschungsbericht Befunde und Interpretationen aus Labor- oder Feldforschung dar. Man kann ihn als Laborbericht betrachten, aber er ist weit mehr als das.
Siehe die Vollständiges Kapitel bei dieser Art von technischer Dokumentation.
Fortschrittsberichte
Kurz gefasst informiert ein Fortschrittsbericht einen Vorgesetzten, einen Kollegen oder einen Kunden über den Fortschritt eines Projekts während eines bestimmten Zeitraums. Das Projekt kann der Entwurf, der Bau oder die Reparatur von etwas, die Untersuchung oder Erforschung eines Problems oder einer Frage oder das Sammeln von Informationen zu einem technischen Thema sein.
Sieh dir das vollständiges Kapitel bei dieser Art technischer Dokumentation.
Vorschläge
Kurz definiert ist ein Vorschlag ein Angebot oder eine Offerte, ein bestimmtes Projekt für jemanden durchzuführen. Was einen Vorschlag zu einem Vorschlag macht, ist, dass er die Adressaten darum bittet, das vorgeschlagene Projekt zu genehmigen, zu finanzieren oder die Erlaubnis zu erteilen, es durchzuführen.
Sieh dir das Komplettes Kapitel bei dieser Art von Techdokument.
Empfehlungs-, Machbarkeits- und Evaluationsberichte
Diese Gruppe ähnlicher Berichte tut unter anderem Dinge wie mehrere Optionen anhand eines Satzes von Anforderungen zu vergleichen und eine zu empfehlen; betrachtet eine Idee (Plan, Projekt) in Bezug auf ihre "feasibility,", zum Beispiel eine Kombination aus technischer, wirtschaftlicher oder sozialer Praktikabilität oder Möglichkeit; beurteilt den Wert oder Nutzen einer Sache, indem sie diese mit einem Satz von Anforderungen (Kriterien) vergleicht.
Sieh dir das vollständiges Kapitel zu diesen Arten von Tech-Dokumentationen.
Standardmäßige betriebliche Richtlinien und Verfahren
Dies sind die Betriebsdokumente für Organisationen; sie enthalten Regeln und Vorschriften darüber, wie die Organisation und ihre Mitglieder zu handeln haben. Richtlinien und Verfahren sind wie Anweisungen, gehen aber weit darüber hinaus. Standardarbeitsanweisungen (SOPs) sind eher für Verfahren, bei denen ein Prozess ausgeführt wird—zum Beispiel das Anfertigen eines Zahnabdrucks.
Sieh das Vollständiges Kapitel über diese Arten technischer Dokumentation.
Veröffentlichung eines technischen Buches
Demnächst...
Siehe die vollständiges Kapitel zu dieser Art von technischer Dokumentation.
Technologieorientierte Benutzerhandbücher
Kurz definiert, liefert ein Benutzerhandbuch für Computer technische Informationen darüber, wie man Computerhardware oder -software verwendet, einschließlich Anleitungen für Aufgaben wie Einrichtung, Konfiguration und grundlegende Tätigkeiten.
Siehe die vollständiges Kapitel über diese Art von technischer Dokumentation.
Weißbücher
Kurz definiert ist ein White Paper ein Technologie- oder Geschäftsdokument, das Hintergrundinformationen zu einem Projekt (Gerät, Methode usw.) liefert und dafür wirbt. White Papers sind vor allem im Internet zu beliebten Marketinginstrumenten für Unternehmen geworden, da viele potenzielle Kunden im Web nach Informationen suchen. Unternehmen nutzen White Papers, um Informationen oder neue Produkte als Lösungen zu verkaufen, die den Bedürfnissen ihrer Kunden dienen würden.
Sieh das Vollständiges Kapitel zu dieser Art technischer Dokumentation.
