O documento discute technical writing e sua relação com usabilidade de produto. Explica que technical writing é a produção de documentação técnica por profissionais para explicar processos, produtos e simplificar conteúdos complexos. A documentação é importante para evitar problemas de comunicação, reduzir custos e melhorar a experiência do cliente.

1. TECHNICAL WRITING:
O que é e qual sua relação com
de <usabilidade de produto>?

2. UM POUCO DE MIM
Sou jornalista especializada em Comunicação e Marketing
Digital. Hoje, atuo na área de tecnologia como Technical Writer
(redatora técnica).
Nesses 6 anos de trajetória, trabalhei com:
Technical
Writing
Otimização
para SEO
Produção de conteúdo
digital / Social Media
UX
Writing

3. TEMOS UMA COMUNIDADE
Nossos canais:
● LinkedIn
● Site Meetup
● WhatsApp

4. VIXE, A DOCUMENTAÇÃO!
E AGORA?

5. O QUE É TECHNICAL WRITING?
Profissional responsável por escrever conteúdos técnicos
TREINAMENTOS INTERNOS
CODE SAMPLES
API DOCS
TUTORIAIS, ARTIGOS, VÍDEOS,
PODCAST
"It is about providing all the right
resources that help your end
consumers successfully integrate
and work with your API".
Ryan Pinkham, Swagger

6. Documenta processos
e produtos
Busca entender e "traduzir"
conteúdos técnicos
Faz a gestão do
conhecimento entre times
NO DIA A DIA,
O TECH WRITER...

7. Desenvolvedores
Analistas de QA
POs e PMs
Arquitetos de
software
CTO
Engenheiros

8. Desenvolvedores
Analistas de QA
POs e PMs
Arquitetos de
software
CTO
Engenheiros
Tech Writer
Simplifica
o complexo

9. EXEMPLO PRÁTICO

11. POR QUE A DOC
É IMPORTANTE?

12. 1. AS PESSOAS NÃO LEEM MENTES
"Se você quer que alguém faça algo da maneira
mais eficiente possível, documente."
Ao documentar o processo, você garante que os
envolvidos no projeto terão:
Mais algumas razões...
Paz de espírito
Eficiência
Consistência

13. 2. REDUZA CUSTOS E TEMPO EM
TREINAMENTO E SUPORTE
Com documentação, você otimiza
processo de onboarding de novos
programadores.
Mas também promove a experiência do
cliente que não precisa caçar as respostas
no stack overflow.

14. 3. VOCÊ GANHA DINHEIRO
"Documentação é uma vantagem
competitiva".
Quando você abre seus processos
para o cliente em vez de se
preocupar em "resolver tickets", seus
clientes não vão te escolher apenas
pelo preço dos seus serviços.

15. 4. DOCUMENTAÇÃO TRAZ
SERIEDADE E VALOR PARA EMPRESA
(E SEUS TIMES)
Uma doc bem estrutura mostra que a
empresa é engajada como gatekeeper na
sua missão.
Mostra ainda que os times são
comprometidos em oferecer as melhores
soluções para ajudar o cliente final.

16. TÁ, MAS SOU DEV ANDROID
COMO A DOC PODE
ME AJUDAR?

17. PODE SER UMA OPORTUNIDADE E TANTO
Pode ser seu diferencial para entrar
no GEP e se tornar Dev Advocate.

18. ISSO TAMBÉM VALE SE VOCÊ
QUER TRABALHAR NO GOOGLE ;)

19. E ONDE APRENDO TECH WRITING?
O próprio Google oferece curso
gratuito para você desbloquear
sua escrita técnica. ;)

20. "Sempre vai ter demanda"
Você aprende à medida
que vai produzindo.
O trabalho é sobre
objetividade e clareza.

21. A ESCRITA TÉCNICA PODE SER PORTA DE ENTRADA PARA
QUEM É DA COMUNICAÇÃO, MAS TAMBÉM PARA QUEM JÁ É DA
TECNOLOGIA.
PARA QUEM QUER SER REDATOR, COMMUNITY MANAGER OU
ADVOCATE EM EMPRESAS CONCEITUADAS.

22. <Mariana/Moreira
>
linkedin.com/in/marianacpmoreira
mariana.moreira@zup.com.br
@maricpmoreira