Política Editorial e de Privacidade¶
Estas notas foram concebidas para uso público. Rigor técnico e privacidade fazem parte do padrão de conteúdo; não são etapas opcionais de revisão.
Padrão técnico¶
Artigos substanciais devem incluir:
- objetivos de aprendizado e pré-requisitos;
- uma definição precisa e uma explicação intuitiva;
- pré-condições e pós-condições explícitas;
- um exemplo ou rastro de execução;
- pseudocódigo ou código executável;
- um argumento de correção quando um algoritmo for apresentado;
- análise de tempo e de espaço auxiliar;
- limitações, casos extremos e erros comuns;
- exercícios; e
- referências a especificações primárias ou livros-texto consolidados.
Afirmações sobre uma versão específica de biblioteca ou framework devem ser conferidas na documentação oficial. Medições devem descrever o ambiente e a metodologia; um único resultado de tempo não constitui uma afirmação geral de desempenho.
Exemplos seguros para publicação¶
Os exemplos não devem conter nem revelar indiretamente:
- nomes de projetos privados, profissionais, de clientes ou de pesquisa;
- hostnames, repositórios, identificadores de conta ou conjuntos de dados internos reais;
- credenciais, tokens, registros pessoais ou valores que pareçam segredos reais;
- diagramas arquiteturais, incidentes, métricas ou regras de negócio privadas; ou
- detalhes copiados de sistemas não públicos.
Use domínios neutros, como livros, formas, tarefas e vértices de grafos. Em
exemplos de rede, use domínios reservados, como example.com.
Idioma e traduções¶
O inglês é o idioma canônico. Identificadores técnicos permanecem em inglês em todas as traduções. Uma página em português brasileiro deve preservar definições, contratos, código, fórmulas, citações e estrutura semântica. Correções são aplicadas primeiro à fonte em inglês e depois propagadas às traduções.
Lista de verificação da página¶
- [ ] O título descreve um único tópico com clareza.
- [ ] A terminologia está de acordo com o glossário.
- [ ] Todo o código e todos os links internos foram validados.
- [ ] A complexidade declara o caso relevante e a convenção de espaço.
- [ ] A teoria está separada do comportamento específico de implementação.
- [ ] Nenhum exemplo expõe contexto pessoal ou não público.
- [ ] As fontes sustentam as afirmações que não são derivadas na página.