📝 Redação Técnica
Confira minha jornada de descobertas em Redação Técnica (Technical Writing)!
Dos conceitos fundamentais às estratégias avançadas, conheça os cursos que realizei para aprimorar minhas habilidades.
Technical Writing: introdução
-
Descoberta de tipos de documentação: Examinei uma variedade de tipos de documentação de software, desde funcional até orientada a tarefas e troubleshooting, incluindo documentação in-app e de APIs.
-
Compreensão da estrutura essencial de um documento técnico: desde metadados até imagens e diagramas.
-
Reconhecimento da importância da interação com diferentes stakeholders: como engenheiros e Product Managers.
-
Aquisição de técnicas de redação e edição: para produzir textos claros e precisos e compreensão da importância de definir público-alvo, escopo e objetivos de aprendizado.
-
Exploração de recursos de suporte à documentação: aprendi a criar e utilizar recursos de suporte à documentação, como glossários e guias de estilo.
Technical Writing: estratégias, ferramentas e boas práticas
-
Revisão dos fundamentos: Reforcei conceitos básicos como Technical Writing e suas distinções, além de estratégias para gerenciar repositórios de documentações.
-
Ampliação dos tipos de documentação: Explorei mais a fundo tipos de documentação técnica, como funcional, troubleshooting e documentação de API, aprimorando meu entendimento sobre release notes.
-
Melhoria das práticas de escrita: Refinei minhas habilidades seguindo práticas recomendadas, como o uso de inteligência artificial, organização de documentos e criação de um guia de estilo mais coeso.
-
Exploração de outros formatos: além da documentação tradicional, aprofundei-me em outros formatos como guias de usuário e perguntas frequentes.
-
Aprimoramento do planejamento: Revisei o processo de planejamento e análise de documentações, tornando-o mais eficiente.
Technical Writing: documentação do zero com DDLC
-
Ciclo de Vida de Desenvolvimento de Documentação (DDLC): Aprendi sobre as diferentes etapas do ciclo de vida de documentação, desde o planejamento até a publicação e medição de eficácia. Isso me deu uma visão clara de todo o processo de criação de documentação técnica.
-
Planejamento da Documentação: Entendi a importância de um planejamento sólido antes de começar a escrever, tendo em vista definir metas claras, mapear os stakeholders envolvidos e estabelecer a estrutura básica do projeto de documentação.
-
Estruturando a Documentação: Aprendi a importância de uma estrutura bem definida para a documentação. Isso incluiu alinhar a documentação com outras áreas responsáveis, construir uma cultura de documentação na equipe e definir a aparência visual do projeto.
-
Escrita e Revisão: Explorei técnicas eficazes de redação e revisão para garantir que a documentação fosse clara e precisa. Consiste no uso de ferramentas de inteligência artificial para ajudar na redação e estabelecer um processo de revisão eficiente.
-
Publicação: Entendi os diferentes locais de publicação para a documentação e aprendi como comunicar efetivamente a publicação para os usuários.
-
Medindo a Eficácia da Documentação: por fim, aprendi a importância de medir a eficácia da documentação. Desde a definição de indicadores de sucesso, a análise de métricas relacionadas aos usuários e à documentação e a simulação de métricas para avaliar o impacto do projeto.
Todos esses cursos me proporcionaram uma base sólida para minha jornada como redator de textos técnicos! ✍🏻