Guia de padronização de escrita técnica

Nomenclatura da plataforma

O uso correto destes termos é essencial para garantir a coerência entre a plataforma e as soluções desenvolvidas por parceiros.

• Termo principal: utilize sempre plataforma. 
  • Evite "produto", "produto padrão" ou "sistema".

• Marca: use apenas o termo plataforma.
  • Evite citar "fluig" ou "Fluig" em documentações para o usuário final. 

• Gênero: as atualizações são sempre referenciadas no feminino.
  • Exemplo: "A atualização Crystal Lake", "A Waterdrop".

• Versão vs. Atualização: como somos uma plataforma cloud, use sempre atualização.
  • Não utilizamos o termo "versão".
  • Exemplo: "É necessário aplicar a atualização 1.8.x".

Interface e experiência 

• Página: uso exclusivo para a interface Web.
  • Exemplo: "A página Parâmetros gerais".

• Tela: uso exclusivo para aplicativos móveis 
  • Exemplo: "A tela principal do aplicativo".

• Modo visual: no Fluig Voyager, utilize Modo claro ou Modo escuro. 
  • Evite o termo "Tema".

• Ação de usuário: use termos mais leves como criar, definir, configurar ou aplicar.
  • Evite "cadastrar" ou "cadastro". 

Desenvolvimento e recursos

• Capacidades: prefira recurso ou opção.
  • Não utilize "função", "funcionalidade" ou "módulo".

• Adaptações:
  • Personalizado: para alterações visuais (cores, logos, temas).
  • Desenvolvimento sobre a plataforma: para novas aplicações, processos ou widgets.

• Dados: para persistência em tabela única, use: registros de formulários (Tabela única).
  • Não utilize "fichas" ou "fichários". Use formulários e registros de formulário.
• Distribuição: utilize instalador em vez de "mídia".

Estrangeirismos e padrões de escrita

• Itálico: termos em Inglês devem ser destacados em itálico. Exemplo: layout, upload, widget.

• Vernáculo: dê preferência ao Português sempre que houver um termo equivalente.
  • Use Assistente em vez de "Wizard".
  • Use Desempenho em vez de "Performance".

• Proibição de derivações: nunca crie verbos a partir de termos em Inglês.
  • Incorreto: Performar, debugado, startar.