Se você deseja trabalhar com tecnologia, mas prefere escrever palavras em vez de código, a redação técnica pode ser o emprego dos seus sonhos. Para saber mais sobre o que um redator técnico realmente faz (e quanta escrita e/ou codificação está envolvida), perguntamos Mike Jang, redator técnico há mais de 20 anos e atualmente é redator técnico principal de NGINX em F5.
O que um redator técnico faz?
Em termos mais simples, um redator técnico escreve instruções (geralmente chamadas de documentação) para usuários de produtos. No contexto de construção e implantação de software, a documentação normalmente é para desenvolvedores, mas administradores de sistemas, engenheiros de segurança e Engenheiros DevOps todos podem cair sob este guarda-chuva também.
A redação técnica anterior normalmente atendia aos usuários finais dos produtos, e não aos construtores e mantenedores. Mas como a maioria dos aplicativos de consumo são projetados para serem autoexplicativos para os usuários, a documentação agora é geralmente para desenvolvedores e outros profissionais que criam, executam e mantêm o software e a infraestrutura subjacentes desses aplicativos. A redação técnica é diferente da escrita UX, que se refere às palavras que você encontra em produtos digitais (como barras de navegação, menus e botões).
Como é um dia de trabalho típico para um redator técnico?
Embora escrever documentação seja a parte mais óbvia do trabalho de um redator técnico, na verdade é o elemento no qual você provavelmente gastará menos tempo em seu trabalho diário. “Escrevo talvez um quarto do meu tempo”, diz Mike. O resto do dia é composto por atividades como:
Configurando e testando software
Descobrir o processo e o cronograma para o lançamento de um novo recurso
Identificando e enviando relatórios de bugs
Os redatores técnicos normalmente escrevem sobre novos recursos que ainda não foram documentados ou lançados, diz Mike. Experimentar neste estágio inicial naturalmente leva à descoberta de bugs e à colaboração com o desenvolvimento para determinar soluções alternativas. Embora registrar bugs pareça uma diversão, Mike diz que na verdade é uma grande parte do que torna a função gratificante. “Quando finalmente chego à solução, penso: ‘Uau, isso realmente funciona! Mal posso esperar para escrever sobre isso.’”
Você precisa saber codificar para ser um redator técnico?
Em algumas empresas, os redatores técnicos pegam a documentação escrita pelos desenvolvedores e a processam em uma linguagem legível que segue os padrões de documentação e o guia de estilo de uma organização, ou escrevem a documentação com base em entrevistas com os desenvolvedores que escreveram o código. Nesses casos, você não precisa ter experiência com programação, mas Mike é um grande defensor da prática do produto sobre o qual você está escrevendo. “Pessoalmente, não sinto que posso escrever com credibilidade sobre algo, a menos que eu mesmo o tenha usado”, diz ele.
Existem algumas situações em que os redatores técnicos precisam de algum conhecimento de codificação:
Implementando Documentos como Código
Documentos como código, a filosofia de que você deve escrever documentação usando as mesmas ferramentas do código está se tornando mais popular na comunidade de redação técnica. Sob este modelo, os redatores técnicos usam ferramentas de código como controle de versão e integração contínua para criar, processar e publicar documentação. Essa abordagem ajuda os redatores técnicos a trabalharem em melhor alinhamento com os fluxos de trabalho de desenvolvimento e a garantir consistência em toda a documentação de um produto.
“Você quer ‘escrever uma vez e publicar em qualquer lugar’”, diz Mike. “Portanto, você usa a mesma terminologia e explicações para descrever conceitos técnicos em toda a sua documentação.” Por exemplo, você pode definir variáveis para armazenar uma explicação e, em seguida, inserir essa variável onde for necessário na documentação.
Ficar confortável com esse fluxo de trabalho, terminologia e ferramentas (como GitHub) ajudará você a se destacar se estiver iniciando uma carreira em redação técnica. Nosso Aprenda o curso Git e GitHub é um ótimo lugar para começar.
Colaborando com o desenvolvimento
Embora os redatores técnicos não tenham a tarefa de codificar sozinhos, colaborar com os desenvolvedores é uma parte significativa do trabalho. Nesses cenários, é sempre útil estar pronto e disposto a se aprofundar no código. “Se eu testar um novo recurso e algo não funcionar como esperado, posso ir até os desenvolvedores e dizer: ‘Experimentei essas etapas, é assim que deveria funcionar, mas o que estou vendo não funciona. não combina’”, diz Mike. “Agora estamos fazendo parceria para encontrar uma solução, em vez de minha solicitação ficar em atraso.”
Trabalhando com trechos de código
É comum que a documentação inclua exemplos de código, por isso é útil se você mesmo puder escrevê-los ou revisá-los, diz Mike. “Pense nas diferentes opções de login único que você normalmente tem agora – você pode fazer login no Google, na Amazon e assim por diante”, diz Mike. “Esses provedores incluem trechos de código que você pode incorporar ao software da sua empresa, mas você precisa entender se os padrões funcionam no seu caso, ou você (ou seus leitores) podem precisar modificar seus trechos.”
Não sabe por onde começar quando se trata de aprender a programar? Confira o caminho de habilidade Fundações de código para conhecer os conceitos básicos de codificação que se traduzem em linguagens e domínios de programação.
Você precisa ser um escritor forte?
Enquanto muitos Acontece que os redatores técnicos têm formação em inglês ou comunicações, ser um escritor polido é menos importante do que ser um pensador e comunicador claro nesta função, diz Mike. “Se o pensamento de alguém é claro, isso transparece na sua escrita. Acredito que uma forte compreensão da linguagem se tornará menos importante no futuro”, diz ele. “Já existem ferramentas de IA que podem ajudá-lo a melhorar a gramática e a legibilidade do seu trabalho (como Grammarly ou o aplicativo Hemingway).”
Enquanto outros textos sobre tecnologia (como marketing de conteúdo ou direitos autorais) servem para contar histórias, persuasão e engajamento, os textos técnicos tratam da comunicação com clareza e precisão. “Você notará diferenças distintas entre os guias de estilo de marketing e os guias de estilo de redação técnica”, diz Mike. “Os redatores técnicos nunca usam palavras como ‘simples’ ou ‘fácil’!”
Qual é o papel da IA na redação técnica?
Embora a IA não tenha como objetivo automatizar o trabalho dos redatores técnicos, as ferramentas de redação de IA podem ajudar a tornar a redação técnica mais eficiente. Isto é, desde que a ferramenta seja segura e não exponha dados ou códigos proprietários da empresa (isso realmente aconteceu na Samsung no ano passado). Existem maneiras de contornar esse risco, como complementar um modelo de linguagem grande com um “modelo de linguagem pequena” de informações proprietárias que são mantidas em segurança.
Como outros profissionais de IA, os redatores técnicos precisam discernir o momento certo para usar as ferramentas de IA e compreender suas limitações. “Sua empresa pode ter uma grande página do Confluence com muitas informações proprietárias sobre como seu produto funciona”, diz Mike. “Uma ferramenta de IA pode processar isso em um resumo bem escrito que um ser humano pode revisar e editar – potencialmente uma grande economia para redatores técnicos.”
Você precisa de um portfólio de redação técnica?
Alguns formulários de emprego de redação técnica solicitarão amostras de redação. “Uma empresa pode pedir que você escreva uma descrição de como criar um sanduíche de manteiga de amendoim e geleia, por exemplo”, diz Mike. (O exercício do sanduíche faz parte do nosso Caminho de habilidade do Code Foundations se você quiser experimentar por si mesmo!)
Em muitos casos, você pode usar um exemplo existente se já tiver alguma experiência em redação técnica que seja relevante para o setor e a função para a qual está se candidatando. Não entre em pânico se você não tiver amostras – você pode escrever algo original com base nos requisitos da aplicação. Se você está procurando emprego ativamente, vale a pena criando um site de portfólio: “Criar um site usando qualquer ferramenta Docs as Code razoável ilustrará não apenas sua experiência em redação, mas sua capacidade de usar ferramentas de documentação técnica”, diz Mike. Você pode conferir Site profissional do próprio Mike, com o qual ele construiu GitLab e o gerador de sites estáticos Hugo, por exemplo.
Onde se conectar com redatores técnicos
Mike recomenda algumas comunidades para se conectar com redatores técnicos e outras pessoas que desejam entrar na área: a Sociedade de comunicação técnica, Escreva os documentos, e Conteúdo + experiência do usuário são bons lugares para começar. Esses também podem ser bons lugares para ter uma ideia dos salários atuais do redator técnico se você estiver apenas começando (aqui estão mais alguns dicas para negociar salários iniciais).
A postagem O que um redator técnico faz? apareceu primeiro em Blog da Codecademia.
https://www.codecademy.com/resources/blog/what-does-a-technical-writer-do/
Autora: Rebecca Dodd
Com os Cursos da Faculdade, você tem a possibilidade de estudar em mais de um curso ao mesmo tempo, estudando em quantos cursos você deseja no mês, assim ampliando suas oportunidades. Nossos cursos da Faculdade sua jornada são dinâmicos e flexíveis, permitindo que você tenha em mãos um pouco em tempo quantos certificados desejar. Nos cursos da Faculdade, seja almejando planos de carga e evolução em empresas privadas ou em órgãos públicos, nossos cursos capacitam você com as habilidades e certificações essenciais para se destacar. Certificado pela nossa parceira Faculdade de Ensino Superior Pelegrino Cipriani, www.faspec.edu.br nossa missão vai além do ensino, nos cursos da Faculdade o aprendizado é rápido, acessível e voltado para o seu sucesso. Junte-se a nós e descubra o poder de alcançar seus sonhos.
