A profissão de technical writer tem despertado a atenção de empresas de tecnologia no Brasil. Com o amadurecimento do mercado, startups e grandes empresas começam a entender o quão estratégico é preocupar-se com a qualidade da documentação de seus softwares. E, com isso, surgem novas oportunidades.
Faltam technical writers no mercado, o que é um desafio e ao mesmo tempo uma oportunidade. A tendência é vermos cada vez mais vagas sendo criadas - e elas serão ocupadas por aqueles que estão trilhando hoje um caminho de estudo e qualificação.
Um dos desejos que motivaram a criação desta comunidade foi facilitar essa caminhada. Nesta página, você encontra uma das muitas trilhas de conhecimento possíveis na formação de um tech writer, assim como sugestões de artigos, livros e cursos que podem te ajudar a exercitar as habilidades normalmente exigidas de um tech writer.
Esta não é uma lista exaustiva. Lembre-se de que funções diferentes exigem ênfases de conhecimento distintas. Portanto, parte dos tópicos listados aqui pode não fazer sentido para você, e ao mesmo tempo podem faltar tópicos importantes para seu desafio específico.
Por fim, cabe observar que essa lista está em constante atualização. Se você quiser contribuir com novos tópicos, referências ou retificações, fale com a gente.
Primeiros Passos Intermediário Expert
Primeiros Passos
1. Fundamentos de escrita
Antes de mais nada, um technical writer deve ser capaz de se expressar de forma clara por texto. Em qualquer empresa, espera-se que esse seja um pré-requisito para admissão.
Livros
On Writing Well: The Classic Guide to Writing Nonfiction
Este livro do William Zinsser foi originalmente publicado em 1976. É um clássico da escrita de não ficção. Explica uma série de conceitos básicos e oferece insights interessantes para quem está começando a escrever profissionalmente ou para quem gostaria de uma reflexão básica e conceitual sobre a escrita.
2. Fundamentos de redação técnica
A redação técnica tem uma série de particularidades que a diferenciam da escrita do dia a dia. Um technical writer precisa se preocupar acima de tudo com a clareza do texto e o impacto educacional no leitor. E, por si só, essa característica implica em uma série de técnicas que precisam ser observadas.
Livros
The Product is Docs
Este livro foi escrito a várias mãos pelo time de documentação do Splunk. Mais do que em técnicas específicas, ele se concentra no panorama do trabalho de um technical writer. Mostra o ciclo de vida da documentação e os principais pontos de contato do technical writer com demais times. É um livro que responde de maneira muito precisa e completa à pergunta “O que faz um technical writer?”
Cursos
Technical Writing One - Google
O Google disponibiliza online um curso sobre os “os fundamentos críticos de technical writing”. O curso é pensado para ser oferecido por facilitadores em uma dinâmica de aula, mas muitas pessoas avaliam que a leitura do material pré-classe já traz valor relevante. O curso é voltado para engenheiros que querem melhorar suas habilidades de documentação, mas serve igualmente para technical writers começando na profissão.
Intermediário
1. Redação técnica
Em um nível intermediário, a habilidade de construir uma redação técnica capaz de educar o usuário de forma clara continua sendo central para o trabalho do technical writer. Aqui, espera-se uma capacidade mais avançada de lidar com a organização de projetos maiores de documentação, editar artigos, dominar a manipulação de exemplos de código e trabalhar de maneira eficiente com gráficos e outros formatos de conteúdo.
Cursos
Technical Writing Two - Google
A segunda parte do curso do Google sobre technical writing foca em edição de documentos, organização de documentações maiores, ilustração e o uso de exemplos de código na documentação.
2. Arquitetura da Informação
Para um technical writer, não basta a habilidade da escrita. É essencial saber organizar a informação e pensar a forma como ela é estruturada e entregue ao leitor. Quanto mais sênior o tech writer, mais importante torna-se esse olhar editorial do conteúdo.
Livros
Information Architecture: For the Web and Beyond
Este livro é um dos maiores clássicos sobre arquitetura da informação já escritos.
3. UX Research
Technical writers devem ter profundo conhecimento do usuário e de como ele se comporta - tanto em relação à documentação quanto ao próprio produto documentado. Pensar a experiência do usuário, portanto, é essencial. E dentro da disciplina de UX, um dos tópicos mais importantes para nosso trabalho é a pesquisa.
Vídeos
Startup Lab workshop: User Research, Quick ‘n’ Dirty
Este é o vídeo de um workshop concedido em 2013 por Michael Margolis, do Google Ventures. Ele é um dos grandes nomes no mercado de user research. Esse workshop trata, de forma prática e direta, de todo o ciclo de de um projeto de pesquisa com usuários.
4. UX Writing
O UX writer é o profissional que escreve os textos exibidos pela interface de produtos digitais. Ele está muito extremamente preocupado com a experiência do usuário, e por isso fica sempre muito próximo do trabalho de design de produto. Cada vez mais, tech writers e UX writers colaboram para dar ao usuário uma experiência coesa. Em algumas empresas, as duas funções chegam inclusive a ter uma interseção mais cinzenta, e o tech writer acaba assumindo parte do trabalho de UX writing. De qualquer forma, é cada vez mais importante para o tech writer pelo menos ter conhecimento sobre essa área.
Livros
Strategic Writing For UX
Torrey Podmajersky é UX writer no Google. O livro dela tornou-se uma das principais referências na área. Ela explica como é o processo iterativo de criação de conteúdo para um UX writer, focando nas características mais importantes desse trabalho, como concisão, clareza e o aspecto conversacional.
Podcasts
The Manu<script> - ep. 10: Beyond ‘fixing the words’ - the craft of UX writing
Neste episódio do podcast Manu<script>, Breno Barreto e Juliana Meyer entrevistam Torrey Podmajersky, autora do best-seller Strategic Writing For UX. Ela fala sobre seu entendimento do que é UX Writing e de como a função se aplica no mercado de tecnologia. Ouvir no Spotify Ouvir no Apple Podcasts
Artigos
UX Writing e Technical Writing: semelhanças e diferenças
Este artigo da Mariana Moreira conecta o technical writing à disciplina de UX Writing.
5. Design Instrucional
Um technical writer, em muitos sentidos, é um professor. Nosso objetivo é transmitir conhecimento ao usuário, e para isso pode ser útil se valer de técnicas do design instrucional. Um exemplo é o conceito de Learning Objectives, que muitos tech writers aplicam à documentação, para garantir que os objetivos de aprendizado estão sendo alcançados.
Livros
Design For How People Learn
Este é um dos livros mais conhecidos na área de design instrucional. Julie Dirksen explica os fundamentos de como o aprendizado funciona para a mente humana e então usa esses fundamentos para traçar estratégias eficazes de ensino.
6. Markdown
Cada empresa - ou mesmo cada área dentro de uma empresa - usa ferramentas e linguagens diferentes para documentar software. Algumas, no entanto, são mais frequentemente usadas, e, por isso, vale a pena aprender sobre elas. Markdown é uma linguagem de marcação simples, criada em 2004, que padroniza e facilita a formatação de textos. Ela pode ser facilmente convertida em HTML, por isso é muito usada para textos na web. Hoje em dia, muitos technical writers escrevem originalmente em markdown, e depois esse texto é automaticamente convertido para outros formatos.
Sites
Expert
1. API REST
A possibilidade de se conectar a múltiplos serviços na internet se tornou estratégica. APIs são as interfaces que permitem isso, por isso elas se multiplicam em velocidade impressionante. É bastante possível que você se depare com a necessidade de documentar ou, pelo menos, entender APIs.
Cursos
Documenting APIs: A guide for technical writers and engineers
O technical writer da Amazon Tom Johnson é uma das principais referências quando o assunto é documentação de APIs. Em seu blog, ele criou um curso com conceitos e prática sobre APIs REST.
2. Git e GitHub
A abordagem conhecida como Docs as Code sugere que, para criarem documentação, technical writers deveriam usar as mesmas ferramentas usadas por desenvolvedores. Há uma série de ferramentas possíveis nessa lista, e provavelmente vale a pena aprender a lidar não apenas com uma delas, mas com várias. Uma das habilidades mais importantes nessa área, no entanto, talvez seja trabalhar com sistemas de controle de versões. Git é o mais conhecido deles.
Cursos
Git and GitHub for Writers
Este é um curso em vídeo da Udemy que ensina os fundamentos de Git e GitHub para redatores.