Como melhorar documentação em rust em Rust

Prompt gerado automaticamente para Documentação em Rust em Rust

5.0
33 usos
ChatGPT
Usar no ChatGPT
"Você é um engenheiro de software sênior com vasta experiência em Rust e documentação técnica. O problema que enfrentamos é a dificuldade de manter a documentação de código Rust atualizada e consistente, especialmente em projetos grandes e colaborativos, onde a sintaxe Markdown para exemplos de código (blocos de código, destaque de sintaxe, etc.) é frequentemente mal formatada ou inconsistente. Isso gera frustração para os desenvolvedores e para os usuários da documentação.

Sua tarefa é gerar um **modelo de prompt de IA** para um engenheiro júnior que precise documentar uma nova função ou módulo em Rust. Este prompt deve ser **criativo e útil**, guiando o engenheiro júnior a produzir documentação de alta qualidade, focando especificamente na **formatação correta e consistente de exemplos de código Rust dentro de blocos Markdown**.

O prompt que você vai gerar deve:

1.  **Instruir o engenheiro júnior a fornecer o trecho de código Rust a ser documentado.**
2.  **Solicitar uma breve descrição (em português) da funcionalidade do código.**
3.  **Pedir exemplos de uso práticos (também em português) que demonstrem a funcionalidade.**
4.  **Enfatizar a importância da formatação correta de Markdown para os blocos de código (` ```rust `) e para o destaque de elementos internos do código (variáveis, tipos, funções) usando crases simples (`` ` `).**
5.  **Pedir que o modelo de IA gere a documentação completa em Markdown, incluindo:**
    *   Um título H2 para a função/módulo.
    *   Uma descrição clara e concisa.
    *   Um bloco de código para o trecho original.
    *   Uma seção de "Exemplos de Uso" com blocos de código demonstrativos.
    *   Explicações textuais para cada exemplo, referenciando elementos do código com crases simples.
    *   Uma seção de "Retorno" ou "Observações" se aplicável.
6.  **Adicionar uma nota final lembrando o engenheiro júnior de revisar a saída da IA para precisão e clareza.**

Seu output deve ser **apenas o prompt** que seria dado ao engenheiro júnior, formulado de forma clara e profissional

Como Usar este Prompt

1

Clique no botão "Copiar Prompt" para copiar o conteúdo completo.

2

Abra sua ferramenta de IA de preferência (ChatGPT e etc.).

3

Cole o prompt e substitua as variáveis (se houver) com suas informações.

Compartilhe

Gostou deste prompt? Ajude outras pessoas a encontrá-lo!

Outros prompts de Rust

Continue explorando prompts nesta categoria.

Guia para troubleshooting em rust em Rust

Prompt gerado automaticamente para Troubleshooting em Rust em Rust

Guia para padrões de design em rust em Rust

Prompt gerado automaticamente para Padrões de design em Rust em Rust

Guia para padrões de design em rust em Rust

Prompt gerado automaticamente para Padrões de design em Rust em Rust