Conteúdo

Em um mundo de complexidade e velocidade tecnológicas, a documentação é um ativo estratégico que impulsiona produtos e eleva a experiência do usuário. Este livro é o seu guia prático para dominar a arte de transformar dados técnicos em informação clara e de alto valor.

Com a experiência de Mari Moreira e Felipe Mozart, Tech Writing de A a Z oferece uma jornada completa. Você aprenderá a gerir informações, aplicar os oito princípios da Redação Técnica (como clareza e encontrabilidade) e superar desafios comuns, como a baixa adesão de stakeholders. O livro ensina a estruturar textos complexos, construir personas e usar métricas para garantir a eficácia da documentação.

Se você busca consolidar sua carreira em Redação Técnica ou, como profissional de Produto/Engenharia, deseja alavancar tecnologias, este guia é essencial. Descubra como integrar Inteligência Artificial e Docs as Code em sua rotina, transformando sua prática em um diferencial competitivo para gerar impacto e reconhecimento.

Saiba o que você vai aprender

Sumário

Parte 1: Redação Técnica: por onde começar?

• 1. Por que temos tanta dificuldade em documentar?
• 1.1 A constante busca por informações dentro das empresas
• 1.2 A arte da gestão da informação e do conhecimento
• 1.3 Onde entra a Redação Técnica neste cenário
• 1.4 O papel da Redação Técnica na comunicação organizacional

• 2. Apresentando a Redação Técnica
• 2.1 Redação Técnica para quem?
• 2.2 Sobre a importância da Redação Técnica
• 2.3 Os 8 princípios da Redação Técnica
• 2.4 Mitos mais comuns que as pessoas têm sobre escrever documentações

• 3. Audiência não técnica: entendendo seu público
• 3.1 Identificando contexto, necessidades e nível de conhecimento da audiência
• 3.2 Ambiente de trabalho
• 3.3 Identifique possíveis riscos
• 3.4 Construindo as personas da sua documentação

Parte 2: As etapas que a Redação Técnica percorre

• 4. A estrutura de um bom texto
• 4.1 Tudo começa pela organização lógica
• 4.2 Como montar uma estrutura clara e concisa: a chamada Arquitetura da Informação

• 5. Praticando: os tipos de documentação técnica e estudos de caso
• 5.1 Manuais
• 5.2 Guias de usuário
• 5.3 Documentação de API
• 5.4 Tutoriais
• 5.5 Troubleshooting
• 5.6 Release notes e changelog
• 5.7 Glossário
• 5.8 FAQ
• 5.9 Wiki
• 5.10 Exercícios para elaboração de um tutorial e FAQ

• 6. Revisão e melhoria contínua (métricas e feedbacks)
• 6.1 Por que revisar? A importância da melhoria contínua
• 6.2 Feedback: o que ele pode nos dizer?
• 6.3 Métricas: analisá-las é necessário

Parte 3: Vencendo os desafios da Redação Técnica

• 7. Desafios comuns e suas soluções
• 7.1 Superando medo e insegurança na escrita técnica
• 7.2 Solucionando problemas recorrentes na Redação Técnica

• 8. Softwares facilitadores para Tech Writers
• 8.1 Ferramentas de edição e revisão
• 8.2 Ferramentas de colaboração
• 8.3 Ferramentas de gerenciamento de documentação
• 8.4 Ferramentas de automação e Inteligência Artificial (IA)
• 8.5 Ferramentas de publicação e hospedagem
• 8.6 Ferramentas de controle de versão
• 8.7 Ferramentas de design e visualização
• 8.8 Bibliografia recomendada

Parte 4: Perspectivas e Futuro na Comunicação Técnica

• 9. Os próximos caminhos da Redação Técnica
• 9.1 O que profissionais do mercado têm a dizer

• 10. A Inteligência Artificial e seus impactos na Redação Técnica
• 10.1 Mas de onde surgiu a Inteligência Artificial?
• 10.2 A Inteligência Artificial na Redação Técnica
• 10.3 Como extrair o melhor da IA?
• 10.4 As ferramentas de IA no trabalho
• 10.5 Glossário