Aprenda a construir documentos técnicos para sua equipe e usuários.

Este plano de estudos foi desenvolvido para capacitar a equipe em habilidades essenciais de escrita técnica e documentação de software, garantindo clareza, padronização e colaboração em projetos de software. Ele oferece um caminho que combina teoria e prática, abordando desde conceitos fundamentais até metodologias avançadas, com o objetivo de formar profissionais capazes de criar documentações técnicas de alta qualidade, alinhadas às melhores práticas do mercado. Assim, desenvolvendo sistemas mais compreensíveis, escaláveis e fáceis de manter.

O que você vai aprender:
Por que documentar?
Entenda a importância das documentações técnicas para equipes, usuários e processos ágeis.
Onde e como documentar?
Explore diferentes ambientes e ferramentas para criar documentações eficazes.
O papel do Tech Writer:
Descubra como transformar informações complexas em conteúdos claros e acessíveis.

Conteúdos:

Artigo: O papel da documentação de software nas metodologias ágeis
Explora como a documentação se adapta ao contexto ágil, equilibrando agilidade e clareza, e seu impacto na comunicação entre equipes e stakeholders.

Curso: Technical Writing – estratégias, ferramentas e boas práticas
Ensina princípios de escrita técnica, uso de ferramentas como Markdown e Wikis, e como criar tutoriais, FAQs e guias claros e objetivos.

Curso: Criação de documentação do zero com DDLC
Apresenta o ciclo de vida da documentação, desde planejamento até manutenção, com foco em definir público-alvo e manter documentos atualizados.

Livro: Clean Code
Mostra como código limpo complementa a documentação, reforçando boas práticas para comentários úteis e padrões que aumentam a legibilidade.

Minicurso: LaTeX e Overleaf
Introduz LaTeX para criação de documentos técnicos e científicos e demonstra como usar Overleaf para colaboração online de forma prática.

Apostila de LaTeX
Fornece um guia prático com comandos essenciais, exemplos de formatação e dicas para otimizar a escrita técnica com LaTeX.

Site Overleaf (LaTeX)
Apresenta recursos da plataforma para criar e editar documentos LaTeX, incluindo modelos prontos e colaboração em tempo real.