Pular para o conteúdo principal
Todo plugin deve fornecer pelo menos:
  • Guias: para regras de negócio, configuração e uso.
  • Referência de API: para todos os endpoints expostos e documentação técnica.
Você ainda pode hospedar sua própria documentação, mas os clientes devem ser redirecionados para o site oficial da Lerian para conteúdo técnico autoritativo.

​
Padrões e templates

Para garantir consistência e usabilidade, toda documentação deve seguir os Padrões de Escrita da Lerian.
Esses templates são obrigatórios e garantem que os usuários finais recebam documentação de alta qualidade e acessível em todo o ecossistema.

​
Por que isso importa

Uma ótima documentação não é apenas um diferencial; é um requisito de compliance. Ela reduz o atrito no onboarding, previne uso incorreto e mantém o suporte ao cliente eficiente.
Plugins sem documentação adequada não serão aprovados para publicação.