Wiki

Objetivo

Aqui será descrito como utilizar a ferramenta de Wiki do BR-UTM

O que é a Wiki?

A Wiki é o repositório de conhecimento utilizado para o projeto BR-UTM. Aqui ficarão armazenadas as atas de reuniões, documentações, desenhos arquiteturais e decisões tomadas durante a execução do projeto. Os documentos aqui armazenados são criados de maneira colaborativa pelos participantes do projeto.

Cadastro

Para poder contribuir nos documentos, é necessário se cadastrar na ferramenta. O cadastro é gratuito e aberto para toda a comunidade, realizado clicando no menu superior.

Caso encontre problemas no cadastro, entrar em contato com a equipe do DECEA via mattermost

Organização

A wiki é organizada em "Livros", "Capítulos" e "Páginas". Uma página sempre está contida dentro de um livro ou de um capítulo, e um capítulo está sempre contido dentro de um livro.

Além disso, existe a "Estante", que contém um ou mais livros. Um mesmo livro pode estar presente em várias estantes.

Permissões

Todos os documentos na wiki podem ser configurados para que apenas determinados usuários possam visualizá-los ou editá-los. Alguns documentos possuem acesso público, ou seja, o conteúdo fica disponível para visualização até mesmo para quem não possua uma conta.

Outros documentos possuem acesso restrito, como arquivos em construção ou dados sensíveis. Para acessar esses documentos, ou para solicitar a criação de um novo documento restrito, entre em contato com a equipe de administração via ferramenta de comunicação.

Funcionalidades

Edição de texto

A wiki possui um editor de texto com diversas funcionalidades clássicas de edição de texto, como negrito, itálico, mudança de cor, marca texto, entre outras.

Também é possível organizar o texto com blocos colapsáveis, além de inserir trechos de código fonte com suporte para diversas linguagens de programação.

# Trecho de código em python

def main():
  print("Hello World!")

if __name__ = "__main__":
  main()

Importante! Também é possível alterar o modo de edição de texto para "markdown (.md)". Para isso, vá no três pontos do menu superior durante a edição da página, e clique em alterar o editor para "markdown"

Comentários

Todas as páginas possuem uma seção de comentários, onde todos os participantes logados possuem permissão de comentar, proporcionando um ambiente de discussão, sugestões de melhorias e resolução de dúvidas.

Os comentários podem ser respondidos individualmente, deixando as discussões mais organizadas, conforme imagem abaixo:

Os comentários são restritos à pessoas logadas

Versionamento

A wiki também possui a função de versionamento. Nenhum conteúdo é perdido, e todas as alterações, incluindo imagens e comentários, ficam registradas e podem ser restauradas ou recuperadas.

Para visualizar as alterações, e também quem as realizou, basta acessar o menu lateral da página e clicar em "Revisões". Então, é possível visualizar exatamente as mudanças, conforme imagens abaixo:

Diagramas

A wiki é integrada com o popular aplicativo de desenho "draw.io". Portanto, é possível criar, guardar e editar os desenhos e diagramas dentro da própria página.

Para criar um desenho, clique em "Inserir/editar desenho" na barra de ferramentas do editor:

Abaixo está um exemplo de diagrama. Para editar um diagrama já existente, basta clicar duas vezes sobre o diagrama:

Integrações

A ferramenta pode integrar com aplicativos com a funcionalidade de embbed, como o youtube, office365, entre outros.

Para fazer isso, na barra de ferramentas do editor, clique em "Insedir / Editar mídia", e colar o código no campo "Incorporar"

Exemplo de integração com o PowerPoint:

YouTube:

Pequisa

Todo o conteúdo da wiki é pesquisável, simplificando a busca de informações específicas. Para procurar conteúdo, basta usar a barra de busca no menu superior da página

Exportar

É possível exportar uma página, capítulo ou até mesmo um livro inteiro.

As opções de exportação são:

• PDF
• HTML
• Texto
• Markdown (.md)