Overview
Talvez você tenha se formado em um curso de Humanas e hoje trabalhe criando conteúdo para sites, jornais, empresas de conteúdo ou agências. E talvez não esteja satisfeito(a) com seu salário ou as perspectivas para a sua carreira. O Breno Barreto, nosso professor, passou por isso. Mas descobriu no mercado de Tecnologia uma maneira de exercer sua paixão pela criação de Conteúdo e ser recompensado por isso. Hoje ele é Senior Technical Writer no Nubank, depois de ter atuado na mesma área na VTEX.
Technical Writers têm sido cada vez mais requisitados por startups e empresas de Tecnologia brasileiras. Essas empresas estão percebendo quão estratégico é ter times dedicados à documentação de software, e isso cria diariamente novas vagas e oportunidades de crescimento para profissionais de conteúdo.
Estamos vendo apenas o começo de uma explosão de demanda por pessoas com conhecimento e sensibilidade para escrever, editar textos e organizar conteúdo técnico. Se você tem essas habilidades, então este é um momento único para entrar no mercado de software e produtos digitais.
Até hoje, no entanto, ainda não existia capacitação de Technical Writing em português. Foi por isso que criamos este curso: para dar o conhecimento necessário às pessoas interessadas em conteúdo técnico que desejam entrar no mercado de Tecnologia e trabalhar com documentação de software.
O curso é dividido em 8 módulos, com mais 2 módulos bônus. São mais de 60 aulas em vídeo, com textos complementares e exercícios criados para te ajudar a praticar os modelos de trabalho e técnicas usadas pelos melhores Tech Writers do Brasil e do mundo.
Detalhes do Curso
- Aulas 69
- Quizzes 12
- Duração 10 horas
- Nível Iniciante
- Idioma Português
- Alunos 197
- Certificado Sim
Ementa
-
Apresentação
O que você vai aprender no curso. E por que esse conhecimento pode fazer a diferença na sua carreira.
-
Introdução ao Technical Writing
Os principais conceitos de Technical Writing; as diferenças entre Technical Writing e outras áreas de Conteúdo Digital; e a abordagem de Desenvolvimento Orientado à Documentação, essencial para o trabalho de qualquer Tech Writer.
-
Tipos de documentação de software
Diferentes objetivos exigem diferentes tipos de documentação. Vamos conhecer os principais tipos, entender quando usar cada um deles e praticar as técnicas necessárias para usá-los no dia a dia do trabalho.
- Introdução: para cada objetivo, um tipo de documento
- Documentação funcional vs. Documentação orientada a tarefas
- Documentação funcional e Documentação orientada a tarefas
- Recomendações de escrita para documentação orientada a tarefas
- Documentação de fluxo
- Troubleshooting
- Documentação in-app
- Documentação de APIs
- RFC (Request For Comments)
- ADR (Architecture Decision Record)
- Documentação in-app, RFC e ADR
- [Exercício] Tipos de documentação de software
-
A estrutura de um documento técnico
Boa documentação de software é sempre estruturada. Vamos conhecer os principais componentes dessa estrutura e aprender sobre as boas práticas que você deve aplicar na hora de usá-los em sua documentação.
- Introdução: bons tech writers são também arquitetos da informação
- Documentação baseada em tópicos
- Metadados
- Título
- Links
- Título e Links
- Índice
- Introdução
- Imagens e vídeos
- Diagramas UML e Modelo C4
- Callouts
- Imagens e callouts
- Casos de uso e Code samples
- [Exercício] A estrutura de um documento técnico
-
Stakeholders que interagem com Technical Writers
O sucesso do trabalho de um Technical Writer depende da colaboração de uma série de stakeholders dentro da empresa. Este módulo apresenta os principais e oferece - a partir de exemplos reais - orientações para tirar o melhor proveito da interação com cada um deles.
-
Ciclo de Vida da Documentação (DDLC)
Este módulo explora em detalhes cada uma das principais etapas do Ciclo de Vida da Documentação. Você vai aprender a criar um Plano de Documentação e a colocá-lo em prática por meio de pesquisa, validação de rascunho, revisão, localização do conteúdo, manutenção e medição do sucesso do seu trabalho como Technical Writer.
-
Técnicas de redação e edição
Escrever e editar documentação exige uma abordagem do texto voltada à clareza, concisão e precisão. Vamos explorar alguns dos problemas textuais mais frequentes em documentação de software e aprender as técnicas usadas por Tech Writers para eliminar esses problemas e produzir textos melhores.
- Introdução: seu objetivo é a clareza
- Linguagem Simples
- Reuso de documentação
- Prefira a voz ativa
- Voz ativa
- O trade-off das siglas
- Cuidado com pronomes
- Pronomes
- Verbos fortes vs. verbos fracos
- Elimine prosopopeias
- Uma ideia por frase
- Elimine palavras que estão sobrando
- Ajude o usuário a ler seus parágrafos
- Parágrafos e palavras extras
- Ame listas
- Listas
- [Exercício] Técnicas de redação e edição
-
Público, escopo e Objetivos de Aprendizado
Este módulo vai te dar as ferramentas necessárias para criar documentação com o escopo bem definido e que atenda com eficácia o público correto. Você vai aprender também a usar a técnica de definição dos Objetivos de Aprendizagem para cada um dos seus tópicos.
-
Recursos de suporte à documentação
Bons Technical Writers têm à disposição recursos que auxiliam a escalar seu trabalho e trazer mais impacto para a empresa, como glossários, guias de estilo e templates de documentação. Este módulo vai te ensinar a criar e usar esses recursos.
-
Bônus 1: FAQ
Um vídeo extra com respostas para algumas das perguntas mais frequentes de pessoas interessadas em conseguir um emprego como Technical Writers no mercado de Tecnologia.
- Como conseguir um emprego como technical writer?
- Que tipo de empresa busca technical writers?
- Que requisitos um technical writer precisa ter?
- Quanto ganha um technical writer?
- Quão técnico um technical writer precisa ser?
- Qual é a diferença entre Technical Writing, UX Writing e Copywriting?
- Como criar um portfólio como technical writer?
- Um technical writer precisa dominar o inglês?
- Eu trabalho com Comunicação tradicional. Posso migrar para Technical Writing? -
Bônus 2: Recomendações de livros, podcasts, sites e comunidades
Technical Writers em início de carreira se beneficiam muito de conteúdo sobre área. Para facilitar sua exploração, este módulo bônus traz recomendações de livros, podcasts, sites e comunidades que produzem conteúdo que de qualidade e que pode fazer a diferença na sua carreira.
Instrutor
Reviews
-
Erval Oliveira
Muito bom
Curso muito bom e rico em informações. Vai ajudar muito no início dessa carreira. Poderia ter um treinamento intermediário mais aprofundado em alguns itens e demonstrando um projeto e documentos reais do início ao fim.
-
Márcia Maria dos Reis Marques
Maravilhoso curso!
Maravilhoso curso! Obrigada, Breno Barreto por compartilhar todo o seu conhecimento de maneira bem objetiva e clara. Muitíssimo importante para quem está migrando de área, dando os primeiros passos ou em dúvida se deve seguir.
-
Lilian da Silva Reis
Conteúdo e didática excelentes
O curso possui um conteúdo muito rico, bem organizado e completo. Além disso, o Breno tem uma ótima didática e utiliza muitos recursos e exemplos reais e acessíveis, o que penso ser um grande diferencial. Eu já trabalho na área, mas sentia falta desse aprendizado mais formal e estruturado e de ouvir pessoas que são especialistas na área. E encontrei tudo isso aqui. Fiquei muito satisfeita com todo o aprendizado que ganhei, algumas coisas que faço foram validadas e e já comecei a aplicar várias lições do curso e a ver grandes diferenças no meu trabalho diário. Este é um curso que abriu minha visão e trouxe muitas ideias para os meus próximos passos.
