Otimizando prompts para documentação de código

Você trabalha há bastante tempo na empresa do setor bancário e mantém uma grande base de código em Python há anos. Agora, um novo estagiário vai começar e você percebe que todo esse conhecimento está só na sua cabeça. Você decide usar um assistente de IA para começar a documentar a base de código.

Para testar a viabilidade dessa abordagem, você decide começar com uma única função, salva em interest.py, um arquivo que o LLM pode ler e usar:

def calculate_interest(balance, rate, years):
  return balance * (1 + rate) ** years

Este exercício faz parte do curso

Codificação com IA para Desenvolvedores

Instruções do exercício

- Instrua o modelo a **adicionar docstrings** à função, **especificar um padrão** (por exemplo, docstrings no estilo Google) e **exigir seções** para o propósito da função, argumentos (nomes/tipos), tipo de retorno e, opcionalmente, exemplos.

Exercício interativo prático

Transforme a teoria em ação com um de nossos exercícios interativos

Começar o exercício

Este exercício faz parte do curso

Codificação com IA para Desenvolvedores

IntermediárioNível de habilidade

4.9+

Iniciar curso de graça

Aprenda como modelos de IA potencializam a codificação com autocompletar, depuração e documentação. Domine o básico de prompt engineering e descubra como o contexto torna as respostas da IA mais inteligentes. Este capítulo estabelece a base para usar a IA como uma assistente prática de programação.

Exercise 1: O paradigma da programação assistida por IA Exercise 2: Combinando modelos de IA com tarefas Exercise 3: Classificando cargas de trabalho de IA Exercise 4: Noções básicas de prompt engineering Exercise 5: Decodificando funções com os prompts certos Exercise 6: Aprimorando prompts para mudanças no código Exercise 7: Adicionando contexto para respostas de IA mais inteligentes Exercise 8: Escolhendo o contexto certo em tarefas de código Exercise 9: Melhorando o código com iteração de prompt

Aprenda a criar prompts que orientam modelos por raciocínios complexos, documentam código com eficiência e geram implementações orientadas a testes. Ao final deste capítulo, você será capaz de desenhar prompts que melhoram tanto a qualidade do código gerado quanto o seu fluxo de desenvolvimento como um todo.

Exercise 1: Engenharia de prompts avançada para assistência em código Exercise 2: Prompts para depuração eficaz Exercise 3: Definições de função eficazes Exercise 4: Documentando código com IA Exercise 5: Otimizando prompts para documentação de código

Exercício atual

Exercise 6: Mensagens de commit eficazes com IA Exercise 7: Escrevendo testes e protegendo código com AI Exercise 8: Prompts para codificação assistida por IA com segurança Exercise 9: Identificando lacunas em testes gerados por IA

Vá além da criação de prompts neste capítulo e entre nas realidades práticas de operar IA em produção. Explore como comparar e selecionar modelos com base em desempenho, custo e adequação à tarefa; como incorporar guardrails que mantenham as saídas seguras e em conformidade; e como ajustar fluxos de trabalho para ganhar eficiência sem abrir mão da qualidade.

Exercise 1: Escolhendo a melhor ferramenta de IA para a tarefa Exercise 2: Entendendo o custo de assistentes de IA Exercise 3: Avaliar os prós e contras de modelos de raciocínio Exercise 4: Guardrails para uma codificação de IA responsável Exercise 5: Restrições de segurança e ética para um fluxo de trabalho com IA Exercise 6: Aplicando guardrails de segurança a um fluxo de trabalho de IA Exercise 7: Otimização de IA para velocidade, custo e qualidade Exercise 8: Estratégias eficazes para controlar o custo do modelo Exercise 9: Equilibrando desempenho do modelo e custo Exercise 10: Parabéns!