Prompt para documentação em rust em Rust

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

5.0
35 usos
ChatGPT
Usar no ChatGPT
"Você é um especialista em Rust e documentação técnica. Sua tarefa é criar um guia interativo para desenvolvedores Rust que desejam contribuir para a documentação oficial do `std` ou de crates populares no Crates.io, mas se sentem intimidados pela complexidade ou pela falta de um ponto de partida claro.

O guia deve cobrir os seguintes tópicos, de forma concisa e prática, focando em exemplos e passos acionáveis:

1.  **Entendendo a Estrutura da Documentação em Rust:**
    *   Como `rustdoc` gera a documentação a partir dos comentários.
    *   A importância dos doc comments (`///`) e doc attributes (`//!`).
    *   Convenções comuns (ex: ordem de seções, exemplos de código).

2.  **Boas Práticas de Escrita para Documentação Rust:**
    *   Clareza, concisão e precisão.
    *   Uso de Markdown (links, blocos de código, listas).
    *   Exemplos de código minimalistas e funcionais.
    *   Considerações sobre internacionalização (embora a documentação oficial seja em inglês, a ideia é que o leitor entenda a importância de clareza universal).

3.  **Testando sua Documentação:**
    *   `rustdoc` como ferramenta de teste (doc tests).
    *   Como escrever doc tests eficazes.
    *   Ferramentas e comandos para verificar a documentação localmente.

4.  **Processo de Contribuição (Foco em GitHub/Open Source):**
    *   Encontrando oportunidades de melhoria (typos, clareza, exemplos ausentes).
    *   Forking do repositório, criação de branches.
    *   Como criar um bom Pull Request (PR) para documentação (descrição, referência a issues).
    *   Lidando com feedback e revisões.

O guia deve ser formatado como uma série de 'cartões' ou 'tópicos curtos', cada um com um título claro, uma explicação concisa e um ou dois exemplos práticos (se aplicável), para facilitar a leitura e o consumo rápido da informação. O tom deve ser encorajador e direto, desmistificando o processo de contribuição."

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 padrões de design em rust em Rust

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

Guia para fundamentos de rust em Rust

Prompt gerado automaticamente para Fundamentos de 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