Technical Writing: aprenda estratégias, ferramentas e boas práticas
O que é Technical Writing? - Apresentação
Olá, boas-vindas ao primeiro curso da formação de Technical Writing (Escrita Técnica) aqui da Alura!
Me chamo Mari Moreira, sou instrutora da Escola de UX e Design para os cursos de Technical Writing.
Audiodescrição: Mari Moreira é uma mulher branca, de cabelos e olhos escuros. Veste uma camiseta preta e está no estúdio da Alura. Ao fundo, há uma luz gradiente roxa com alguns objetos de decoração, tanto numa prateleira como também com algumas plantas.
Trabalho com o Tech Writing há alguns anos, já são mais de três anos nessa trajetória, tanto como Tech Writer, como também gestora. Atualmente, trabalho como líder de um time de documentação técnica no Mercado Pago.
O que vamos aprender?
Nosso propósito ao guiá-lo neste curso é proporcionar as ferramentas essenciais para compreender o campo da Tech Writing, especialmente se esta for sua primeira experiência. Para alcançar esse objetivo, abordaremos temas fundamentais, incluindo definições de Technical Writing, uma análise dos diversos tipos de documentação técnica presentes no mercado, bem como a exploração de outros formatos de conteúdo, exemplificado pelo "Guia do Usuário", entre outros tópicos relevantes.
Abordaremos também sobre arquitetura da informação e boas práticas de escrita para documentações, e fechamos entendendo um pouco sobre planejamento e análise de documentações.
Para quem é este curso?
Este curso foi desenvolvido especialmente para profissionais da área de tecnologia, como aqueles envolvidos no desenvolvimento de software. Se você trabalha de alguma forma com documentação em seus projetos, este curso é para você. Acima de tudo, destina-se a indivíduos que buscam aprimorar sua comunicação técnica e compreender como elaborar documentações eficazes para auxiliar as pessoas usuárias a alcançarem seus objetivos.
Lembre-se, todo conhecimento adquirido neste curso, assim como dúvidas que possam surgir, podem ser discutidos na Comunidade da Alura no Discord ou no fórum.
Prontos para explorar o mundo do Technical Writing e da documentação técnica?
Vamos lá!
O que é Technical Writing? - O que é Technical Writing
Vamos entender sobre Technical Writing (Escrita Técnica).
Entendendo Technical Writing
Neste vídeo, abordaremos dois tópicos essenciais que consideramos como o ponto de partida principal.
O que vamos aprender neste vídeo
- Introdução à área de Technical Writing;
- Objetivos de TW dentro da área de tecnologia.
O primeiro destes consiste em uma introdução à área, onde apresentamos o conceito de Technical Writing, aproximando essa disciplina da tecnologia no seu cotidiano e auxiliando na sua familiarização com o tema. Em seguida, discutimos brevemente sobre os objetivos, ou seja, as atividades e a atuação desse profissional dentro das empresas e equipes de TI.
Contextualizando
Antes de abordar isso, achamos crucial oferecer um breve contexto e, principalmente, começar a tornar esse assunto mais tangível.
Expressamos isso porque compreendemos que, inicialmente, Technical Writing pode parecer algo distante de nossa realidade, como se nunca tivéssemos tido um primeiro contato com ele. No entanto, estamos aqui para demonstrar o oposto e afirmar que, na realidade, Technical Writing está mais próximo de nossa rotina do que imaginamos.
O exemplo mais ilustrativo que podemos oferecer é, literalmente, desta foto, que pode parecer uma montagem, mas, na verdade, é minha. Sim, de fato, tenho essa caixa em casa repleta de manuais de diversos produtos.
Quem nunca precisou montar um móvel quando estava se mudando? Uma cadeira, uma mesa, ou ainda, compreender como ligar um eletrodoméstico em casa? Apesar de não parecer, todos esses documentos presentes nessa foto já constituem documentações. Assim, cada vez que você adquiriu um produto ou serviço, mesmo sem saber, já estava entrando em contato com o Technical Writing e com a documentação técnica.
Para facilitar ainda mais, decidimos apresentar dois exemplos que compartilharemos em nossa tela agora. O primeiro é um manual que encontramos na internet sobre montagem, e observe o quão interessante é. Por que isso constituiria uma documentação técnica? Porque, em primeiro lugar, há uma foto do móvel, nos permitindo visualizar como é o produto.
Ao abrir a embalagem, confirmamos se é o produto que adquirimos, proporcionando um contexto à pessoa usuária. Em seguida, encontramos uma variedade de informações técnicas, como os detalhes técnicos do sofá, incluindo a composição do estofamento, tecido, etc., que podem ser úteis.
Reconhecemos que, normalmente, lemos e não internalizamos a importância disso. No entanto, para prestadores de serviço ou para aqueles que precisam verificar o padrão de qualidade, isso é crucial. Além disso, proporciona visibilidade para nós, pessoas usuárias, sendo uma transparência em relação ao produto e serviço que adquirimos. Inclui informações essenciais, as partes do sofá e suas dimensões, seguidas pelas etapas de montagem.
Perceba que, mesmo sendo um produto simples, como um sofá com estofado, observe como foi documentado de maneira que conseguimos compreender exatamente tudo sobre ele. Compreendemos sua composição, tamanho, partes e todas as etapas necessárias para, ao final, obtermos precisamente esse sofá a partir do início.
Agora, exemplificando mais proximamente com a tecnologia, evitando abstração em relação aos móveis, apresentamos outro caso de produto intimamente ligado ao nosso cotidiano, especialmente pós-pandemia: o Zoom , um aplicativo de videoconferências e reuniões. Note o quão fascinante é essa documentação disponível no suporte do Zoom, repleta de conteúdos que instruem sobre o uso do aplicativo.
Sabemos que, talvez, para você que trabalha em tecnologia ou está muito inserido nesse contexto, pode parecer algo muito óbvio, mas precisamos considerar que podem ter pessoas novas começando a usar a ferramenta e que não têm o mesmo contexto. Portanto, ter essas documentações é fundamental para contextualizar para a pessoa usuária como são os recursos do Zoom, e, acima de tudo, como usá-los no dia a dia.
Vamos abrir um exemplo de como ingressar em uma reunião, clicando em "How to join a meeting" (como entrar em uma reunião). O tutorial fornece todas as etapas necessárias, incluindo um recurso adicional de vídeo do lado direito que podemos reproduzir para visualizar o procedimento completo. Além da opção de reunião, existem outras funcionalidades, como conectar o áudio e personalizar o fundo do quadro em videochamadas, entre outras opções.
Até o momento, acreditamos que já conseguimos provar que isso está realmente muito próximo do nosso dia a dia. Technical Writing está mais próximo da nossa realidade do que pensamos no primeiro contato.
O que é Technical Writing?
Finalmente, abordamos o conceito. Compreendamos, na parte conceitual, o que é Technical Writing. Seguindo a própria definição da Society for Technical Communication (Sociedade de Comunicação Técnica), principal órgão regulador da área:
"Technical Writing envolve comunicar informações complexas para aqueles que precisam realizar uma tarefa ou atingir um objetivo".
Em outras palavras, trabalhar com Technical Writing é exatamente fazer esse exercício de comunicar informações, ou seja, traduzir essas informações que, num primeiro contato, parecem complexas e pouco acessíveis, com o objetivo de transformar tudo isso em conteúdos que sejam úteis e acessíveis para o nosso público.
Para facilitar ainda mais e mostrar um pouco como é a nossa dinâmica de trabalho no dia a dia, resolvemos trazer uma imagem que gostamos muito e que acreditamos que ilustra bastante como é o nosso dia a dia de trabalho, mas, acima de tudo, o objetivo que, no final das contas, temos.
Costumamos dizer que comunicar informações complexas dentro das empresas é exatamente ter esse objetivo de comunicar com diferentes áreas para pegar essas informações e transformá-las em conteúdos que sejam acessíveis. A sensação que dá é quase essa mesma, de visualizar várias informações circulando entre os times.
Por exemplo, nessa imagem, poderíamos ter o time de desenvolvimento, de produto, de negócio, de UX, entre outros que poderiam também aparecer nessa conjuntura. Eles estão criando informações, criando produtos ou atualizando funcionalidades de um produto, estão criando insumos para o nosso trabalho.
Muitas vezes, essa criação é desordenada, ou seja, ela está acontecendo de uma forma extremamente orgânica e que está a todo vapor, as sprints estão acontecendo nos times e esses insumos estão sendo gerados.
Nosso objetivo dentro das empresas, ao gerenciar esse conhecimento, é precisamente tentar desatar esses nós, buscando essas informações nos times para começarmos a desembaraçar essas informações.
Nesse momento é que entramos no fluxo, desembaraçando essas informações para que, no final da ponta, onde está a pessoa usuária final – seja ela técnica ou não, pois o público final pode incluir desenvolvedores, por exemplo –, essa pessoa visualize essa linha enrolada sem nenhum nó, sem nenhum embaraço.
Diríamos que esse é o nosso principal objetivo, estamos dentro das empresas para pegar essas informações que são muitas vezes criadas, mas elas não são organizadas de uma forma que fica acessível não só para nós que estamos criando esse produto, mas principalmente para você que é pessoa usuária final e que precisa consumir um produto ou serviço.
Conclusão
No próximo vídeo vamos conversar um pouco sobre quais são as semelhanças e diferenças com outro tipo de escrita que temos quase certeza que você também já conhece, que é o UX Writing .
Aprenderemos isso no próximo vídeo.
Até lá!
O que é Technical Writing? - Technical Writing x Ux Writing
No vídeo anterior, contamos um pouco sobre o que é Technical Writing e quais objetivos essa pessoa profissional costuma ter dentro do ecossistema de tecnologia. Agora, compreendemos um pouco sobre a relação entre a Technical Writing e a UX Writing. Afinal, são dois tipos de escrita distintos. Onde eles se diferenciam e onde se assemelham?
É como se a UX Writing e a Technical Writing fossem primas dentro das áreas da escrita. Elas têm algumas similaridades e é sobre isso que discutiremos agora.
Technical Writing vs UX Writing
TECH E UX WRITING: SEMELHANÇAS
- Textos com foco na usabilidade e experiência;
- Menos é mais: textos mais objetivos e concisos;
- O texto como meio de orientar uma ação.
Quando pensamos tanto na Technical Writing quanto na UX Writing, os pontos em comum ocorrem porque ambas as escritas têm alguns objetivos em comum. O primeiro deles é realmente trabalhar o texto com foco na experiência e na usabilidade.
Tanto a pessoa Tech Writer quanto a UX Writer, ao criar seu conteúdo, pensam no público que vai ler essa informação. Há uma preocupação grande em tornar o texto e a informação o mais acessível possível, para que a experiência de quem está lendo seja a melhor e mais intuitiva possível.
Outro ponto de convergência tanto da Tech Writing quanto da UX Writing, é a questão da objetividade e concisão. Ambas trabalham com a premissa de que "menos é mais". Se for necessário escrever uma informação em três linhas, por exemplo, nós não a escreveremos em cinco, mas em três. Ser o mais objetivo possível, para que a informação seja passada de uma forma mais fácil, também é levado em conta tanto pelo UX quanto pela Technical Writing.
Por fim, um outro ponto em comum bastante forte entre as duas escritas é a orientação. Tanto a Tech quanto a UX Writing trabalham com o texto para que ele sempre tenha um fio condutor para orientar a pessoa a realizar uma ação.
Por exemplo, quando abrimos um aplicativo e efetuamos um login, todas as informações que estão ali, os campos que precisam ser preenchidos, estão nos orientando a executar uma ação, que nesse caso é fazer um login no aplicativo. Quando lemos uma documentação técnica de instalação de um produto, qual é a ação que ela está nos orientando? A instalação desse produto.
Agora, você pode estar se perguntando: "Mas eles são muito parecidos. Como começo a fazer essa diferenciação? Como consigo identificar onde começa um e onde começa o outro?" É exatamente sobre isso que entenderemos agora.
TECH E UX WRITING: DIFERENÇAS
Technical Writing
- Escrita que usa palavras mais técnicas.
- Presença maior nos times de desenvolvimento / TI.
- Formatos de conteúdo: documentação técnica, guias do usuário, tutoriais, etc.
No âmbito do Technical Writing, a primeira distinção reside na natureza intrinsecamente técnica dos textos, conforme implicitamente indicado pelo próprio nome da disciplina. Ao acessar uma documentação técnica ou um tutorial específico, exemplificando alguns formatos de conteúdo em Tech Writing, é perceptível a formalidade e o caráter técnico do texto. Mesmo que o jargão técnico seja objeto de tradução, a essência permanece técnica.
Outro aspecto relevante é o ambiente em que esses profissionais atuam nas empresas. Tech Writers, por exemplo, comumente integram-se aos times de desenvolvimento e tecnologia. Frequentemente colaboram em squads junto aos desenvolvedores, QA e outros especialistas técnicos.
Por fim, em relação aos próprios formatos de conteúdo que os Tech Writers escrevem: documentações, tutoriais, guias do usuário e assim por diante. Lembrando que, ao longo deste curso, entenderemos sobre cada um desses formatos para que você também ganhe familiaridade.
UX Writing
- Escrita mais amigável e conversacional.
- Presença maior nos times de UX e Design.
- Formatos de conteúdo: microtextos, tom de voz, etc.
O UX Writing abrange textos amigáveis e conversacionais, visando a comunicação do produto com o usuário durante sua jornada. Por exemplo, ao realizar o cadastro ou executar ações específicas em um aplicativo, como uma transação bancária, um investimento ou a redefinição de senha, se necessário.
Profissionais dessa área estão mais integrados à esfera de UX, conforme o próprio nome sugere, e ao time de design. Enquanto na Tech Writing tínhamos uma proximidade maior com os desenvolvedores, na UX Writing essa proximidade se estende ao time de design e UX.
Em relação aos formatos de conteúdo, como estão mais próximos do time de design e de UX, é natural que, além dos microtextos (que são justamente essas frases e sentenças que encontramos nas etapas de um aplicativo), também tenhamos tom e voz, entre outros formatos de conteúdo.
Para tornar ainda mais fácil, resolvemos resgatar o exemplo do Zoom, que aprendemos no vídeo anterior, para tornar essa diferenciação ainda mais evidente.
Na imagem temos o aplicativo do Zoom. Essa é exatamente a tela inicial do aplicativo, quando baixado no computador. Quando entramos, notamos que há alguns botões com orientações de se inscrever, de entrar ou de ingressar em uma reunião. Nesse caso, simulamos que íamos ingressar em uma reunião.
Quando fizemos isso, automaticamente abriu uma aba em que tínhamos que informar as informações da reunião para entrar nela. Como não havia reunião nenhuma, obviamente, não preenchemos essas informações, mas percebemos que o texto é muito mais objetivo, são textos curtos, são os microtextos do aplicativo.
Já no texto do Tech Writer, que é a imagem exatamente ao lado, temos a documentação técnica de como ingressar em uma reunião e todo o passo a passo ali listado, inclusive com o vídeo ao lado. Para tornar esse exemplo mais tangível, vamos dar uma outra comparação que gostamos muito, que é o do jogo do tabuleiro. Pense no seu jogo favorito, pode ser qualquer jogo de tabuleiro.
Imaginamos que o jogo que você pensou tem um tabuleiro e nesse tabuleiro tem vários textos que te indicam, por exemplo, quando você perde a vez, ou quando é a linha de chegada, a linha de partida para começar o jogo e você atravessar o tabuleiro com a sua peça. Independente de qual jogo você escolheu, com certeza tem algum texto na interface desse tabuleiro. Esse texto é um texto de UX Writer.
O Tech Writer seria o manual de instruções do jogo. Afinal de contas, por mais que você tenha pensado em um jogo que seja muito comum, é possível que em algum momento você teve que jogar esse jogo com alguém que nunca tinha conhecido esse jogo, não sabia nem por onde começava.
E o manual de instrução, nesse caso, é fundamental, porque é ele que define os critérios de quem ganha, de quem perde, de quem pula a vez, que pode acontecer dependendo do jogo, quantas pessoas podem jogar e assim por diante.
Conclusão
Ao observarmos exemplos como o Zoom ou um jogo de tabuleiro, desenvolvemos uma maior facilidade em distinguir as escritas e compreender que, embora sejam semelhantes, possuem diferenças fundamentais. Essas diferenças são essenciais para que os profissionais possam atuar com profundidade em cada uma dessas especialidades.
No próximo vídeo, abordaremos o projeto do curso, destacando a parte prática.
Contamos com a sua presença lá!
Sobre o curso Technical Writing: aprenda estratégias, ferramentas e boas práticas
O curso Technical Writing: aprenda estratégias, ferramentas e boas práticas possui 166 minutos de vídeos, em um total de 48 atividades. Gostou? Conheça nossos outros cursos de Softskills e Carreira em Inovação & Gestão, ou leia nossos artigos de Inovação & Gestão.
Matricule-se e comece a estudar com a gente hoje! Conheça outros tópicos abordados durante o curso:
- O que é Technical Writing?
- Tipos de documentação técnica
- Boas práticas de escrita para documentação
- Outros formatos de conteúdo técnico
- Planejamento e análise de documentações