- Mantém a documentação legível e escaneável.
- Preserva uma voz consistente em todo o ecossistema.
- Reduz ambiguidade e solicitações de suporte.
Nossas diretrizes de escrita
Toda documentação publicada no Lerian Docs deve seguir as mesmas diretrizes de escrita. Essas regras garantem que o conteúdo seja claro, consistente e alinhado com a forma como a Lerian se comunica.
Esteja você escrevendo um novo guia ou atualizando uma referência de API existente, aplique essas práticas para que seu conteúdo seja coeso e útil para developers, tech leads e parceiros.
Ao seguir essas diretrizes, você: