Pular para o conteúdo
Português - Brasil
  • Não há sugestões porque o campo de pesquisa está em branco.

Script para modelo de artigo para central de conhecimento - Mobiliza.

Este script tem como objetivo padronizar a estrutura e a formatação dos artigos da Central de Conhecimento da Mobiliza, garantindo uma identidade visual consistente e melhorando a experiência do usuário.

1. Instância padrão para capturas de tela e vídeos

Para padronizar nossos artigos, utilizaremos sempre a mesma instância ao capturar prints, vídeos e GIFs.

  Instância padrão: https://universidade.mobiliza.com.br/admin/users/students

Isso garante uniformidade nas demonstrações e facilita o entendimento dos usuários.

2. Uso das caixas de sinalização

Para organizar melhor as informações e destacar pontos importantes, utilizamos diferentes tipos de caixas:

🔹 Dica (azul claro): Para sugestões úteis, atalhos ou boas práticas.
📗 Observação (verde): Para detalhes adicionais, esclarecimentos ou exceções.
⚠️ Cuidado (vermelho fraco): Para avisos sobre possíveis dificuldades ou erros comuns.
🚨 Atenção (vermelho escuro): Para alertas críticos que podem causar problemas graves se ignorados.

> Exemplo de uso:

Para acelerar o processo, utilize o atalho Ctrl + C para copiar rapidamente.

 Esse recurso está disponível apenas para usuários com permissões de administrador.

Se você excluir este item, não será possível recuperá-lo.

 Não compartilhe suas credenciais de acesso com terceiros.

3. Estrutura de imagem para passo a passo

  • Sempre utilizar a cor Azul (#050035). Para definir essa cor, insira o código diretamente na ferramenta de cores. 
  • Utilizar caixas para marcar os pontos de foco: usar bordas finas e a cor azul padrão (#050035).
  • Setas: sempre direcionadas para o ponto de foco, com um tamanho proporcional ao elemento destacado e a cor azul padrão (#050035).
> Exemplo: 
Screenshot_323

4. Estrutura de vídeos e gifs 

  • GIFs: ideais para explicações curtas e diretas, como pequenas demonstrações no passo a passo. 
  • GIFs curtos (3-10 segundos) para mostrar ações rápidas sem necessidade de áudio.
  • Vídeos de 30s a 2 min para tutoriais básicos e de até 5 min para fluxos mais completos (por exemplo: explicar como funciona o fluxo da área do líder).

5. Estrutura dos títulos e subtítulos

Para manter uma hierarquia clara no conteúdo, utilizamos os seguintes padrões:

Título Principal (Título 1)

  • Sempre usado para o título principal do artigo.

  • Deve ser objetivo e indicar claramente o tema abordado.

  • Deve iniciar com a primeira letra maiúscula e as demais minúsculas.

  • Nomes de empresas ou ferramentas no título devem ser iniciados com letras maiúsculas.

> Exemplo: Configurando o armazenamento do Applique

Subtítulo (Título 2)

  • O artigo deve começar com uma breve introdução.

Título 4 

  • Usado para dividir o conteúdo em seções dentro do artigo.

6. Quando usar negrito, itálico e sublinhado nos artigos

Para garantir clareza e padronização, utilizamos a formatação de texto da seguinte maneira:

📌 Uso do Negrito

  • Usado para destacar informações importantes, como:

    • Nomes de botões e menus do sistema (aluno, customização, recursos).

    • Termos-chave no contexto do artigo.

    • Instruções essenciais.

> Exemplo:

Clique no botão "Salvar" para aplicar as alterações.

📌 Uso do Itálico

  • Utilizado para:

    • Nome de sistemas, plataformas e aplicativos (Google Analytics, HubSpot, Mobiliza).

    • Enfatizar palavras ou expressões dentro de um contexto.

    • Citações ou trechos de mensagens do sistema.

> Exemplo:

A integração com Alura permite acompanhar o desenvolvimento do aluno.

📌 Uso do Sublinhado

  • Usado de forma mais restrita, apenas para:

    • Destacar partes críticas de um processo.

    • Ressaltar avisos dentro de um parágrafo.

> Exemplo:

Atenção: Após excluir um usuário, essa ação não poderá ser desfeita.

7. Quando utilizar o blockquote no artigo

Exemplos: Para exibir exemplos utilizados na plataforma, ou citações de mensagens de erro, alertas ou notificações do sistema.

Exemplo:

"Erro ao processar a solicitação. Tente novamente mais tarde."

8. Alinhamento justificado

  • O artigo deve ser alinhado no formato "justificado"

9. Passo a passo com lista numerada

  • Escrever o passo a passo com lista numerada, quando necessário. 

> Exemplo:

  1. Clique no botão "x"; 
  2. Selecione o botão "y"

10. Estrutura padrão para todos os artigos

Para manter a padronização dos nossos artigos, todos os artigos devem seguir esta estrutura:

1. Título Principal (Título 1)
2. Introdução breve – Explique o objetivo do artigo.
3. Seções divididas por subtítulos – Organize o conteúdo com títulos (título 4).
4. Destaques visuais – Utilize caixas de alerta, imagem, vídeos para melhorar a visualização do cliente.
5. Todo o texto deve estar alinhado de forma justificada.