Busque em todas as páginas da documentação
As convenções de documentação mantêm o conhecimento de Rust onde os engenheiros trabalham: /// rustdoc para APIs, docs/adr/ para decisões, runbooks para plantão e arquivos README com propriedade - não wikis espalhadas que se desviam do main.
Cartão de receita de referência rápida - pronto para copiar e colar.
service-repo/
README.md # quickstart, proprietários, links
docs/
adr/
runbooks/
specs/
crates/*/src/lib.rs # docs//! no nível do móduloQuando usar isso:
//! Lógica de domínio de pedidos - cálculos de dinheiro em centavos inteiros.
//!
//! # Exemplos
//! ```
//! use orders_domain::total_cents;
//! assert_eq!(total_cents(100, 20).unwrap(), 120);
//! ```
pub fn total_cents(subtotal: i64, tax: i64) -> Result<i64, &'static str> {
if subtotal < 0 || tax < 0 {
return Err("valor negativo");
}
Ok(subtotal + tax)
}# docs/runbooks/pool-exhaustion.md
Veja a lição LL-0042. Passos: verificar p95 de aquisição, verificar DATABASE_MAX_CONNECTIONS, reverter se a implantação estiver correlacionada.| Tipo | Localização | Público |
|---|---|---|
| rustdoc | src/ | Consumidores do Crate |
| ADR | docs/adr/ | Futuros mantenedores |
| Runbook | docs/runbooks/ | Plantão |
| Especificação Técnica | docs/specs/ | PM + entrega de engenharia |
| Site de SME | site/rust/ | Aprendizado da frota |
cargo test --doc).last_verified do Runbook dentro de 90 dias.Artigos internos resumem padrões; a documentação do repositório é a fonte da verdade para comandos e SHAs específicos do serviço.
//! de módulo vazia - Correção: Necessário para crates públicos na verificação de CI.kubectl da produção - Correção: Parametrizar o ambiente em modelos de runbook.| Alternativa | Usar Quando | Não Usar Quando |
|---|---|---|
| mdBook para livro de crate | Grande OSS público | Pequena biblioteca interna |
| Notion para especificações | Colaboração de PM | Armazenamento único de implantação/runbook |
| auto-doc de OpenAPI | Superfície HTTP | Ensino de lógica de domínio |
Documentação pub(crate) para módulos complexos; não é obrigatório em todas as funções.
A pasta RFC contém propostas; aceitas se tornam ADR.
Inglês é o padrão para a frota; o produto pode localizar apenas o que é voltado para o usuário.
Publica rustdoc no portal interno em tags de lançamento.
O porquê, não o quê; vincular ADR para trade-offs não óbvios.
Versões de Stack: Esta página foi escrita para Rust 1.97.0 (edição 2024), Tokio 1.x, Axum 0.8, serde 1.0, sqlx 0.8, clap 4 e Polars 0.46+.
Revisado por Chris St. John·Última atualização: 19 de jul. de 2026