Conteúdo do Guia

  • Introdução
  • Fontes 
  • Tamanhos
  • Cor da Fonte
  • Cor de Fundo
  • Negrito Itálico e Sublinhado
  • Alinhamento
  • Listas ordenadas
  • Lista não ordenadas
  • Recuo
  • Link
  • Tabela
  • Imagem
  • Vídeo
  • Código
  • Anexos
  • Índice
  • Formatos
  • Detalhes da ferramenta "Soluções" do Freshdesk


Introdução


Esse material tem como objetivo definir boas práticas na criação de materiais e documentações com o objetivo de manter um padrão visual, textual e lógico.


Fontes


A fonte padrão é para todo o texto é Helvetica Neue


Tamanhos


Diferentes tamanhos são usados conforme a situações abaixo:


Título principal 

Tamanho automático e fixo

Títulos

Fonte 18

Comentários

Tamanho 14


Observações

Tamanho 14


Texto padrão

Tamanho 16



Cor da Fonte


Texto Padrão

Preto (#000000)


Observação

Deve ser vermelho escuro (#8b0000), assim fica um texto destacado com uma cor não muito agressiva. Exemplo:


Cor de Fundo


Texto padrão

Não deve conter nenhum fundo


Observações

Deve ser um cinza claro, (#DCDCDC), exemplo imagem acima.



Negrito, Itálico e sublinhado



Negrito

Deve ser usado para destaque de termos e palavras que visualmente ajudam na localização dos termos dentro de todo o texto, assim lendo as palavras em negrito pode ter um "resumo visual".


Itálico

Deve ser usado para termos estrangeiros, ou seja palavras que não são da língua portuguesa  e não são comuns no vocabulário corriqueiro, ou então palavras que devem ter um destaque diferencial com o objetivo da palavra ficar destoante no artigo.   

 

Sublinhado:



Alinhamento

Todo o texto deve estar com o alinhamento como justificado, apenas títulos e subtítulos alinhados a esquerda.


Lista ordenada

A configuração de listas ordenadas da ferramenta não permite colocar linhas em branco entre os tópicos, assim ao fazer um lista ordenada deve ser feita manualmente, colocando a numeração seguida de um hífen ( - ) e aplicar 1 (um) nível de recuo, exemplo:

Obs. Lembrar do Recuo.



Lista não ordenada


As lista não ordenadas podem ser utilizado a função da própria ferramenta, adicionando recuo para subitens de itens, exemplo:




Recuo 


Listas não ordenadas

Ao serem aplicadas, já tem um recuo em relação ao texto, porém quando tem uma lista ordenada que é de subitens, deve conter 1 (um) nível de recuo.


Lista ordenadas

Devem ter 1 (um) nível de recuo e os subitens, deve conter 2 (dois) níveis de recuo.


Subitens 

Devem conter 1 (um) nível de recuo


Link


Os links devem ser utilizados a opção de link da ferramenta, onde a mesma vai colocar o texto em azul e com efeito de sublinhado ao passar o mouse por cima, exemplo: clique aqui.




Tabela


As tabelas devem ser inseridas pela própria ferramenta, onde pode-se informar a quantidade de linhas e colunas desejadas na tabela.











Imagem

As imagens devem contem somente o necessário, assim evitando imagens grandes, também deve ser alinhadas ao centro. 

Uma imagem pode ser incluso pela própria ferramenta ou colar uma imagem da área de transferência.



Vídeo

A opção de inclusão de vídeo é usada de forma a ser incluído o endereço destino de onde está hospedado o vídeo.


Código

A ferramenta permite alterar o modo de edição de texto, para alterar para o modo de edição de "código HTML", assim tendo conhecimento na linguagem de marcação HTML, pode ser editado a formatação por essa opção.


Anexos

A opção de inclusão de anexo deve ser evitada para não deixar a documentação com o tamanho muito grande e se necessário incluir arquivos com tamanhos menores de 4 Mb, mesmo a ferramenta aceitando arquivos de 19 MB.


Índices


índice ao ser incluso no documento obedecerá a formatação feita na opção de formatos, visto no próximo item.

Ao inserir um índice, será automaticamente criado um link para a mesma página onde corresponde ao item configurado.


Formatos

Essa opção resultará no índice, onde deve-se observar como será selecionado cada título e opções.


Título

O título principal de cada sessão deve ser selecionado como "Cabeçalho 1".


Subtítulo

Subtítulos devem estar definidos como "Cabeçalho 2" e assim por diante caso precise de outros níveis.

Texto padrão

O texto padrão deve estar selecionado como "Normal" .


Detalhes da ferramenta "Soluções" do Freshdesk


A ferramenta de edição e criação de documentação não tem muitas opções de formatação como um editor de texto mais avançado, como o ferramentas como o Word da Microsoft, existem algumas limitações que devem ser observadas na edição e criação de documentações.