Introdução à Wiki

• 1. Conceitos básicos da wiki
• 2. Criando Prateleiras
• 3. Criando Livros
• 4. Criando Capítulos
• 5. Criando e editando Páginas

1. Conceitos básicos da wiki

O que é uma wiki?

Wiki é uma ferramenta para criação e edição de páginas online, de maneira colaborativa e rápida. Ou seja, várias pessoas podem criar ou editar o conteúdo.

O que é adicionado na wiki não deve ser tratado de uma forma "estática", ou seja, algo que nunca será mudado. Ao invés disso, deve ser visto como um conteúdo que sempre estará passando por revisões e incrementos, ou seja, quanto maior o número de autores, mais completo e confiável será o seu conteúdo.

Uma das maiores vantagens da wiki, é o versionamento das páginas. O que isso significa? Isso significa que as alterações são registradas, e em caso de necessidade é possível recuperar versões anteriores da página.

Por que utilizar a wiki?

O intuito de utilizar a wiki é fazer com que os processos, definições e atribuições, sejam documentados e centralizados. De modo que, ao invés de consultar um diretório offline com informações desencontradas ou desatualizadas, seja possível acessar uma plataforma online, criada e atualizada colaborativamente. Dando credibilidade ao conteúdo abordado na plataforma e garantindo que esteja sempre disponível para qualquer usuário cadastrado.

Qualquer pessoa pode colaborar na wiki?

Sim, desde que possua um cadastro prévio à plataforma, é possível colaborar com o conteúdo disponível da wiki. Mas lembre-se, todas as alterações são registradas e versionadas, ou seja, caso seja identificado que um usuário tenha, deliberadamente, acrescentado informações incorretas ou distorcidas, isso pode acarretar punições.

O que deve ser documentado na wiki?

Pelo fato de a documentação ser uma atividade relativamente recente dentro da cultura da empresa, as documentações visam definir os processos padrões e seus respectivos subprocessos, de modo à unificar o fluxo de trabalho da equipe de qualidade e desenvolvimento independente do setor trabalhado (FISCO/ERP). Após a conclusão da etapa anterior, o foco é voltado para a documentação dos processos dos sistemas e suas respectivas particularidades.

Como é a estrutura da wiki?

A plataforma possui a estrutura de uma biblioteca, seguindo a seguinte hierarquia: prateleiras, livros, capítulos e páginas.

Uma prateleira deve tratar de tópicos abrangentes e nela estarão contidos os livros que abordam assuntos relacionados à prateleira.

O livro é a estrutura responsável por agrupar capítulos e páginas, de maneira bem definida e específica. Sendo que, um livro pode possuir mais de um exemplar. O que isso significa? Um livro pode coexistir em mais de uma prateleira simultaneamente, sendo que ao alterar uma cópia do livro, todos os demais exemplares também serão alterados.

Um capítulo pode agrupar uma ou mais páginas relacionadas ao tópico em questão. No caso de um processo, por exemplo, temos o livro que aborda o processo e os capítulos que abordam cada subprocesso existente.

As páginas são as menores instâncias de conteúdo disponíveis. As páginas são base da wiki, elas que carregam o conteúdo propriamente adicionado. Sendo que, não necessariamente uma página deve ser vinculada à um capítulo, por exemplo, uma página de "índice" não deve estar alocada à nenhum capítulo do livro.

 

 

2. Criando Prateleiras

Passos iniciais

Localizando o menu de criação de prateleira

Para criar uma prateleira, você deve primeiramente estar no menu de prateleiras. Para isso, clique no ícone referente às prateleiras, no canto superior direito.

Nota: Observe que, o menu inicial da wiki é praticamente idêntico ao menu de prateleiras. Entretanto na tela inicial da wiki, não é possível gerenciar prateleiras.

---

Ao acessar as prateleiras, você verá uma tela com a listagem das prateleiras criadas e algumas informações relacionadas à elas. Vamos buscar pelo menu "Ações" e clicar em "Nova Prateleira"

Nota: No exemplo acima, o menu "ações" se encontra do lado superior direito da tela. Mas para alguns usuários os itens podem estar dispostos de maneira diferente na tela. Entretanto, os menus são os mesmos.

---

Parâmetros de criação de prateleira

1 - Nome

Neste campo deve ser adicionado o nome da prateleira, sendo que deve-se utilizar a primeira letra maiúscula e evitar o uso de pontuação (como exclamação, vírgula, ponto final, etc).

2 - Descrição

Neste campo, deve-se informar quais assuntos são tratados na prateleira e uma breve descrição sobre o que é abordado.

3 - Gerenciamento de livros

Neste espaço, é possível gerenciar os livros que já foram criados que estarão alocados nesta prateleira. Adicionar um livro à prateleira, não o remove de outra prateleira, apenas é criado mais um "exemplar" daquele conteúdo. Sendo que, qualquer alteração feita em qualquer exemplar do livro, será feita em todos exemplares existentes do livro.

4 - Imagem de capa

Neste campo é possível adicionar uma imagem à prateleira. Imagens tornam o conteúdo mais atraente e ilustrativo, por isso, é recomendável que adicione uma imagem à capa da prateleira.

5 - Tags de Prateleira

Até o momento, o espaço para Tags de prateleira ainda não possui um uso relevante dentro da plataforma. Por isso, este espaço pode ser deixado em branco. Caso seja criada uma padronização para as tags e seus valores, este tópico será atualizado.

3. Criando Livros

Passos iniciais

Localizando o menu de criação de livros

Para criar um livro, você deve primeiramente estar em uma prateleira. E logo após acessar a prateleira desejada, basta procurar uma das duas opções mostradas abaixo.

Nota: No exemplo abaixo, o menu "ações" se encontra do lado superior direito da tela. Mas para alguns usuários os itens podem estar dispostos de maneira diferente na tela. Entretanto, os menus são os mesmos.

---

Parâmetro de criação de livro

 

1 - Nome

Neste campo deve ser adicionado o nome do livro, sendo que deve-se utilizar a primeira letra maiúscula e evitar o uso de pontuação (como exclamação, vírgula, ponto final, etc).

2 - Descrição

Neste campo, deve-se informar quais assuntos são tratados no livro e uma breve descrição sobre o que é abordado.

3 - Imagem de capa

Neste campo é possível adicionar uma imagem ao livro. Imagens tornam o conteúdo mais atraente e ilustrativo, por isso, é recomendável que adicione uma imagem à capa do livro.

4 - Tags de Livro

Até o momento, o espaço para Tags de Livro ainda não possui um uso relevante dentro da plataforma. Por isso, este espaço pode ser deixado em branco. Caso seja criada uma padronização para as tags e seus valores, este tópico será atualizado.

4. Criando Capítulos

Passos iniciais 

Localizando o menu de criação de capítulos

Para criar um capítulo, acesse o livro onde deseja criar e no menu de ações, no canto superior direito clique na opção "Novo capítulo".

Nota: No exemplo acima, o menu "ações" se encontra do lado superior direito da tela. Mas para alguns usuários os itens podem estar dispostos de maneira diferente na tela. Entretanto, os menus são os mesmos.

Parâmetro de criação do Capítulo 

1 - Nome 

Campo destinado ao nome que será dado ao capítulo, nele é importante que seja um nome simples, mas que seja bastante intuitivo ao que se destina o capítulo.

2 - Descrição

No campo de descrição, devem ser detalhados os assuntos tratados no capítulo de maneira mais rápida e direta, de forma que ao ler a descrição já seja possível identificar o que será tratado no capítulo em questão.  

3 - Tags 

Até o momento, o espaço para Tags de Capítulo ainda não possui um uso relevante dentro da plataforma. Por isso, este espaço pode ser deixado em branco. Caso seja criada uma padronização para as tags e seus valores, este tópico será atualizado.

5. Criando e editando Páginas

Passos iniciais 

Localizando o menu de criação de páginas

Para criar uma página, acesse o livro ou o capítulo onde deseja criar e no menu de ações, no canto superior direito clique na opção "Nova página".

Nota: No exemplo acima, o menu "ações" se encontra do lado superior direito da tela. Mas para alguns usuários os itens podem estar dispostos de maneira diferente na tela. Entretanto, os menus são os mesmos.

Nota: As criações de páginas podem ser feitas dentro de um determinado capítulo ou diretamente em um livro. 

Parâmetros de criação da página 

1 - Nome da Página

Campo destinado ao nome da página que ficará visível dentro do livro ou capítulo criado.

2 - Conteúdo

Este é o campo destinado para todo o conteúdo reservado para a página, nele pode ser adicionado imagens, links e muitas outras formatações para facilitar o entendimento dos documentos, muito semelhante à algumas ferramentas utilizadas no dia-a-dia (Word, LibreOffice, Documentos do Google Drive, etc...).

Para saber qual a formatação padrão utilizada para documentação das páginas, clique aqui.

Ferramentas de edição da página

1 - Desfazer e refazer

Bem comum em editores de modo geral, essas opções estão disponíveis para "desfazer" as últimas alterações, ou "refazer" algo que foi desfeito.

2 - Formatos

Headers são utilizados para uma melhor organização e navegação da página, utilizando-os como cabeçalhos ou títulos para os tópicos, podemos dividir seções e assuntos dentro de uma página. Da ordem do maior para o menor, temos: Large, Medium, Small, Tiny. Na lateral da tela, podemos acompanhar a navegação da página, sendo que os cabeçalhos menores são como "filhos" dos cabeçalhos maiores. Criando um estrutura de árvore na página.

Paragraph é o texto comum, que será utilizado na maior parte do tempo nas páginas.

Blockquote é uma tag para identificar citações de outras fontes ou outros trechos.

Exemplo de blockquote

Code Block é a tag utilizada para a inserção de um bloco de código. Onde há o campo para informar qual linguagem está sendo utilizada no exemplo.

// Exemplo de código
// Palavras reservadas, comentários e strings são identificados de acordo com a linguagem
if (Condicao) then
begin
  LVariavel := 'String teste';
end;

Inline code é semelhante à opção Code Block, entretanto, é utilizada apenas para expressões que contém uma única linha especificamente.

LVariavel := True;

Callouts são opções para dar destaque em determinados trechos ou frases, onde podemos enriquecer o entendimento do conteúdo da página com as seguintes opções:

Info - Com a cor azul, indica uma informação relevante complementar ao assunto tratado, seja uma nota, uma observação ou outro tipo de informação.

Success - Com a cor verde, indica algo feito da maneira correta ou com o resultado esperado.

Warning - Com a cor laranja, indica um aviso que exige atenção e deve-se evitar.

Danger - Com a cor vermelha, indica algo feito da maneira incorreta e provavelmente estará acompanhado por uma callout de "Success" indicando a forma correta para o mesmo item.

3 - Formatação

Todos usados para destacar determinado trecho, sendo:

Negrito

Itálico

Sublinhado

Tachado

4 - Sobrescrito e Subscrito 

É um número, um algarismo, um símbolo ou um indicador menor do que a linha de tipo normal e é definido ligeiramente abaixo (subscrito) ou acima (sobrescrito) dela.

Ex:

H₂O  (subscrito) ou M² (sobrescrito).

5 - Cor do texto e cor do fundo 

Primeira opção usada para alterar somente a cor da fonte, diferente da segunda que altera somente o fundo do texto.

6 - Alinhamento

6.1 - Alinhar trecho à margem esquerda.

6.2 - Alinhar trecho ao centro da página/local.

6.3 - Alinhar trecho à margem direita.

6.4 - Espaços são adicionados entre as palavras para que ambas as bordas de cada linha sejam alinhadas com as margens. A última linha do parágrafo é alinhada à esquerda.

7 - Lista de marcadores

Utilizado para iniciar cada linha com o marcador " • ".

8 - Lista numerada 

Utilizado para iniciar cada linha com o marcador numérico sequencial.

9 - Diminuir e aumentar recuo

Altera a posição do ponteiro do texto, parecido com TAB.

10 - Tabelas

Usado para criar e editar tabelas, definindo quantidade de colunas e linhas.

11 - Inserir imagens 

Abre-se um tela para utilizar as imagens já disponíveis ou fazer o upload de uma que desejar.

Geralmente ao adicionar uma imagem, colocamos em Centralizar.

12 - Inserir/Editar links

Criar links externos para outras páginas, em Target configurado como None será aberto utilizando a aba atual do navegador, se configurado como New window abrirá em uma nova aba(Recomendado).

13 - Linha horizontal 

É adicionado uma sutil linha na horizontal, geralmente usada como separador.

14 - Desenho

Abrirá uma ferramenta onde poderá fazer seu desenho, muito utilizado para Fluxogramas.

Atenção: Ao usar essa opção, certifique de ter salvo suas alterações, ou apertar em Save / Exit na ferramenta, NÃO recarregue a página pois perderá suas alterações, segue imagem dos botões.

15 - Inserir/Editar mídia, Limpar formatação, Código fonte e Tela cheia 

15.1 - Na tela que se abre, na primeira aba, poderá adicionar mídia como por exemplo vídeo do YouTube.

15.1.1 Na segunda aba, poderá colocar uma mídia gerada por trecho como HTML.

15.2 - Limpa toda formatação no trecho selecionado, retirando Negrito, Itálico, Sublinhado, etc.

15.3 - Abre o código fonte da página.

15.4 - Expande a tela liberando da parte superior o espaço onde localiza-se a Logo da SuperSoft.