O que acontece quando você não tem nenhuma instrução a seguir? O jogo de tabuleiro “Cidade das Seis Luas” brinca com esse conceitodando aos jogadores uma caixa de componentes e um livreto de instruções em uma língua estrangeira, e permite que os jogadores descubram como funciona. Hollandspiele, os designers do jogo, dizem em seu website: Você nunca saberá se acertou ou não. Nunca responderemos a quaisquer perguntas sobre regras.
Um desafio divertido se você quiser enfrentá-lo. Infelizmente, se os desenvolvedores seguirem esse conceito e optarem por não documentar adequadamente, eles correm o risco de criar uma experiência claramente nada divertida para eles e para os futuros desenvolvedores – e o uso da IA corre o risco de tornar o problema exponencialmente pior.
A necessidade de documentação
Documentação transforma o software program de algo que simplesmente existe em algo que pode realmente ser usado. Uma boa documentação explica não apenas como usar o software program, mas também como ele funciona, como se encaixa e sua intenção. Isso significa que o conhecimento pode ser repassado da equipe que construiu o software program para aqueles que dependem dele – não apenas agora, mas no futuro. Dá sentido às decisões tomadas anos atrás e dá aos desenvolvedores conhecimento que eles podem usar para corrigir bugs e criar melhorias.
A documentação deficiente não apenas retarda o desenvolvimento e dificulta a correção de bugs, mas seus efeitos podem se multiplicar. Mal-entendidos podem se propagar pelas bases de código, criando problemas que podem levar muito tempo para serem corrigidos. O uso da IA acelera esse problema.
Os assistentes de codificação de IA contam com documentação para entender como o software program deve ser usado. Sem IA, existe a opção de conhecimento institucional, ou mesmo simplesmente perguntar ao desenvolvedor por trás do código. A IA não tem essa escolha e preencherá com segurança as lacunas onde não existir documentação. Estamos familiarizados com as alucinações da IA – e os desenvolvedores verificarão esses tipos de erros – mas a falta de documentação provavelmente fará com que a IA simplesmente dê uma facada no escuro. Sem uma boa documentação, é muito menos provável que qualquer erro seja detectado na revisão.
A IA depende de padrões para fazer o seu trabalho e, quando esses padrões não estão disponíveis, ela fará uma suposição – e às vezes essas suposições são ruins. Os fotógrafos tiveram problemas semelhantes com o recurso de “preenchimento generativo” da Adobe, que muitas vezes é incrível, mas quando falta a informação correta, o os resultados são bizarros. Sem documentação, é muito mais provável que você acabe com o código equivalente ao logotipo do Bitcoin na sua foto de gaivota.
Depure sua documentação
A chave para evitar esse problema é tratar a documentação da mesma forma que trataria o código. Se um agente de IA, ou outro desenvolvedor, não conseguir concluir uma tarefa usando a documentação, isso é um bug – e precisa ser eliminado.
Os desenvolvedores precisam escrever documentação sobre fluxos de trabalho completos: o caminho completo desde o desenvolvimento native até a implantação em produção, incluindo falhas e casos extremos. Pode ser complicado detectar erros em seu próprio trabalho, então a IA pode ser usada para ajudar aqui, acompanhando a documentação de ponta a ponta e observando onde aparecem confusões e erros.
A IA também pode ser usada para redigir documentação e geralmente faz um bom trabalho ao reunir documentação quando apresentada com código. No entanto, isto deve ser tratado tal como o código gerado pela IA – precisa de ser examinado de perto em busca de erros e alucinações. Também pode não compreender completamente por que certas decisões foram tomadas, por exemplo, soluções alternativas para casos extremos específicos ou escolhas para ajudar no desenvolvimento futuro. Embora os desenvolvedores fiquem muito mais felizes em trabalhar com código do que com documentação, não podemos tratá-lo como um processo de um clique orientado por IA.
O desenvolvimento de documentos deve ser um processo contínuo – assim como o software program é corrigido e atualizado, o mesmo deve acontecer com a documentação. Perguntas provenientes de tickets de suporte e fóruns da comunidade – especialmente problemas repetidos – podem ser usadas para destacar problemas na documentação, especialmente aqueles causados por conhecimento presumido. Pode ser complicado para desenvolvedores experientes ter em mente o que os outros não sabem e levar isso em consideração na documentação.
E assim como o código, o desenvolvimento da documentação deve ser colaborativo, com rotas claras para os colaboradores fornecerem atualizações e fazerem sugestões.
A IA é tão boa quanto o conhecimento ao qual tem acesso, e isso torna a documentação tão importante quanto o código. Mas embora os desenvolvedores humanos possam fazer deduções lógicas onde existem lacunas e pedir esclarecimentos quando necessário, os assistentes de codificação de IA são muito mais propensos a dar saltos lógicos e avançar com seu melhor palpite – deixando os futuros desenvolvedores com a codificação equivalente a uma caixa de componentes de jogos e nenhum guide de instruções.