Notizen:
• Die Kapitel in diesem Lehrbuch wurden mit OpenAI übersetzt und können Fehler enthalten. Wenn Sie Probleme mit den Übersetzungen finden, senden Sie bitte Korrekturen an den Autor unter admin@mcmassociates.io.
• Wenn Sie hier veraltete oder ungenaue Technologien finden, sind Sie ebenfalls eingeladen, Korrekturen zu senden. Denken Sie jedoch daran, dass dies ein Buch über technisches Schreiben ist, nicht ein Technologiemanual—ältere Technologien können dennoch nützliche Beispiele bieten.
• Spenden, um zu behalten Online-Technisches Schreiben Lehrbuch frei.
• Während du hier bist, schicke David eine freundliche E-Mail: admin@mcmassociates.io
Eine große Veränderung ist über dieses Online-Buch zum technischen Schreiben gekommen: Es verwendet jetzt Technisches Dokument (Technisches Dokument kurz) um auf jedes Dokument zu verweisen, das technische Informationen enthält — anstatt zu verwenden Bericht. Der Bericht ist eine Unterkategorie zusammen mit den anderen Arten technischer Dokumente, die in diesem Buch besprochen werden.
Einführung: Technisches Schreiben
- Was gibt's Neues?
- Über technische Dokumentation
- Über technische Schreibkurse
- Ressourcen
- Über den Autor
- Danksagungen
- Links zu Nachschlagewerken
Anwendungen des technischen Schreibens
Hinweis: Dieses Online-Lehrbuch verwendet jetzt Technisches Dokument, oder einfach Technisches Dokument, in Fällen, in denen Bericht ist zu spezifisch. (UN-Embleme) zeigen an, dass Übersetzungen verfügbar sind, wenn Sie den Link anklicken.
- Umfrage zu Techdocs
- Geschäfts- und Beschäftigungsdokumente:
- Datenberichte
- Geschäftspläne
- Vorschläge
- Empfehlungs- und Machbarkeitsberichte
- Weißbücher
- Fortschrittsberichte
- Anleitungen
- Hintergrundberichte
- Technischer Entwurfsbericht
- Technologieorientierte Benutzerhandbücher
- Spezifikationen und Datenblätter
- Versionshinweise
- Anwendungsfälle, Fallstudien
- Standardbetriebspolitiken und -verfahren
- Primärforschungsberichte. Für Labor und Feld.
- Literaturübersichten
- Leitfäden und Richtliniendokumente
- Handbücher
- Vorder- und Nachsatz:
Informationsstrukturen
Informationsstrukturen werden als Teile längerer Dokumente verwendet, können jedoch auch als eigenständige Dokumente genutzt werden, insbesondere für technische Schreibprojekte. Diese Informationsstrukturen sind ein guter Ausgangspunkt für Personen im Bereich der Entwicklungs-Technikschriftstellerei.
Dokumentgestaltung
- Techdoc-Design-Überblick
- Überblick über das Buchdesign
- Seitenlayout-Übersicht
- Überschriften
- Listen
- Besondere Hinweise
- Nicht-Textuelles: Tabellen, Abbildungen, Diagramme
- Techdoc-Format und endgültige Verpackung
- Hervorhebung und Betonung
- Indizierung
Prozesse und Richtlinien im technischen Schreiben
- Schreibprozess: von der Zielgruppe zum Rohentwurf
- Zielgruppenanalyse
- Aufgabenanalyse
- Übersetzung technischer Informationen
- Power-Überarbeitungstechniken
- Informationsverarbeitung
- Information sammeln (NoodleTools oder Notebook LM)
- Zitate, Paraphrasen, Zusammenfassungen: Formulierung, Interpunktion, Zuordnung
- Grundlegende Muster und Elemente des Satzes
- Häufige Grammatik-, Gebrauch- und Interpunktionsprobleme
- Allgemeine Rechtschreibprobleme
- Strategien für Peer-Review und Teamarbeit
