Redação Técnica

Essas perguntas foram mostradas apenas aos entrevistados envolvidos com redação técnica.

12% dos entrevistados disseram estar envolvidos com redação técnica, embora apenas 9% tenham a redação técnica como seu cargo oficial.

Quando questionados sobre suas funções, os entrevistados puderam selecionar mais de uma opção.

Que tipo de documentação você escreve?

Em comparação com o ano passado, observamos um aumento de 5 pontos percentuais no número de desenvolvedores que criam documentação voltada para o cliente.

Quais ferramentas você usa para criar a documentação?

A abordagem de documentos como código (docs-as-code) está crescendo em popularidade, à medida que mais pessoas usam ferramentas de desenvolvimento para criar documentação: precisamente, 6 pontos percentuais a mais do que em 2021.

Qual linguagem de marcação você utiliza para escrever a documentação técnica?

O Markdown ainda é a linguagem de marcação mais popular, e 13% dos envolvidos em redação técnica usam tipos Markdown personalizados para enriquecer sua funcionalidade básica.

Você reutiliza o conteúdo entre diferentes documentos/guias?

Embora 80% dos entrevistados precisem reutilizar conteúdo, mais de um terço ainda copia e cola conteúdo semelhante manualmente.

6%

daqueles que escrevem documentos automatizam as verificações de documentação, com marcações quebradas, links externos e amostras de código sendo os testes mais populares usados. Curiosamente, 10% também automatizam verificações linguísticas.

58%

precisam documentar APIs e 61% gerar documentação de API automaticamente, optando por usar o Swagger na maioria das vezes.

30%

automatize o trabalho de rotina configurando modelos, principalmente automatizando diferentes tipos de tópicos, documentos e conteúdo repetido.

Para que tipo de coisas você configura templates?

47%

dos que usam templates criam templates parametrizados.

Qual é o idioma principal no qual você escreve a documentação?

O inglês é de longe o idioma principal mais popular para documentação técnica. O chinês vem em segundo lugar, bem distante.

68%

dos escritores técnicos consideraram o uso de uma ferramenta profissional para redação técnica.

Você já pensou em usar uma ferramenta profissional para redação técnica?

13% de todos os entrevistados envolvidos em redação técnica já traduzem sua documentação para outros idiomas e 10% planejam fazê-lo.

WritersideEAP

Você está entre os 68% que estão considerando uma ferramenta profissional para a criação de documentação?

Junte-se ao EAP (Programa de acesso antecipado) para experimentar uma nova ferramenta para escrever documentos técnicos, que:

Funciona com IDEs baseados no IntelliJ.
Oferece suporte para Markdown, marcação semântica e uma combinação de ambos.
Possui mais de 100 testes integrados para automação de qualidade de documentos.
Oferece suporte à reutilização de conteúdo com condições e variáveis.
Possui modelos integrados para vários tipos de conteúdo e elementos de marcação complexos.

Participe do nosso EAP