Política de Convenção para Páginas de Documentação

A Looplex segue uma convenção ou namespace consistente de nomenclatura para o seu portal de documentação. As páginas da URL da Looplex em “(https://docs.looplex.com.br/)[https://docs.looplex.com.br/]” seguem uma estrutura hierárquica que inclui os seguintes componentes:

Nome de domínio: “(https://docs.looplex.com.br/)[https://docs.looplex.com.br/]” é o nome de domínio do website.
Código de idioma: Usamos o código de idioma de duas letras para especificar o idioma do conteúdo. Por exemplo, “pt-br” representa português brasileiro.
Pasta de tópico: Usamos uma pasta de tópico descritiva para indicar a categoria principal do conteúdo. Neste caso, “legal”, “business” e “technical” são as pastas de tópicos que escolhemos para organizar o conteúdo. Podemos adicionar mais pastas de tópicos, se necessário, desde que sejam relevantes e descritivas.
Nome da seção: Usamos um nome de seção descritivo para indicar a subcategoria ou seção do conteúdo dentro da pasta de tópico. Apesar da língua padrão do conteúdo ser pt-BR, para o nome dos domínios padronizamos tudo em inglês. Por exemplo, “conceptual-guides” (guias conceituais), “entities-overview”, (visão geral de entidades) “getting-started” (começando), “troubleshooting”, etc
Nome da página: Use um nome de página descritivo para indicar o conteúdo específico da página. Por exemplo, “computational-law-and-expert-systems”, (direito computacional e sistemas especialistas) “overview” (visão geral), “guia de instalação” (getting-started), “troubleshooting” (problemas comuns) etc.

Além da divisão hierárquica, seguimos esses princípios adicionais:

Usamos a convenção de internacionalização padrão e localização i18n) para identificar idioma e conteúdo local. O idioma padrão é pt-br, e o idioma estrangeiro padrão é en-US, mas podemos ter documentação em diferentes idiomas e em respectivos formatos de data (DD/MM/AAAA, MM/DD/AAAA), separadores numéricos etc.
Quando for criar uma página, mantenha os nomes das páginas concisos e informativos e evite usar caracteres especiais ou espaços. Use hifens (-) para separar as palavras dentro de cada elemento ou componente do URL.

Isso ajudará os usuários a navegar facilmente e encontrar o conteúdo que precisam. Aqui estão alguns exemplos de URLs usando esta convenção de nomenclatura:

NOTA: Devido às limitações da nossa configuração atual de páginas estáticas do Gatsby, dividimos temporariamente nossas páginas de forma diferente da convenção de nomenclatura pretendida. Nossa documentação legal está hospedada em “docs.looplex.com.br/legal”, nosso conteúdo relacionado a negócios pode ser encontrado em “learn.looplex.com.br/business” e nossa documentação técnica está localizada em “kb.looplex.com.br/technical”. No entanto, planejamos migrar nossas páginas de documentação para nosso novo site hospedado em “docs.looplex.com.br” usando o site Carbon da IBM no Gatsby

Páginas de Suporte

No geral, as páginas de suporte da Looplex seguem uma convenção de nomenclatura semelhante às páginas de documentação, usando uma estrutura hierárquica que inclui o nome de domínio, código de idioma, pasta de tópico, nome da seção e nome da página. No entanto, a Looplex também usa nomes de domínio locais para suas páginas de suporte para fornecer suporte localizado aos seus clientes.

Por exemplo, a página de suporte para Looplex Cases está localizada em https://suporte.looplex.com.br/pt-br/cases e segue a mesma estrutura hierárquica que as páginas de documentação, com o nome de domínio, código de idioma, pasta de tópico, nome da seção e nome da página. Mas o nome do domínio (suporte.looplex) está em pt-br, já que a grande maioria de nossos usuários está no Brasil.

Além do domínio principal, a Looplex também usa nomes de domínio locais para suas páginas de suporte, como “(https://support.looplex.com/en-us/cases)[https://support.looplex.com/en-us/cases]” para os Estados Unidos ou (https://support.looplex.com/es-ar)[https://support.looplex.com/es-ar] para produtos e serviços no idioma espanhol. Esses nomes de domínio locais têm o mesmo propósito que o domínio principal, mas são localizados para regiões e idiomas específicos.

Página Principal da Looplex

A política de nomenclatura para a página principal da Looplex, www.looplex.com.br, não segue uma estrutura hierárquica como as páginas de documentação e suporte. Em vez disso, usa um nome de domínio simples e conciso que representa a marca da empresa. A partir da página principal, a Looplex separa suas subpáginas usando uma combinação de menus de navegação de alto nível e menus suspensos.

A estrutura dos menus é a mesma em diferentes versões do site, mas os itens de menu e subpáginas podem ser apresentados em diferentes idiomas para versões localizadas. Em geral, a política de nomenclatura para a página principal da Looplex é baseada em um nome de domínio simples e uma estrutura de navegação que permite aos usuários encontrar facilmente as subpáginas de que precisam.

Além do menu de navegação de alto nível, a Looplex também usa uma barra de pesquisa na página principal onde os usuários podem inserir palavras-chave para encontrar páginas ou produtos específicos. Essa barra de pesquisa também pode ajudar os usuários a encontrar subpáginas relacionadas a um determinado tópico.

Para versões localizadas do site da Looplex, como (https://www.looplex.com/en-us)[https://www.looplex.com/en-us], o menu de navegação de alto nível e os menus suspensos geralmente são traduzidos para o idioma local para melhor atender aos usuários da região. A estrutura dos menus permanece a mesma, mas os itens de menu e subpáginas podem ser apresentados em um idioma diferente.