🦀
ChatGPT intermediate

Estratégias de documentação em rust em Rust

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

2 usos Rust

Prompt completo

Você é um especialista em documentação técnica e um programador Rust experiente. Sua tarefa é criar um guia interativo, passo a passo, para um desenvolvedor Rust júnior que deseja contribuir com a documentação oficial de uma crate popular (por exemplo, `tokio`, `serde`, ou `actix-web`).

O guia deve abordar os seguintes pontos, de forma clara, concisa e prática, focando em exemplos de código e boas práticas:

1.  **Escolha de uma Issue/Oportunidade:** Como identificar documentação ausente, desatualizada ou confusa em uma crate existente (e.g., procurando por `/// TODO`, exemplos quebrados, seções pouco claras, ou issues abertas com a label `documentation`).
2.  **Entendimento do Código e da API:** Como navegar pelo código-fonte da crate para entender a funcionalidade que precisa ser documentada. Dicas para ler assinaturas de funções, structs e traits.
3.  **Boas Práticas de `/// Doc Comments`:**
    *   Sintaxe básica (Markdown, exemplos de código com `/// ```rust`).
    *   Estrutura de um bom comentário de documentação (`# Examples`, `# Panics`, `# Errors`, `# Safety`).
    *   Uso de links (internos e externos).
    *   Diferença entre `///` e `//!`.
    *   Documentação de módulos, funções, structs, enums e traits.
4.  **Criação de Exemplos Testáveis (`/// ```rust`):** Como escrever exemplos de código que sejam compiláveis e testáveis com `cargo test --doc`. Importância de exemplos claros e concisos que demonstrem o uso da API.
5.  **Geração e Visualização da Documentação:** Como gerar a documentação localmente com `cargo doc --open` para revisão.
6.  **Processo de Contribuição (GitHub):**
    *   Fork do repositório.
    *   Criação de um novo branch.
    *   Commit das mudanças com mensagens claras.
    *   Abertura de um Pull Request (PR), incluindo uma descrição detalhada do que foi feito e por que.
    *   Como responder a revisões e sugestões no PR.

O guia deve ser didático, encoraj

Tags relacionadas

Rust Documentação em Rust gerado-automaticamente

Como usar este prompt

1

Clique no botão "Copiar" para copiar o prompt para sua área de transferência

2

Acesse sua ferramenta de IA preferida (ChatGPT, ChatGPT, Claude, etc.)

3

Cole o prompt e adapte conforme necessário para seu contexto específico