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.

Welche Arten von Dokumentationen schreiben Sie?

86%

Interne Dokumentation

61%

Code-Dokumentation

57%

Kundendokumentation

1%

Sonstige

Im Vergleich zum vergangenen Jahr hat die Anzahl der Entwickler*innen, die Dokumentationen für Kunden verfassen, um 5 Prozentpunkte zugenommen.

Welche Tools verwenden Sie zum Schreiben von Dokumentationen?

46%

Individualisierbarer Texteditor 

32%

Confluence

28%

Office-Anwendung

24%

GitHub Pages

24%

Google Docs

21%

Eine Wiki-Plattform

2%

Eine professionelle Authoring-Lösung für Hilfedateien

15%

Sonstige

2%

Keinen

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.

Welche Markup-Sprache verwenden Sie für die technische Dokumentation?

77%

Markdown

18%

Ich weiß es nicht / Ich verwende einen WYSIWYG-Editor oder eine Office-ähnliche Anwendung

13%

Eine spezielle Markdown-Variante

5%

AsciiDoc

5%

XML / DITA / DocBook / usw.

4%

reStructuredText

4%

Sonstige

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.

Werden Ihre Inhalte in verschiedenen Dokumenten/Anleitungen wiederverwendet?

42%

Ja, ich speichere wiederverwendbare Inhalte in Snippets und verweise auf sie in verschiedenen Dokumenten

37%

Nein, meine Tools unterstützen Single-Source nicht, also kopiere ich ähnliche Inhalte und füge sie ein

20%

Nein, ich muss keine Inhalte wiederverwenden

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.

Für welche Arten von Inhalten konfigurieren Sie Vorlagen?

74%

Verschiedene Arten von Themen/Dokumenten

46%

Sich wiederholende Inhalte wie Hinweisblöcke

26%

Komplexe Markup-Elemente

47%

derjenigen, die Vorlagen verwenden, parametrisieren diese.

In welcher Sprache schreiben Sie Ihre Dokumentation hauptsächlich?

63%

Englisch

22%

Chinesisch

6%

Japanisch

1%

Französisch

1%

Koreanisch

1%

Russisch

6%

Sonstige

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.

Haben Sie darüber nachgedacht, ein professionelles Tool für technische Dokumentation zu verwenden?

68%

45%

Ja

32%

55%

Nein

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.
Technisches Schreiben:

2022

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.

Wenn Sie Fragen oder Anregungen haben, schreiben Sie uns bitte unter surveys@jetbrains.com.