Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Sobre o Confluence

Para que os usuários criem, colaborem e organizem toda a documentação em apenas um lugar, a NDD adotou o Confluence como sua ferramenta.

...

Por meio de páginas e espaços, os times podem criar e colaborar nos diversos materiais que um

...

produto pode possuir.

Espaços

As páginas são armazenadas em espaços. Neles é possível colaborar no trabalho e manter todo o conteúdo organizado. Veja abaixo como organizamos a nossa documentação.

Nome do espaço

Objetivo

Documentação (produto)

  • Agrupar os manuais e releases para publicação no Help Center.

  • Agrupar os artigos de FAQ, solução de problemas e tutoriais para publicação no Help Center.

Nota

Artigos com conteúdo sensível devem ser excluídos do Help Center utilizando a configuração de labels.

Dica

Saiba mais sobre os espaços →

Páginas

Dê vida aos seus documentos aqui. Todo o conteúdo que o usuário visualizará serão criados nas páginas de forma dinâmica e colaborativa.

Dica

Saiba mais sobre as páginas →


Permissões de usuário

Usamos regras de controle de acesso para gerenciar o que um usuário pode ver ou fazer dentro do Confluence.

  • Espectador é um usuário com a permissão apenas de visualização. Ele pode acessar todos os conteúdos disponíveis na ferramenta, pode criar comentários e reagir sobre o conteúdo.

Ao realizar comentários, identifique seu nome ao final.

Solicite o acesso através dos administradores Catarine Maltauro da Silva ou Paulo Henrique Paixão.

Nota

É proibido compartilhar o acesso (usuário e senha) ou os links/URLs dos conteúdos com pessoas que não sejam funcionários da NDD.

  • Colaboradores são usuários com permissões de visualização e criação de conteúdo. Tem acesso a todos os espaços, porém a sua colaboração fica restrita apenas aos espaços relacionados a unidade de negócio em que atua.

  • Administradores são usuários que realizam a administração do Confluence, desde a criação de espaços e sites, revogação ou permissão de acesso de usuários espectadores, ou colaboradores.


Macros

A criação de conteúdo no Confluence é feita por macros. São funcionalidades complementares ao texto, que adicionam mais dinamismo ao layout das páginas.

É possível encontrar e adicionar macros por dois caminhos:

  1. Clique no botão +, na barra de ferramentas e selecione a macro desejada.

    Botão adicionar macrosImage Added
  2. Digite / (barra invertida) no corpo do texto e selecione a macro desejada.

Selecionar macroImage Added

Padrão de macros

O Confluence permite a utilização de uma gama de macros, com diferentes funcionalidades. Apesar disso, é importante que a documentação de todos os produtos seja coerente visual e graficamente. Por isso, esse conteúdo descreve quais macros e em que contexto podem ser utilizadas. Confere:

Macro

Descrição

Como usar

Âncora

A macro Âncora serve para podermos indicar um local específico em um conteúdo.

Digite /Âncora

Colunas

A macro Colunas auxilia na organização de conteúdo, além de possibilitar a criação de layouts para as páginas.

Digite /Colunas

Conteúdo por etiqueta

Essa macro inclui links para as páginas baseado em Etiquetas.

Digite /Conteúdo por etiqueta

Exibir filhos

Use a macro Exibir filhos para inserir uma lista das páginas filhas de uma página e seus descendentes.

Digite /Filhos

Expandir

Essa macro é utilizada para minimizar conteúdos muito extensos ou descrever séries de ações.

Digite /Expandir

Listas

Auxilia na organização de artigos que contém passo a passo ou instruções sequenciais. Temos dois tipos: as ordenadas e não ordenadas.

Digite /Lista

Painéis

Os painéis são valiosos recursos de apoio visual para o texto e servem para destacar algum tipo de informação. Existem cinco tipos de painéis:

Informações

Alerta sobre informações importantes, ações reversíveis e requisitos.

Dica

Apresenta facilitadores de processo ou informações adicionais para maior entendimento de algo.

Nota

Apresenta informações muito importantes ou ações irreversíveis.

Descreve o comportamento do sistema mediante alguma alteração.

Painel
panelIconId1f4a1
panelIcon:bulb:
panelIconText💡
bgColor#F4F5F7

Apresenta exemplos de configurações e/ou arquivos.

Digite /Painel

Incluir página

Você pode usar a macro Incluir página para exibir o conteúdo de uma página em outra.

Digite /Incluir página

Incluir trecho

A macro Incluir trecho é usada para exibir o conteúdo “extraído” (ou seja, um segmento de) de uma página em outra.

Digite /Incluir trecho

Tabelas

As tabelas são importantes aliadas na organização e agrupação de conteúdos.

Digite /Tabela

Índice

Crie um índice baseado nos Títulos presentes na página.

Digite /Índice

Trecho

A macro Trecho é usada para marcar uma parte do conteúdo de uma página para reutilização.

Digite /Trecho