Padrões de formatação
Pré-requisitos:
Antes de começar a conhecer os padrões dos documentos inseridos na plataforma, é necessário que tenha visto o livro que orienta na criação dos livros, capítulos e páginas. Para acessar o livro clique aqui.
Títulos, Subtítulos e Listas
A adição de títulos tornam a plataforma mais organizada e de fácil visualização para todos, então a seguir será demonstrado como e quando utilizar cada tipo de cabeçalho disponível afim de tornar a plataforma mais agradável e compreensível possível.
Títulos e Subtítulos
Possuímos 4 maneiras de deixarmos nossos títulos destacados. As diferenças entre eles são: o tamanho e a forma na qual a plataforma organiza os subtítulos dentro dos títulos, seguindo um nível hierárquico.
Exemplo do modo que a plataforma organiza em relação à utilização dos diferentes tipos de títulos.
- Header Large deve ser utilizado para o título geral da página, o título no qual todos os subtítulos e tópicos da página estejam diretamente ligado à ele;
- Header Medium somente deve ser utilizado, quando o assunto tratado por ele conter subtítulos e esses subtítulos tenham outros subtítulos dentro deles;
- Header Small constantemente será utilizado para adicionar um conteúdo que contenha seus subtítulos, mas que não tenha mais nenhum outro subtítulo dentro dos subtítulo do "Header Small";
- Header Tiny são utilizado para os subtítulos das páginas, pois ficam organizados com um nível de indentação em relação à seus títulos.
De maneira geral, ao iniciar a escrita de um documento, inicie adicionando pelo ultimo tipo de título, no caso o menor (Header Tiny), e conforme avançar no processo de documentação, caso se depare com um tópico que contenha subtópicos que merecem ser destacados na hierarquia do documento, altere os tópicos principais que anteriormente estavam formatados como Header Tiny para um nível acima (Header Small) e formate os subtópicos recém-adicionados como Header Tiny.
Caso ocorra de dentro de um subtópico, ser necessário necessário criar mais um nível de subtópicos, então repita o processo "promovendo" os títulos já existentes e adicionando os novos com a menor formatação possível.
Listas
As listas numeradas e lista de marcadores devem ser utilizadas ao adicionar conteúdo nos quais devem seguir uma ordem ou cujo os temas são relacionados e precisem ser agrupados.
Listas também devem ser utilizadas para descrever pré-requisitos de um processo ou etapa.
Callouts
Existem 3 maneiras de utilizar os callouts (podendo variar dependendo da situação):
- Para utilizar exemplos e contraexemplos ("Success" e "Danger");
- Para informar ou destacar uma determinada ação ou informação ("Info");
- Para alertar sobre alguma ação ou etapa do processo ("Warning" );
Os callouts de "Success" e "Danger" são excelentes para demonstrar como se deve fazer ou não algum processo, um bom exemplo da utilização deles é a página de espaçamento.
O callout de "Info" destaca um informação na qual é considerada importante na página ou tema inserido.
O callout de "Warning" deve-se utilizar para informar atenção sobre um determinado assunto.
Links
Ao adicionar um conteúdo que tenha ligação direta à outro tema já existente na plataforma, deve-se utilizar o link para referenciar a outra página de maneira que quem esteja lendo, caso queira conhecer esta outra página, basta clicar em alguma palavra ou imagem que contenha o link, que será redirecionado para a mesma.
Links para outras páginas
Quando você utilizar um link que irá redirecionar para outra página, deve-se selecionar a opção "New window", que irá abrir uma nova guia com o conteúdo do link adicionado, que caso você queira voltar para a página anterior, basta fechar a nova página que foi aberta ao clicar no link.
Além disso você deve deixar o link sublinhado, que indicará que é um link e que irá te redirecionar para outra página em uma nova guia.
Links para a mesma página
Quando adicionar um link que aponta para a mesma página, deve-se selecionar a opção de "None", que não irá abrir uma nova guia, mas sim redirecionar direto para a parte da página na qual você adicionou o link.
Caso o link que você for adicionar seja na mesma página e ele seja um título ou subtítulo de algum tópico, você consegue selecionar ele pela aba de adição do link, conforme será mostrado a seguir:
Como visto acima, ao clicar na caixa de Url, a própria Wiki, irá apresentar todos os títulos e subtítulos da página, e selecionando o desejado e salvando, ao clicar na palavra na qual você adicionou o link, será redirecionado direto para aquela parte da página.
Para links que serão direcionados para a própria página, não é necessário deixa-lo sublinhado, mas sim em negrito.
Notações
Existem diversas notações que podemos utilizar para facilitar o entendimento do conteúdo e também organizar melhor os conteúdos a serem adicionados. A seguir será demonstrado algumas notações e como utiliza-las ao adicionar uma nova informação à plataforma.
Palavras Estrangeiras
Algumas vezes será necessário utilizar palavras estrangeiras, então elas devem ser adicionadas como Italic, que faz uma leve inclinação para a direita na palavra, fazendo com que seja mais fácil identificar que se trata de uma palavra estrangeira.
Tabelas
Ao adicionar uma tabela, seu conteúdo deve ser alinhado ao centro, a largura das colunas devem ser ajustadas conforme a maior coluna (título ou conteúdo) e os títulos devem ser colocados em negrito, caso existam. Por exemplo, as tabelas a seguir:
| Responsável | Data Prevista | Data de Entrega |
| Fulano da Silva | 10/02/2021 | 25/02/2021 |
| Irineu da Fonseca | 15/03/2021 | 25/05/2021 |
A tabela acima está sem nenhuma formatação padrão, ao formata-la no padrão pré-estabelecido ela deve ficar parecida com a seguinte tabela:
| Responsável | Data Prevista | Data de Entrega |
| Fulano da Silva | 10/02/2021 | 25/02/2021 |
| Irineu da Fonseca | 15/03/2021 | 25/05/2021 |
Imagens
Ao adicionar uma imagem à plataforma ou uma legenda para a mesma, você deve alinhar centralizado através do botão "Allign center". Assim como o conteúdo de tabelas também devem ser centralizados.
Formatação do texto
A formatação vai depender muito do que estiver sendo adicionado, mas por padrão deve-se seguir algumas maneiras para tornar plataforma mais organizada e padronizada.
A cor padrão é preto, salvo exceções bem especificas e que sejam realmente necessário.
Negrito
Negrito deve ser sempre utilizado para destacar alguma palavra chave ou de extrema importância, de forma que ao ler apenas os termos em negrito, seja possível entender aquele trecho.
Além disso, negrito também é utilizado nos títulos e subtítulos das páginas.
Outro uso para a formatação em negrito é para um link que aponte para a mesma página.
Itálico
O Itálico deve ser utilizado ao adicionar uma palavra estrangeira, que será uma maneira de fácil identificação que a palavra não é oriunda da nossa língua nativa. Que é um método bastante utilizado nos sites de pesquisas.
Sublinhado
O Sublinhado está sendo destinado a links que direcionam a para uma nova página, que deve ser aberta em uma nova guia.
Sobrescrito
O uso de sobrescrito está restrito para a adição de referências. Onde deve-se utilizar um valor numérico após a palavra ou frase que será referenciada no final da página.
Subscrito
O uso de subscrito está restrito para descrições de imagens. Ao adicionar uma imagem, logo em seguida, utilize o subscrito de forma centralizada para identificar a imagem.
Alinhamento Padrão
O alinhamento padrão utilizado é sempre à esquerda, que por padrão a Wiki já configura quando inicia a inserção de algum conteúdo novo.
Linha Horizontal
Sempre que uma página possuir algum tipo de pré-requisito, seja por ser continuação de outra página ou por outro conhecimento necessário antes de avançar na leitura do documento, deve-se utilizar uma linha horizontal demarcando o pré-requisito, do início do conteúdo abordado na página.
Além disso, as linhas horizontais devem ser utilizadas para separar tópicos diferentes dentro da mesma página. Indicando o fim do tópico abordado e início do tópico seguinte.
Fluxogramas
Ao adicionar um fluxograma na Wiki, caso o mesmo não seja tão grande, adicione diretamente o fluxograma, mas se for um fluxograma grande, que ficará difícil visualizar os textos contidos nele, adicione uma imagem e crie um link nela que direcione para outra página, pois nesta nova página será muito mais fácil de ser visualizada.
Mensagens de Versionamento
As mensagens de versionamento devem conter o relato das alterações ou adições de conteúdos, sejam pequenas alterações ou criações de novas páginas, pois caso surja a necessidade de retornar alguma página à alguma versão anterior, seja mais fácil de identificar através das mensagens de versionamento.
No Comments