Sistema de Manuais


Apresentação

O BookStack é o sistema utilizado para registrar, organizar e consultar documentos, procedimentos e informações internas do campus.
Ele funciona de forma muito parecida com uma estante de biblioteca — com estantes, livros, capítulos e páginas, cada um com sua função específica.

1- Estrutura de Organização

1.1 - Estantes (Shelves)

As estantes agrupam livros de um mesmo setor ou tema.
É o nível mais alto da organização. Exemplos:

Cada estante pode conter vários livros relacionados ao mesmo assunto.

1.2 - Livros (Books)

Os livros reúnem informações sobre um assunto específico dentro de uma estante.

Exemplos dentro da estante “Administração”:

Um livro pode conter capítulos e páginas, conforme a necessidade.

1.3 - Capítulos (Chapters)

Os capítulos servem para organizar melhor o conteúdo dentro de um livro, separando por tipo ou etapa de processo.

Exemplos dentro do livro “Gestão de Contratos”:

Capítulos ajudam a deixar a navegação mais simples e o conteúdo mais organizado.

1.4 - Páginas (Pages)

As páginas contêm o conteúdo em si: textos, imagens, anexos, links ou formulários.

Exemplos dentro do capítulo “Elaboração de Contratos”:

As páginas são o local onde o texto é realmente escrito e publicado.

🗄️ Estante: Administração
 │── 📘 Livro: Gestão de Contratos
 │        │── 📂 Capítulo: Elaboração de Contratos
 │        │        │── 📄 Página: Checklist de Documentos
 │        │        │── 📄 Página: Modelos de Termo de Referência
 │        │── 📂 Capítulo: Execução Contratual
 │                  │── 📄 Página: Acompanhamento de Fornecedores
 │── 📘 Livro: Compras e Licitações
 │        │── 📂 Capítulo: Dispensa e Inelegibilidade
 │        │── 📂 Capítulo: Pregão e Concorrência
 │── 📘 Livro: Gestão de Pessoas
           │── 📂 Capítulo: Frequência
           │── 📂 Capítulo: Afastamentos e Férias

2 - Permissões de Acesso

O sistema trabalha com três níveis principais de visibilidade:

2.1 - Público (para todos)

2.2 - Acesso Institucional (para usuários logados)

2.3 - Restrito (para um setor ou grupo específico)


Utilização do sistema de manuais

1 - Como acessar e fazer login

Acesse o Sistema de Manuais pelo navegador, no endereço:

https://manuais.araquari.ifc.edu.br/

No topo da página, clique em Entrar:

image.png

Faça login com seu Araquari.ID e clique em Entrar:

image.png

Após o login, você retornará ao site já autenticado e passará a visualizar as estantes, livros, capítulos e páginas para os quais possui permissão de acesso. Dependendo das permissões configuradas em cada conteúdo, é possível que alguns itens não apareçam para determinados usuários. Isso não significa, necessariamente, que houve problema no login.

No Sistema de Manuais, os conteúdos podem ser configurados com diferentes níveis de visibilidade, como conteúdo público, conteúdo restrito a usuários logados ou conteúdo restrito a grupos específicos.

Mais adiante, veremos com mais detalhes como funcionam essas permissões de visualização.

image.png

2 - Como navegar pelo conteúdo e criar livros, capítulos e páginas

Após fazer login, você poderá navegar pelos conteúdos para os quais seu perfil possui permissão de acesso. Na barra superior, também é possível acessar os filtros de Estantes e Livros, localizados ao lado do seu nome, no canto superior direito.

Neste tutorial, será utilizado como exemplo o usuário ‘teste.teste’, que faz parte do grupo DAP e possui permissão para criar, editar e excluir conteúdos dentro da estante DAP - Direção de Administração e Planejamento, clique na estante para acessá-la:

image.png

Ao acessar a estante, será exibido um menu lateral com as ações disponíveis para aquele conteúdo:

image.png

Para criar um novo livro dentro da estante, clique em Novo livro:

image.png

Será aberta a tela de criação do livro. Nela, devem ser preenchidos os seguintes campos:

Depois de preencher as informações, clique em Salvar Livro.

image.png

Ao clicarmos em salvar livro, você será direcionado automaticamente para criação de página e capítulos, conforme mostra a imagem abaixo; perceba que a opção lateral de Ações também ficou disponível e é nela onde faremos a maior parte das configurações:

image.png

2.2 - Entendendo as permissões

As permissões são as configurações que definem quem pode visualizar um conteúdo e quem pode realizar ações nele, como criar, editar ou excluir.

Em outras palavras, são elas que controlam o acesso dentro do Sistema de Manuais.

Isso é importante porque nem todo conteúdo precisa ficar visível para todas as pessoas. Alguns materiais podem ser públicos, outros podem ser destinados apenas a usuários logados no sistema e outros podem ser restritos a setores ou grupos específicos.

Por exemplo:

Por isso, antes de criar um livro, capítulo ou página, é importante pensar em quem deve ter acesso àquele conteúdo.

2.2.1 - Herança de permissões

No sistema, estantes, livros, capítulos e páginas fazem parte de uma estrutura organizada. Por causa disso, muitas vezes um conteúdo pode herdar as permissões do item que está acima dele.

Funciona assim:

Na prática, isso significa que você não precisa configurar tudo manualmente a cada novo item criado, desde que a estrutura acima já esteja com as permissões corretas.

Essa lógica ajuda a manter a organização e evita retrabalho.

2.2.2 - Quando vale a pena usar herança

A herança de permissões é recomendada quando todo o conteúdo dentro daquela estrutura terá o mesmo tipo de acesso.

Exemplo: se um livro inteiro será utilizado apenas pela equipe de um setor, faz sentido configurar a permissão no livro e deixar capítulos e páginas herdarem essa configuração automaticamente.

Assim, tudo ficará padronizado e mais simples de administrar.

2.2.3 - Quando vale a pena configurar permissões próprias

Em alguns casos, um item pode precisar de uma regra diferente do restante da estrutura.

Por exemplo:
um livro pode conter conteúdos gerais de um setor, mas uma página específica dentro dele pode precisar ficar visível apenas para um grupo menor de pessoas.

Nesses casos, é possível desativar a herança e configurar permissões próprias para aquele item.

Isso dá mais flexibilidade ao sistema, mas também exige mais atenção na configuração.

2.2.4 - Vamos à prática

Clique em Permissões e vamos enteder como configurar cada uma delas:

image.png

Ao configurar permissões, você verá alguns perfis ou grupos de acesso. Os mais comuns são:

Esses perfis ajudam a definir com precisão quem poderá acessar cada conteúdo.

2.2.4.1 - O que cada permissão significa

Além de escolher quem terá acesso, também é necessário definir o que essa pessoa poderá fazer.

As permissões mais comuns são:

Na prática, isso significa que uma pessoa pode, por exemplo, ter permissão apenas para visualizar um livro, sem poder alterar nada nele.

Outra pessoa pode ter permissão para visualizar e editar, mas não para excluir.

Exemplo prático:

Imagine a seguinte situação:

  1. a estante de um setor está disponível apenas para a equipe daquele setor;
  2. dentro dela, existe um livro com procedimentos internos;
  3. esse livro possui um capítulo com orientações gerais;
  4. dentro desse capítulo, existe uma página que precisa ser visível para todos os servidores logados.

Nesse caso, essa página pode receber uma permissão própria, diferente do restante do conteúdo.

Ou seja, mesmo estando dentro de uma estrutura mais restrita, ela pode ser configurada para alcançar um público maior:

image.png

image.png

Ao selecionarmos o grupo Usuários logados, será aberta a caixa de permissões correspondente a esse perfil. Neste exemplo, marcamos que os usuários logados terão apenas permissão para visualizar este livro. Em seguida, clique em Salvar Permissões para finalizar:

image.png

ATENÇÃO: É importante observar que, mesmo que abaixo também exista a opção Todos os outros, o sistema faz diferenciação entre usuários logados e usuários não logados. Assim, você pode definir permissões diferentes para cada um desses públicos, conforme a necessidade do conteúdo.

Ao definir permissões, é importante revisar com cuidado o resultado esperado.

Uma configuração incorreta pode fazer com que:

Por isso, sempre que possível, vale conferir:

OBS: Pode parecer estranho, em um primeiro momento, que um conteúdo possa ter permissões diferentes para públicos diferentes dentro do mesmo sistema. No entanto, isso faz parte da flexibilidade do BookStack. O sistema permite ajustar o acesso de forma bastante detalhada, para que cada conteúdo fique disponível exatamente para o público certo. Por esse motivo, ao criar livros, capítulos e páginas, pense sempre primeiro no conteúdo e depois em quem deve ter acesso a ele

ATENÇÃO: Com base nessas informações, é importante entender e reforçar que o sistema, por padrão, tem acesso público para estantes, livros, capítulos e páginas por meio do perfil Todos os outros. No entanto, o sistema interpreta Todos os outros como usuários não logados. Isso significa que, ao criar um conteúdo, é necessário definir com atenção quem poderá acessá-lo após o login. Em outras palavras, não basta pensar apenas em quem está fora do sistema, mas também em quais usuários ou grupos internos deverão ter permissão para visualizar aquele conteúdo. Por exemplo, imagine que você queira restringir uma página para uso exclusivo da equipe do DAP. Nesse caso, será necessário selecionar o grupo correspondente ao DAP e desmarcar a opção Todos os outros. Enquanto a opção Todos os outros permanecer marcada, a página continuará pública e poderá ser visualizada por qualquer pessoa que acessar o sistema sem estar logada. Agora imagine outra situação: você quer que determinado conteúdo seja visualizado apenas por usuários logados, mas sem restringir o acesso a um setor específico. Nesse caso, você deve configurar a permissão para Usuários logados e também ter atenção para não manter habilitada a opção Todos os outros, caso não queira que o conteúdo continue público.

2.3 - Criando Páginas e Capítulos

Neste momento, você pode organizar a documentação de duas formas:

A escolha entre uma opção e outra depende da forma como você deseja organizar o conteúdo. Para conteúdos mais curtos ou isolados, pode ser suficiente criar uma página diretamente no livro. Já para conteúdos maiores, com vários assuntos relacionados, o ideal é utilizar capítulos para manter a organização.

2.3.1 - Criando uma página diretamente no livro

Para criar uma página diretamente no livro, clique em criar uma Nova Página. Essa opção também pode ser acessada pelo menu Ações, no lado direito da tela:

image.png

Ao criar a página, você será direcionado para a tela de edição.

Nessa tela, será possível:

image.png

O editor funciona de forma semelhante a outros editores de texto, o que facilita bastante o uso mesmo para quem ainda não tem familiaridade com o sistema.
Um dos pontos mais importantes do editor está na opção Parágrafo, pois é nela que você pode definir a estrutura do conteúdo:

image.png

Nessa opção, você poderá usar, por exemplo:

Os cabeçalhos são especialmente importantes porque ajudam a organizar visualmente o texto e também criam automaticamente um menu lateral de navegação na página. Isso facilita a leitura, principalmente em conteúdos mais longos.

2.3.2 - Utilizando o modelo padrão de documentação

Para facilitar a criação de novas páginas, o sistema disponibiliza um modelo padrão de documentação, acessível no canto direito da tela, por meio do menu Modelos:

image.png

Ao selecionar esse modelo, o sistema carrega uma estrutura básica de texto que pode ser usada como referência para novas documentações:

image.png

Esse recurso é útil para manter um padrão visual e textual entre os conteúdos publicados pelo setor, facilitando a escrita, a leitura e a organização dos manuais.

Ao utilizar o modelo, o sistema insere uma estrutura básica de documentação que pode ser seguida como referência nas demais páginas. Isso ajuda a manter maior uniformidade na documentação do departamento, tornando os conteúdos mais padronizados e fáceis de compreender.

Ao rolar a página, é possível identificar no texto várias das marcações disponíveis no menu Parágrafo. Entre os exemplos apresentados, é possível observar:

Todos esses elementos podem ser aplicados no editor de forma simples: basta selecionar o texto desejado, clicar na opção Parágrafo e, em seguida, escolher a formatação que deseja utilizar:

image.png

Clique em Salvar Página, conforme abaixo:

image.png

Veremos que a página foi salva com o conteúdo inserido. No lado esquerdo da tela, temos a navegação da página, formada pelos cabeçalhos definidos no menu Parágrafo. Logo abaixo, temos a navegação do livro, que indica em qual estrutura a página foi criada:

image.png

OBS: Os cabeçalhos facilitam muito a navegação em manuais longos. Muitas vezes, o usuário deseja ir diretamente a um ponto específico do conteúdo, e essa navegação lateral ajuda justamente nisso, permitindo localizar com mais rapidez a seção desejada.

Atente-se também que, ao lado direito da página, está disponível o menu lateral de Ações. Nele, você poderá editar a página, copiá-la para reaproveitar o conteúdo, movê-la entre livros e estantes para os quais tenha permissão de acesso, consultar as revisões já realizadas, excluí-la e, principalmente, acessar as Permissões da página, conforme mostra a imagem abaixo.

image.png

As permissões da página seguem a mesma lógica apresentada no item 2.2 - Entendendo as permissões. Assim, caso você deseje tornar esta página pública, restringi-la a usuários logados ou limitar o acesso a grupos específicos, é nessa opção que essa configuração deverá ser feita.

Lembre-se que estantes, livros, capítulos e páginas podem ter permissões próprias. Isso significa que você pode ter, por exemplo, um livro público e, dentro dele, manter capítulos ou páginas com acessos diferentes, conforme a necessidade do conteúdo.

Isso significa que a página pode:

Esse recurso é útil quando um mesmo livro reúne conteúdos do mesmo tema, mas destinados a públicos diferentes.

2.3.4 - Criando capítulos

Além de criar páginas diretamente no livro, também é possível criar capítulos.

Os capítulos servem para organizar melhor o conteúdo, agrupando páginas relacionadas dentro de uma mesma seção.

Esse recurso é recomendado quando o livro possuir vários assuntos ou quando for necessário separar o conteúdo por etapas, temas ou tipos de procedimento.

Para criar um capítulo, utilize a opção Criar um Novo Capítulo no livro:

image.png

Depois disso, será aberta a tela de criação do capítulo, onde você poderá informar:

image.png

Ao salvarmos, seremos direcionados para dentro do capítulo. A partir dele, poderemos criar páginas diretamente em sua estrutura, conforme mostra a imagem abaixo:

image.png

O processo de criação é exatamente o mesmo da página criada diretamente no livro. Neste exemplo, vamos criar duas páginas dentro do capítulo, com os nomes Página de capítulo 01 e Página de capítulo 02. Depois disso, ao retornarmos para a navegação do livro Exemplo 01, veremos que o sistema exibirá o capítulo identificado pela guia vermelha, contendo as duas páginas criadas em seu interior.

image.png

A criação de capítulos serve principalmente para organizar melhor o conteúdo do livro, facilitando a navegação e agrupando páginas relacionadas em uma mesma estrutura. O sistema não obriga o uso de capítulos, pois isso depende da forma como você deseja organizar a documentação. Ainda assim, recomendamos utilizá-los sempre que houver várias páginas sobre um mesmo tema.

Um livro pode conter quantos capítulos e páginas forem necessários. Além disso, a ordem desses itens pode ser alterada a qualquer momento por meio da opção Ordenar, disponível no menu lateral à direita.

2.4 - Como ordenar capítulos e páginas do seu livro

Depois de criar páginas e capítulos, você poderá reorganizar a estrutura do livro conforme a necessidade.

Para isso, acesse o livro desejado e, no menu lateral à direita, clique em Ordenar.

image.png

Nessa tela, será possível alterar a posição de páginas e capítulos, organizando os conteúdos na sequência desejada. Também será possível mover páginas para dentro ou para fora de capítulos, conforme a estrutura que você quiser adotar.

image.png

Agora você poderá ordenar os capítulos e as páginas da forma que considerar mais adequada. O sistema apresenta, logo abaixo do nome do livro Exemplo 01, algumas sugestões de ordenação, como por nome, data de criação, entre outras. No entanto, também é possível reorganizar os itens manualmente, arrastando e soltando capítulos e páginas conforme a necessidade. Para isso, posicione o mouse sobre o ícone de arrastar do item desejado image.png, clique e mantenha pressionado. Em seguida, arraste o item para a posição em que deseja deixá-lo.

Nesse processo, você também poderá mover páginas soltas para dentro de um capítulo, ou retirar de um capítulo páginas que tenham sido criadas dentro dele. Veja na imagem abaixo um exemplo de como essa reorganização pode ser feita após o arraste:

image.png

Clique em Salvar Nova Ordenação, para aplicar a nova organização do livro. Em seguida, você verá o conteúdo já exibido com a ordem que acabou de definir:

image.png

OBS: A ordenação é importante para organizar o manual de forma mais clara, destacando primeiro os conteúdos mais relevantes ou mais utilizados. Isso facilita a navegação e melhora a experiência de quem consulta a documentação.

2.5 - Quando usar páginas soltas e quando usar capítulos

De forma geral, você pode criar páginas diretamente no livro quando o conteúdo for mais simples, curto ou independente, ou seja, quando não houver necessidade de agrupar várias páginas dentro de um mesmo assunto.

Já os capítulos são mais indicados quando o livro reunir conteúdos relacionados entre si, especialmente quando houver várias páginas sobre um mesmo tema, processo ou procedimento. Nesse caso, o capítulo ajuda a manter a documentação mais organizada e facilita a navegação de quem consulta o material.

O sistema não obriga o uso de capítulos. Essa escolha depende da forma como você deseja estruturar a documentação. Ainda assim, sempre que houver várias páginas sobre um mesmo tema, a recomendação é utilizar capítulos para evitar que o livro fique desorganizado ou com muitas páginas soltas.

Em resumo:

Essa definição ajuda a manter o manual mais claro, mais fácil de navegar e mais simples de manter ao longo do tempo.

3 - Boas práticas de organização

Ao criar conteúdos no Sistema de Manuais, procure sempre pensar primeiro em como a informação será consultada pelos usuários. Antes de começar a escrever, vale definir se o conteúdo ficará melhor organizado em páginas soltas ou em capítulos, bem como quem deverá ter acesso a ele.

Também é recomendável utilizar títulos e subtítulos de forma consistente, pois isso melhora a leitura e facilita a navegação lateral nas páginas. Da mesma forma, o uso do modelo padrão de documentação ajuda a manter uniformidade entre os conteúdos publicados pelo setor.

Outro ponto importante é revisar com atenção as permissões de acesso, conforme explicado no item 2.2 - Entendendo as permissões, para garantir que cada conteúdo fique disponível apenas para o público desejado.

Manter livros, capítulos e páginas bem organizados facilita tanto a manutenção da documentação quanto a consulta por parte dos usuários que utilizarão o sistema no dia a dia.

Ao final da configuração, também é recomendável sair da sua conta no sistema e realizar uma nova verificação. Esse teste é importante para confirmar se:

  1. aquilo que deveria estar público realmente está público;
  2. aquilo que deveria estar restrito a usuários logados não está visível para usuários não logados;
  3. e aquilo que deveria estar restrito a grupos específicos está acessível apenas para os grupos corretos.

Esse cuidado final ajuda a evitar falhas de publicação e garante que as permissões tenham sido configuradas corretamente antes de disponibilizar o conteúdo para os usuários.

ATENÇÃO: Ao criar livros, o sistema permite definir uma capa, que corresponde à imagem exibida em cada um deles. Como utilizamos um padrão institucional e há necessidade de usar imagens gratuitas e livres para uso, entre em contato com a CTI. Em conjunto, definiremos a imagem mais adequada para o seu livro, com base no banco de imagens gratuito utilizado pela CTI em seus sistemas.

Documentação padrão

1. Título um

Texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto

image.png

2. Título dois

Texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto

Texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto

Texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto

OBS: Texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto

2.2 Título dois de dois

Texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto

Texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto

3. Título três

Texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto

Texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto

Texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto

ATENÇÃO: Texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto 

3.3 Título três de três

Texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto

Texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto

PRONTO: Texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto texto