Skip to main content

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.