Rédaction technique

Ces questions n'ont été posées qu'aux participants impliqués dans la rédaction technique.

12 % des participants à l'enquête disent être impliqués dans la rédaction technique, mais seulement 9 % d'entre eux déclarent cela comme étant leur activité professionnelle.

Lorsqu'ils ont été interrogés sur leurs fonctions, les participants ont pu choisir plusieurs réponses.

Quel type de documentation rédigez-vous ?

Par rapport à l'année dernière, le nombre de développeurs qui rédigent de la documentation destinée aux clients a augmenté de 5 points de pourcentage.

Quels outils utilisez-vous pour créer de la documentation ?

L'approche « docs-as-code » a gagné en popularité. Dee plus en plus de personnes utilisent des outils de développement pour écrire de la documentation, 6 points de pourcentage de plus qu'en 2021 précisément.

Quel langage de balisage utilisez-vous pour rédiger la documentation technique ?

Markdown reste le langage de balisage le plus populaire et 13 % des personnes travaillant dans le domaine de la rédaction technique utilisent des versions personnalisées de Markdown pour enrichir ses fonctionnalités de base.

Réutilisez-vous du contenu entre différents documents / guides ?

80 % des répondants disent avoir besoin de réutiliser du contenu et plus d'un tiers d'entre eux copient et collent encore du contenu manuellement.

6 %

des personnes qui rédigent des documents automatisent les vérifications de la documentation en utilisant des tests pour les balises cassées, les liens externes et les extraits de code. 10 % d'entre elles automatisent également les vérifications linguistiques.

58 %

ont besoin de documenter des API et 61 % génèrent automatiquement une documentation sur les API, en choisissant d'utiliser Swagger la plupart du temps.

30 %

automatisent les tâches routinières en configurant des modèles, principalement pour l'automatisation de différents types de sujets, de documents et de contenus répétitifs.

Pour quel genre de choses configurez-vous des modèles ?

47 %

des personnes qui utilisent des modèles créent des modèles paramétrés.

En quelle langue écrivez-vous la documentation principalement ?

L'anglais est de loin la langue la plus utilisée pour la documentation technique. Le chinois arrive en deuxième place, mais loin derrière.

68 %

des rédacteurs techniques ont envisagé d'utiliser un outil professionnel pour la rédaction technique.

Avez-vous déjà envisagé d'utiliser un outil professionnel pour la rédaction technique ?

13 % des répondants impliqués dans la rédaction technique traduisent leur documentation dans d'autres langues et 10 % prévoient de le faire.

WritersideEAP

Faites-vous partie des 68 % de développeurs qui envisagent d'utiliser un outil professionnel pour la création de documentation ?

Rejoignez le programme d'accès anticipé pour essayer un nouvel outil de rédaction de documents techniques, qui :

Fonctionne avec les IDE basés sur IntelliJ.
Prend en charge du format Markdown, le balisage sémantique et la combinaison des deux.
Plus de 100 tests intégrés pour l'automatisation de la qualité de la documentation.
Possibilité de réutiliser le contenu avec des conditions et des variables.
Fournit des modèles intégrés pour divers types de contenus et d'éléments de balisage complexes.

Essayez la version EAP