Wiki IFTM

Orientações para a elaboração de manuais e tutoriais.

Estruturando sua Wiki

A organização da Wiki segue a lógica:

Estante > Livro > Capítulo > Página.

A Estante é o nível mais alto de organização. Ela serve para agrupar livros que possuem um tema em comum.

Definição: Use estantes para grandes departamentos ou áreas de conhecimento.
Exemplo: Estante "VirtualIF".
Como criar: Na barra superior, clique em Estantes > Nova Estante. Dê um nome e uma descrição clara.

Os livros ficam dentro das estantes. É neles que o conteúdo começa a ser categorizado de forma específica.

Definição: Um livro deve tratar de um assunto ou sistema específico.
Exemplo: Dentro da estante "VirtualIF", você pode ter um livro chamado "DOCS - Documentos Oficiais".
Como criar: Dentro de uma Estante, clique em Novo Livro.

Figura 1 - Gerenciamento de Livros

Capítulos são opcionais, mas cruciais para organizar livros longos. Eles servem para agrupar páginas relacionadas.

Definição: Divisões lógicas dentro de um manual.
Exemplo: No livro "DOCS - Documentos Oficiais", você pode ter o capítulo "Elaborar Documentos".
Como criar: Ao abrir um Livro, no menu lateral de ações, clique em Novo Capítulo.

Figura 2 - Gerenciamento de Capítulos

A página é onde o conteúdo (texto, imagens, vídeos) realmente reside.

Definição: A unidade mínima de informação. Cada página deve explicar um processo específico.
Exemplo: no Capítulo "Elaborar Documentos", você pode ter a página "Elementos e Funcionalidades"
Como criar: Você pode criar uma página diretamente dentro de um Livro ou dentro de um Capítulo. Clique em Nova Página no menu de ações.

Figura 2 - Gerenciamento de Capítulos

Padronização de Títulos: Use verbos no infinitivo para tutoriais (ex: "Configurar", "Acessar", "Excluir").
Uso de Imagens: A Wiki permite "colar" prints diretamente no editor de texto. Use isso para ilustrar os passos.
Tags: No final de cada página, use o sistema de "Tags" para facilitar a busca global por palavras-chave que não estão no título.
Permissões: Você pode restringir quem vê cada Estante ou Livro antes de terminar a criação.