O que é mais chato conta mais
Os desenvolvedores se tornam desenvolvedores porque gostam de codificar. Muitos começaram a programar na adolescência, depois da escola, ou durante o expediente após o trabalho no cubículo. Eles percebem quanta energia podem obter de seu IDE e de sua linha de comando e ficam viciados nisso.
Mesmo quando os desenvolvedores conseguem o emprego dos sonhos, onde podem codificar o dia todo, muitos mantêm seus projetos paralelos à noite e após o expediente. Eu pessoalmente conheço desenvolvedores que continuam codificando no trem depois que saem do escritório – porque o que mais alguém pode fazer em um trem?
A codificação é um modo de vida. É simples assim.
Há apenas um pequeno problema: a codificação não é a única parte do desenvolvimento de software.
Você também terá que trabalhar com uma equipe, participar de reuniões, escrever e-mails e escrever documentação para seu código.
E, a longo prazo, o que vai fazer ou quebrar sua carreira não serão os e-mails que você escreveu ou as reuniões ou as contribuições que você fez durante as reuniões. Nem será o código que você escreveu, acredite ou não.
O fator decisivo entre uma carreira que tem um impacto duradouro em sua empresa e uma que não tem é apenas uma coisa: sua documentação.
Em dois anos, ninguém entenderá seu código-fonte
Linguagens e frameworks vêm e vão.
Apenas alguns anos atrás, o Python2 era o status quo da programação de back-end e da ciência de dados. Então veio o Python3, e tudo o que havia no Python2 estava desatualizado e não funcionava com nenhum código novo.
Sempre haverá alguma linguagem, algum framework, alguma tecnologia que fará a tarefa em mãos melhor e mais rápido.
Ou talvez seja apenas mais moderno.
De qualquer forma, muitos desenvolvedores juniores – e esses tendem a ser a maioria dos novos contratados – não se importarão mais com as linguagens antigas.
Eles vão reescrever seu código.
Ou esqueça completamente.
Seu código não existe no vácuo
Mesmo que seu código esteja em uma linguagem bastante popular, ninguém o entenderá lendo apenas esse código.
Talvez você esteja escrevendo parte do front-end de um aplicativo. Mas sem pelo menos algum conhecimento sobre o que o back-end faz, ninguém entenderá o código em profundidade.
E, como muitos desenvolvedores podem testemunhar, a compreensão aprofundada é crucial para a manutenção do código.
Você não pode simplesmente adicionar um recurso de front-end sem pensar no suporte de back-end para ele. Ou adicione um recurso que pareça bom em seu aplicativo, mas com o qual ninguém se importa.
Os membros da equipe vêm e vão – até você
A documentação é a melhor amiga da integração.
Pense nisso: quantas novas contratações sua equipe teve nos últimos dois anos?
E quantos membros existentes da equipe tiveram tempo e paciência para explicar cada parte do código para esses novos contratados?
Os desenvolvedores precisam enviar. A maioria dos desenvolvedores simplesmente não tem tempo para investir alguns meses para atualizar um novo membro da equipe. Seu gerente não se importa com suas habilidades de mentor. Eles querem ver os resultados na forma de código.
Documentação é a solução. Tudo o que você pode explicar, você também pode escrever. Uma vez escrito, pode ajudar um novo contratado. Ou dois. Ou cem.
Escalas de documentação. E economiza tempo.
Além disso, um dia você não estará por perto para orientar os novos contratados. Talvez você vá para uma posição mais alta. Ou você vai mudar de empresa. Ou você estará de licença médica quando algo acontecer.
De qualquer forma, quando você não estiver mais lá, sua documentação funcionará para você.
Sua documentação é seu legado.
Os gerentes não olharão para o seu código-fonte de qualquer maneira
Os desenvolvedores que codificam para viver não entenderão seu código em profundidade ao lê-lo. Seu gerente não vai entender nada.
A maioria dos gerentes sabe disso. É por isso que eles não leem o código-fonte.
Não é preguiça. É eficácia.
Os gerentes precisam decidir quais recursos usar em qual projeto, qual membro da equipe mudar para onde e assim por diante. Decisões de negócios.
No fundo, porém, eles estão gerenciando as pessoas que fazem o código. Eles estão gerenciando o código em um nível muito alto.
Você não pode gerenciar o código se não entender nada. Portanto, os gerentes leem a documentação do código.
Além disso, se você produz consistentemente uma ótima documentação para seu código, seu gerente pode notar.
E dar-lhe uma promoção.
Como tornar a documentação agradável
Sim, todas as razões acima são boas razões para escrever uma documentação melhor. Mas os desenvolvedores não querem escrever como se fossem Stephen King. Eles querem codificar como se fossem Bill Gates.
A documentação é aquela dor de cabeça que surge quando você deveria se sentir satisfeito porque acabou de escrever um código incrível.
Você pode torná-lo menos doloroso, no entanto.
Use Documentação Contínua e escreva seus documentos enquanto estiver codificando. Use ferramentas inteligentes para escrever e manter sua documentação.
Apenas uma pequena proporção de desenvolvedores está fazendo isso. Mas essa proporção está aumentando rapidamente.
Mais e mais desenvolvedores estão percebendo que precisam atualizar sua documentação. É um mal necessário.
A Documentação Contínua, ou o hábito de contribuir com sua documentação sempre que você faz uma alteração — por menor que seja — torna a pílula mais fácil de engolir.
Últimas palavras famosas
O caminho para causar um impacto duradouro no mundo do software é cheio de curvas e curvas, e você também precisará de um pouco de sorte.
Se fosse apenas escrever um código incrível, seria uma estrada reta.
A documentação dificulta o caminho para alcançar o sucesso porque é uma tarefa que muitos desenvolvedores não gostam.
Corte-o em pequenos pedaços e documente todas as alterações assim que as fizer.
Sua carreira vai agradecer.