Technisches Schreiben
Teilen:
Diese Fragen wurden nur Befragten gestellt, die mit technischer Dokumentation befasst sind.
12% der Befragten gaben an, sich mit technischer Redaktion zu befassen. Allerdings ist dies nur bei 9% die offizielle Arbeitsrolle.
Bei der Frage nach ihren beruflichen Rollen konnten die Befragten mehrere Antworten auswählen.
Im Vergleich zum vergangenen Jahr hat die Anzahl der Entwickler*innen, die Dokumentationen für Kunden verfassen, um 5 Prozentpunkte zugenommen.
Der Dokumentation-als-Code-Ansatz wird immer beliebter, und immer mehr Menschen verwenden Entwicklungstools für die Erstellung von Dokumentationen – 6 Prozentpunkte mehr als 2021, um genau zu sein.
Markdown ist nach wie vor die gängigste Auszeichnungssprache. 13% derjenigen, die sich mit technischer Redaktion befassen, verwenden spezielle Markdown-Varianten, um die Grundfunktionen zu erweitern.
Obwohl 80% der Befragten Inhalte wiederverwenden müssen, setzt mehr als ein Drittel auf manuelles Kopieren und Einfügen.
6%
derjenigen, die Dokumentationen schreiben, nutzen automatisierte Dokumentationsprüfungen, wobei Prüfungen auf fehlerhaftes Markup, externe Links und Codebeispiele am meisten verwendet werden. Interessanterweise verwenden 10% auch automatisierte Sprachprüfungen.
58%
müssen APIs dokumentieren und 61% lassen die API-Dokumentation automatisch generieren, wobei meist Swagger zum Einsatz kommt.
30%
automatisieren Routinearbeiten, indem sie Vorlagen konfigurieren. Dabei werden meist verschiedene Arten von Themen, Dokumenten und wiederkehrenden Inhalten automatisiert.
47%
derjenigen, die Vorlagen verwenden, parametrisieren diese.
Englisch ist bei weitem die gängigste Hauptsprache für technische Dokumentation. Chinesisch steht mit großem Abstand an zweiter Stelle.
68%
der technischen Redakteur*innen haben bereits über den Einsatz eines professionellen Tools für technische Dokumentation nachgedacht.
13% der Befragten, die in der technischen Redaktion tätig sind, lokalisieren ihre Dokumentation in andere Sprachen, und weitere 10% haben dies vor.
WritersideEAP
Gehören Sie zu den 68%, die den Einsatz eines professionellen Tools für die technische Dokumentation erwägen?
Nehmen Sie an unserem Early-Access-Programm teil und testen Sie ein neues Tool für die technische Redaktion, das folgende Vorteile bietet:
- Kompatibilität mit IntelliJ-basierten IDEs.
- Unterstützung von Markdown, semantischen Markups und Kombinationen von beidem.
- Über 100 integrierte Tests zur automatisierten Prüfung der Dokumentationsqualität.
- Wiederverwendung von Inhalten mit Bedingungen und Variablen.
- Integrierte Vorlagen für verschiedene Inhaltstypen und komplexe Markup-Elemente.
Danke, dass Sie sich die Zeit genommen haben!
Wir hoffen, dass Sie unseren Bericht nützlich fanden. Teilen Sie diesen Bericht im Freundes- und Kollegenkreis.
Nehmen Sie an unseren zukünftigen Umfragen teil!
Rohdaten
Die Rohdaten unserer DevEco-Umfrage 2022 sind jetzt verfügbar. Laden Sie diese herunter, erkunden Sie sie und holen Sie sich Ihre eigenen Erkenntnisse!
HerunterladenWenn Sie Fragen oder Anregungen haben, schreiben Sie uns bitte unter surveys@jetbrains.com.