March 2025
Intermediate to advanced
260 pages
6h 51m
Portuguese (Portugal, Brazil)
Content preview from Engenharia de software para cientistas de dados
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.
Capítulo 9. Documentação
Este trabalho foi traduzido com recurso a IA. Agradecemos o teu feedback e comentários: translation-feedback@oreilly.com
A documentação é um aspeto frequentemente negligenciado da ciência dos dados. Normalmente, é deixada para o final de um projeto, mas depois estás entusiasmado para avançar para um novo projeto e a documentação é apressada ou omitida completamente. No entanto, como discuti em "Legibilidade", a documentação é uma parte crucial para tornar o teu código reproduzível. Se queres que outras pessoas usem o teu código, ou se queres voltar ao teu código no futuro, ele precisa de uma boa documentação. É impossível recordar todos os pensamentos que tiveste quando escreveste o código ou fizeste as experiências, por isso é necessário registá-los.
Uma boa documentação comunica bem as ideias. O teu leitor tem de compreender o que queres que ele compreenda. Por isso, primeiro, é importante considerar para quem estás a escrever a documentação. Estás a registar as tuas experiências para outro cientista de dados que possa vir a assumir o teu projeto no futuro? Estás a documentar um pedaço de código que achas que pode ser útil para outras pessoas da tua equipa? Ou estás a registar os teus próprios pensamentos para que possas voltar a eles daqui a seis meses? Escolhe o nível de detalhe e a linguagem que utilizas de forma a que seja apropriado para o leitor que esperas.
Outros aspectos de uma boa documentação incluem estar actualizada: a documentação não é ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access
More than 5,000 organizations count on O’Reilly
O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.Julian F.
I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.Addison B.
I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.Amir M.
I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.