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 título ou subtítulo afim de tornar a plataforma cada vez mais agradável e mais compreensível possível.

Títulos e Subtítulos

Possuímos 4 maneiras de deixarmos nossos títulos destacados, que as diferenças deles 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 inserir algo novo na plataforma, inicie adicionando pelo ultimo tipo de título, no caso o menor (Header Tiny), e conforme for o processo de adição, se o conteúdo conter demais temas relacionado ao título adicionado, altere ele para um nível acima e utilize o que estava sendo utilizado para o título para os subtítulos e assim por diante.

Exemplo de "Header Large"

Exemplo de "Header Medium"

Exemplo de "Header Small"

Exemplo de "Header Tiny"

Listas

Callouts

Existem 3 maneiras que devem ser utilizados 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.

Imagens

Ao adicionar uma imagem a 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.

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

As notações serão muito utilizadas no preenchimento da plataforma ao definir um processo dos sistemas existente.

Todo sistema contém seus menus e seus submenus(?) adjacentes, então ao definir um caminha, por exemplo o menu: Movimentação > Rotinas Mensais > Alteração Salarial, que irá efetuar uma alteração salarial dos funcionários, deve ser definido da seguinte forma.

Utilize o ultimo nome do que o caminho descrito irá fazer e adicione um número sequencial, iniciando do 1 até o numero necessário e logo em seguida adicione no número a opção de sobrescrito e link para a parte de legenda dos caminhos do processo, conforme será exemplificado à seguir:

Alteração Salarial ¹

Após o usuário clicar no link, será redirecionado para a parte de legenda dos caminho, podendo visualizar o caminho especifico e os demais contidos naquela página.

Legendas dos caminhos

Alteração Salarial ^1:Movimentação > Rotinas Mensais > Alteração Salarial

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.