Redação Técnica

Compartilhar:

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?

86%

Documentação interna

61%

Documentação do código

57%

Documentação do cliente

1%

Outros

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?

46%

Um editor de texto personalizável 

32%

Confluence

28%

Uma aplicação para escritório

24%

GitHub Pages

24%

Google Docs

21%

Uma plataforma Wiki

2%

Uma solução de criação de ajuda profissional

15%

Outros

2%

Nenhuma opçã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?

77%

Markdown

18%

Não tenho certeza/utilizo um editor WYSIWYG ou um aplicativo semelhante ao Office

13%

Um tipo personalizado de Markdown

5%

AsciiDoc

5%

XML/DITA/DocBook/etc.

4%

reStructuredText

4%

Outros

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?

42%

Sim, armazeno conteúdo reutilizável em snippets e faço referência a eles de diferentes documentos

37%

Não, minhas ferramentas não suportam fonte única, então copio e colo conteúdo semelhante

20%

Não, não preciso reutilizar conteúdo

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?

74%

Diferentes tipos de tópicos/documentos

46%

Conteúdo repetido, como blocos de advertência

26%

Elementos de marcação complexos

47%

dos que usam templates criam templates parametrizados.

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

63%

Inglês

22%

Chinês

6%

Japonês

1%

Francês

1%

Coreano

1%

Russo

6%

Outros

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?

68%

45%

Sim

32%

55%

Não

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.
Redação Técnica:

2022

Obrigado pelo seu tempo!

Esperamos que você tenha achado nosso relatório útil. Compartilhe este relatório com seus amigos e colegas.

Se tiver dúvidas ou sugestões, entre em contato conosco em surveys@jetbrains.com.