Testar grátis

Documentação Wiki

O Wiki fornece um espaço dedicado para documentação de projeto, partilha de conhecimento e recursos de equipa. Crie páginas para specs técnicos, guias de onboarding, documentação de processos e qualquer informação que a sua equipa precise de referenciar. Páginas organizam-se hierarquicamente com histórico completo de revisões.


O Problema Que Isto Resolve

Documentação espalhada por ferramentas cria caos. Specs técnicos no Google Docs, notas de reunião no Notion, referências de API no Confluence—a sua equipa perde tempo a procurar em vez de construir.

O Wiki centraliza conhecimento do projeto onde o trabalho acontece. Developers documentam junto com o desenvolvimento. Contexto vive com código. Novos membros da equipa encontram respostas sem caçar através de ferramentas externas.


O Que Está a Ver

A interface Wiki usa um layout de três colunas:

Barra Lateral Esquerda: Árvore de navegação mostrando todas as páginas e subpáginas. Campo de pesquisa para encontrar conteúdo. Botão "Criar Página" para nova documentação.

Conteúdo Central: O conteúdo da página selecionada com título e corpo. Modo de edição transforma isto num editor de texto rico.

Barra Lateral Direita: Metadados da página incluindo autor, data de criação, última atualização e acesso ao histórico de revisões. Controlos Editar/Guardar/Cancelar quando tem permissões de edição.


Árvore de Navegação

A barra lateral esquerda mostra todas as páginas wiki em estrutura hierárquica:

Organização de Páginas

Páginas organizam-se numa estrutura em árvore:

  • Páginas raiz: Documentação de topo
  • Subpáginas: Aninhadas sob páginas pai
  • Profundidade: Níveis de aninhamento ilimitados

Clique em qualquer título de página para ver o seu conteúdo no painel central.

Páginas Fixadas

Páginas importantes podem ser fixadas para aparecer no topo da navegação:

  • Documentos frequentemente referenciados
  • Materiais de onboarding
  • Especificações críticas

Páginas fixadas exibem-se numa secção "Fixadas" separada acima da árvore principal.

Pesquisa

O campo de pesquisa filtra páginas por título e conteúdo:

  1. Escreva termos de pesquisa
  2. Árvore filtra para páginas correspondentes
  3. Clique no resultado para navegar
  4. Limpe a pesquisa para mostrar todas as páginas

Para pesquisa mais profunda, use o botão Pesquisar no cabeçalho da página para abrir o modal de pesquisa completa.


Criar Páginas

Nova Página Raiz

  1. Clique no botão "Criar Página" na barra lateral
  2. Introduza o título da página
  3. Opcionalmente adicione conteúdo inicial
  4. Clique Criar

A página aparece na árvore de navegação ao nível raiz.

Nova Subpágina

  1. Passe o rato sobre página existente na árvore
  2. Clique no ícone "+" que aparece
  3. Introduza o título da subpágina
  4. Clique Criar

A subpágina aninha-se sob o seu pai na árvore.

Veja Criar Página Wiki para opções detalhadas de criação.


Editar Páginas

Entrar em Modo de Edição

Com uma página selecionada:

  1. Clique no botão "Editar Página" na barra lateral direita
  2. Conteúdo da página torna-se editável
  3. Título pode ser modificado
  4. Área de conteúdo mostra editor de texto rico

Editor de Texto Rico

O editor suporta:

Formatação de texto:

  • Negrito, itálico, sublinhado
  • Cabeçalhos (H1-H6)
  • Listas ordenadas e não ordenadas
  • Blocos de código

Conteúdo rico:

  • Links para recursos externos
  • Links para outras páginas wiki
  • Imagens (upload ou URL)
  • Tabelas

Estrutura:

  • Divisores horizontais
  • Citações em bloco
  • Listas aninhadas

Guardar Alterações

Após editar:

  1. Clique no botão "Guardar"
  2. Alterações comitam imediatamente
  3. Revisão criada automaticamente
  4. Página regressa ao modo de visualização

Cancelar Edição

Para descartar alterações:

  1. Clique no botão "Cancelar"
  2. Confirme se edições significativas foram feitas
  3. Página regressa ao conteúdo anterior

Informação da Página

A barra lateral direita mostra metadados da página selecionada:

Autor: Quem criou a página com avatar e nome

Criado: Data de criação original

Atualizado: Data da última modificação

Revisões: Contagem de versões guardadas com link para histórico


Histórico de Revisões

Cada gravação cria uma nova revisão, permitindo:

  • Ver versões passadas
  • Comparar alterações entre revisões
  • Restaurar conteúdo anterior
  • Rastrear quem alterou o quê e quando

Ver Revisões

  1. Clique no botão "Histórico de Revisões" na barra lateral direita
  2. Modal mostra todas as revisões
  3. Cada entrada mostra: data, autor, alterações
  4. Clique na revisão para pré-visualizar

Comparar Revisões

  1. Abra o histórico de revisões
  2. Selecione duas revisões
  3. Clique "Comparar"
  4. Vista de diff destaca adições e eliminações

Restaurar Revisões

  1. Encontre a revisão desejada no histórico
  2. Pré-visualize para confirmar versão correta
  3. Clique "Restaurar"
  4. Conteúdo substitui a página atual
  5. Nova revisão criada (restauração rastreada)

Veja Revisões Wiki para gestão detalhada de histórico.


Organizar Documentação

Melhores Práticas de Hierarquia

Categorias de topo:

Wiki/
├── Começar/
│   ├── Onboarding
│   ├── Setup de Desenvolvimento
│   └── Processos de Equipa
├── Docs Técnicos/
│   ├── Arquitetura
│   ├── Referência de API
│   └── Schema de Base de Dados
├── Processos/
│   ├── Code Review
│   ├── Deployment
│   └── Resposta a Incidentes
└── Notas de Reunião/
    ├── Planeamento de Sprint
    └── Retrospetivas

Nomeação de Páginas

Bons nomes:

  • Descritivos e específicos
  • Orientados a ação quando aplicável
  • Estilo consistente através do wiki

Exemplos:

  • "Guia de Autenticação API" (não "Auth")
  • "Deploy para Produção" (não "Deploy")
  • "Roadmap Q4 2024" (não "Roadmap")

Cross-Linking

Ligue entre páginas para criar documentação navegável:

  • Referencie páginas relacionadas inline
  • Crie páginas índice listando subtópicos
  • Ligue de specs para guias de implementação

Pesquisar Wiki

Pesquisa Rápida

A pesquisa na barra lateral filtra páginas visíveis:

  • Escreva para filtrar
  • Corresponde a títulos de páginas
  • Navegação rápida

Pesquisa Completa

Clique no botão Pesquisar no cabeçalho para pesquisa abrangente:

  • Pesquisa conteúdo de páginas
  • Mostra snippets com correspondências
  • Classifica por relevância
  • Filtra por data ou autor

Padrões Comuns de Wiki

Documentação de Onboarding

Páginas a incluir:

  • Boas-vindas e visão geral da equipa
  • Setup de ambiente de desenvolvimento
  • Arquitetura do codebase
  • Processos e convenções de equipa
  • Acesso a ferramentas e contas

Especificações Técnicas

Estrutura:

  • Visão geral e objetivos
  • Requisitos
  • Decisões de design
  • Contratos de API
  • Casos limite
  • Abordagem de testes

Notas de Reunião

Template:

  • Data e participantes
  • Itens de agenda
  • Decisões tomadas
  • Itens de ação com responsáveis
  • Data da próxima reunião

Runbooks

Para operações:

  • Procedimentos passo-a-passo
  • Guias de troubleshooting
  • Caminhos de escalação
  • Informação de contacto

Permissões

Acesso ao wiki segue permissões do projeto:

PapelCapacidades
Agency OwnerAcesso completo: criar, editar, eliminar
ManagerAcesso completo: criar, editar, eliminar
DeveloperCriar e editar próprias páginas, ver todas
ClienteApenas ver se ativado

Eliminação de página pode ser restrita a owners e managers.


Melhores Práticas

Manter Documentação Atual

  • Atualize docs quando código muda
  • Reveja documentação trimestralmente
  • Marque conteúdo desatualizado claramente
  • Atribua responsáveis de documentação

Escreva para o Seu Público

  • Novos membros da equipa precisam de contexto
  • Stakeholders externos precisam de resumos
  • Docs técnicos precisam de precisão
  • Runbooks precisam de clareza sob pressão

Use Templates

Crie páginas template para tipos comuns:

  • Copie template para nova página
  • Preencha especificidades
  • Estrutura consistente ajuda encontrabilidade

Ligue Liberalmente

  • Conecte páginas relacionadas
  • Referencie de descrições de tarefas
  • Crie trilhos de breadcrumb
  • Construa um grafo de conhecimento

Resolução de Problemas

Não consigo criar página:

  • Verifique permissões do projeto
  • Confirme que título da página não está em branco
  • Garanta conexão de rede estável

Modo de edição não aparece:

  • Confirme que tem permissões de edição
  • Verifique se página está bloqueada
  • Tente atualizar a página

Revisões não aparecem:

  • Página precisa de pelo menos uma gravação após criação
  • Verifique botão de histórico de revisões
  • Revisões podem demorar momento a carregar

Pesquisa não encontra conteúdo:

  • Pesquisa pode não indexar imediatamente
  • Tente palavras-chave diferentes
  • Verifique ortografia

Imagens não aparecem:

  • Verifique que URL da imagem é acessível
  • Confirme formato de imagem (PNG, JPG, GIF)
  • Imagens uploaded podem demorar momento a processar

Como Reportar um Problema ou Solicitar uma Funcionalidade

O seu feedback importa. Aqui está como partilhá-lo:

Se o wiki se comporta inesperadamente ou precisa de funcionalidades adicionais, queremos saber.

Na Barra Lateral, clique em Tickets de Suporte e abra um ticket para o problema. Tudo é interativo e rápido através da plataforma GitScrum Studio.

Criar Página Wiki

Crie novas páginas wiki para documentar conhecimento, processos e especificações técnicas. Páginas podem ser documentos de nível raiz ou subpáginas aninhadas, suportando organização hierárquica profunda para necessidades complexas de documentação.


Criar uma Página Raiz

Páginas raiz aparecem no nível superior da sua árvore wiki.

A Partir da Barra Lateral

  1. Clique no botão "Criar Página" no topo da barra lateral
  2. A modal de criação abre
  3. Introduza título da página no campo obrigatório
  4. Opcionalmente adicione conteúdo inicial
  5. Clique Criar

A Partir do Estado Vazio

Quando wiki não tem páginas:

  1. Veja mensagem de estado vazio
  2. Clique "Crie a sua primeira página"
  3. Complete a modal de criação
  4. A sua primeira página está pronta

Criar uma Subpágina

Subpáginas aninham sob páginas existentes, construindo documentação hierárquica.

A Partir da Árvore de Páginas

  1. Passe o rato sobre a página pai na árvore da barra lateral
  2. Um ícone "+" aparece à direita
  3. Clique no ícone "+"
  4. Modal abre com contexto do pai
  5. Introduza título da subpágina
  6. Clique Criar

A nova página aninha sob o pai na árvore de navegação.

Contexto do Pai

Ao criar uma subpágina, a modal mostra:

  • Título da página pai
  • Indicador visual de aninhamento
  • Confirmação de hierarquia

Isto ajuda a confirmar que está a criar na localização correta.


Campos da Modal

Título da Página (Obrigatório)

Propósito: O nome que aparece na navegação e como cabeçalho da página.

Orientações:

  • Descritivo e específico
  • 3-100 caracteres
  • Evite caracteres especiais que possam causar problemas de URL
  • Use convenções de nomenclatura consistentes

Bons exemplos:

  • "Guia de Autenticação API"
  • "Deploy para Produção"
  • "Notas de Retrospetiva Sprint 23"

Evite:

  • Palavras únicas como "Notas" (muito genérico)
  • Títulos muito longos (truncam na navegação)
  • Duplicar nomes de páginas existentes

Conteúdo Inicial (Opcional)

Propósito: Começar a página com conteúdo ao invés de em branco.

Formato: Texto simples ou formatação estilo Markdown.

Casos de uso:

  • Colar conteúdo existente
  • Começar de template
  • Notas rápidas para expandir depois

Se deixado em branco, página cria vazia—pode adicionar conteúdo em modo de edição após criação.


Após Criação

Após clicar Criar:

  1. Modal fecha
  2. Nova página aparece na árvore
  3. Conteúdo da página carrega no centro
  4. Pode imediatamente começar a editar

Vista de Página Vazia

Novas páginas sem conteúdo inicial mostram:

  • Título da página como cabeçalho
  • Área de conteúdo vazia
  • Botão editar para adicionar conteúdo

Modo de Edição

Para adicionar conteúdo após criação:

  1. Clique "Editar Página" na barra lateral direita
  2. Página entra em modo de edição
  3. Adicione o seu conteúdo
  4. Clique Guardar

Organização de Páginas

Escolher Localização

Antes de criar, decida hierarquia:

Página raiz quando:

  • Categoria principal de documentação
  • Referência standalone
  • Página índice ou hub

Subpágina quando:

  • Relacionada com página existente
  • Parte de tópico maior
  • Expansão detalhada do pai

Reestruturar Depois

Páginas podem ser movidas após criação:

  • Arrastar e largar na árvore (se ativado)
  • Editar página para mudar pai
  • Criar nova página e copiar conteúdo

Considerações de Profundidade

Embora aninhamento ilimitado seja suportado:

  • 2-3 níveis é tipicamente suficiente
  • Aninhamento profundo dificulta navegação
  • Use links cruzados ao invés de árvores profundas

Templates

Criar Páginas Template

Configure templates reutilizáveis:

  1. Crie página chamada "[Template] Notas de Reunião"
  2. Adicione estrutura com placeholders
  3. Quando necessário, copie conteúdo do template para nova página

Sugestões de Template

Notas de Reunião:

## Data: [DATA]
## Participantes: 
- 

## Agenda
1. 

## Discussão

## Decisões Tomadas

## Itens de Ação
- [ ] 

## Próxima Reunião:

Especificação Técnica:

## Visão Geral

## Declaração do Problema

## Solução Proposta

## Design Técnico

## Alterações de API

## Alterações de Base de Dados

## Estratégia de Testes

## Plano de Rollout

Runbook:

## Propósito

## Pré-requisitos

## Passos
1. 
2. 
3. 

## Verificação

## Rollback

## Escalação

Melhores Práticas

Nomear Consistentemente

Estabeleça convenções de equipa:

  • "Como..." para guias
  • "[Componente] Arquitetura" para docs técnicos
  • "AAAA-MM-DD Reunião" para notas

Começar com Estrutura

Mesmo com conteúdo inicial vazio:

  • Planeie os seus cabeçalhos
  • Saiba que secções são necessárias
  • Crie outline primeiro

Linkar na Criação

Após criar:

  • Link de páginas relacionadas
  • Adicione a páginas índice
  • Referencie em tarefas relevantes

Definir Propriedade

Cada página deve ter um dono:

  • Responsável por atualizações
  • Responde perguntas
  • Revê periodicamente

Permissões

Criação de página requer permissões apropriadas:

PapelPode Criar Páginas
Agency Owner
Manager
Developer
Client✗ (tipicamente)

Configurações de projeto podem restringir ainda mais a criação.


Resolução de Problemas

Botão criar desativado:

  • Campo título pode estar vazio
  • Verifique campos obrigatórios
  • Verifique permissões

Página não aparece na árvore:

  • Árvore pode precisar de atualização
  • Verifique erros de criação
  • Tente navegar para longe e voltar

Não consegue criar subpágina:

  • Página pai deve ser válida
  • Verifique permissões
  • Garanta que pai não está arquivado

Erro título já existe:

  • Nomes de página devem ser únicos dentro do projeto
  • Adicione especificidade ao título
  • Verifique página similar existente

Atalhos de Teclado

AçãoAtalho
Submeter formulárioCmd/Ctrl + Enter
Fechar modalEscape
Focar títuloAuto-focado ao abrir

Histórico de Revisões Wiki

Cada página wiki mantém histórico de versões completo. Cada guardar cria uma revisão, permitindo visualizar versões passadas, comparar alterações, entender quem modificou o quê e restaurar conteúdo anterior se necessário.


Entender Revisões

O Que É uma Revisão

Uma revisão é um snapshot guardado de uma página num momento específico:

  • Conteúdo: Texto completo da página no momento de guardar
  • Título: Título da página (se alterado)
  • Autor: Quem fez a alteração
  • Timestamp: Quando foi guardado
  • Número de revisão: Identificador sequencial

Quando Revisões São Criadas

Nova revisão criada quando:

  • Página criada pela primeira vez (revisão 1)
  • Modo de edição guardado com alterações
  • Restauração de versão mais antiga
  • Operações de importação ou atualização em massa

Retenção de Revisões

Todas revisões são preservadas indefinidamente:

  • Sem pruning automático
  • Trilho de auditoria completo
  • Armazenamento otimizado para texto

Aceder ao Histórico de Revisões

A Partir da Vista de Página

  1. Selecione uma página wiki
  2. Olhe para barra lateral direita
  3. Encontre botão "Histórico de Revisões"
  4. Mostra contagem de revisões (ex: "Histórico de Revisões (12)")
  5. Clique para abrir modal

A modal exibe:

  • Lista de todas revisões
  • Mais recente primeiro (ordem descendente)
  • Cada entrada mostra: data, autor, resumo
  • Navegação para listas longas

Lista de Revisões

Informação de Entrada

Cada revisão mostra:

CampoDescrição
Revisão #Número sequencial
DataQuando guardado (relativo ou absoluto)
AutorQuem fez a alteração
PreviewSnippet ou resumo de alteração

Identificar Alterações

Revisões podem indicar:

  • "Página criada" para primeira revisão
  • "Conteúdo atualizado" para edições
  • "Título alterado" se título modificado
  • "Restaurado da revisão X" para restaurações

Visualizar uma Revisão

Preview de Conteúdo

  1. Clique em qualquer revisão na lista
  2. Painel de preview mostra conteúdo
  3. Vista apenas leitura dessa versão
  4. Conteúdo completo da página exibido

Comparar com Atual

Preview indica claramente:

  • Este é conteúdo histórico
  • Versão atual pode diferir
  • Opção de restaurar disponível

Comparar Revisões

Abrir Vista Diff

  1. Na modal de revisões, selecione primeira revisão
  2. Mantenha Ctrl/Cmd e selecione segunda revisão
  3. Clique botão "Comparar"
  4. Modal de diff abre

Entender Diffs

A comparação mostra:

Conteúdo adicionado: Destacado em verde Conteúdo removido: Destacado em vermelho Inalterado: Exibição normal

Vista Linha a Linha

Diff exibe alterações contextualmente:

  • Linhas adicionadas marcadas com +
  • Linhas removidas marcadas com -
  • Contexto envolvente para clareza

Diffs ao Nível de Caractere

Dentro de linhas alteradas:

  • Alterações específicas de palavras destacadas
  • Rastreamento de modificação refinado
  • Mais fácil identificar edições pequenas

Restaurar Revisões

Quando Restaurar

Restauração útil quando:

  • Eliminação acidental de conteúdo
  • Versão anterior era melhor
  • Desfazer alterações de outra pessoa
  • Recuperar de erros

Processo de Restauração

  1. Abra histórico de revisões
  2. Selecione revisão desejada
  3. Preview para confirmar versão correta
  4. Clique botão "Restaurar"
  5. Confirme restauração

Após Restauração

  • Conteúdo da página substituído por versão antiga
  • Nova revisão criada (restauração rastreada)
  • Versões originais preservadas
  • Autor da restauração registado

Restauração É Reversível

Restauração cria uma nova revisão, então:

  • Pode restaurar novamente
  • Nada permanentemente perdido
  • Trilho de auditoria completo mantido

Auditar Alterações

Quem Alterou O Quê

Histórico de revisões responde:

  • Quem editou esta página por último?
  • Quando conteúdo específico apareceu?
  • Como era antes?
  • Como evoluiu?

Uso de Conformidade

Para ambientes regulados:

  • Histórico completo de alterações
  • Responsabilização de autores
  • Verificação de timestamp
  • Histórico não eliminado

Responsabilização de Equipa

Revisões ajudam com:

  • Treinar novos editores
  • Rever contribuições
  • Entender evolução da documentação
  • Resolver edições conflituantes

Melhores Práticas

Guardados Significativos

Não guarde alterações vazias ou triviais:

  • Complete unidades lógicas de trabalho
  • Evite commits "corrigir typo"
  • Agrupe alterações relacionadas

Checkpoints Regulares

Para sessões de edição longas:

  • Guarde periodicamente
  • Cada guardar é um ponto de recuperação
  • Melhor ter revisões extra

Rever Antes de Restaurar

Antes de restaurar conteúdo antigo:

  • Preview a revisão
  • Verifique o que pode ser perdido
  • Considere copy-paste ao invés
  • Documente porquê restaurar

Limpar Através de Edição

Ao invés de restaurar versões antigas:

  • Edite versão atual para corrigir
  • Mantenha melhorias acumuladas
  • Rollback seletivo quando necessário

Limitações

Sem Restauro Parcial

Restauração substitui página inteira:

  • Não consegue restaurar único parágrafo
  • Copy-paste para recuperação parcial
  • Merge manual se necessário

Não Eliminar Revisões

Revisões individuais não podem ser eliminadas:

  • Histórico completo preservado
  • Por design para propósitos de auditoria
  • Contacte suporte para edge cases

Revisões Grandes

Páginas muito grandes podem:

  • Demorar mais para diff
  • Ter previews truncados
  • Ainda funcionar corretamente

Cenários Comuns

Eliminação Acidental de Conteúdo

  1. Note que conteúdo está em falta
  2. Abra histórico de revisões
  3. Encontre última revisão com conteúdo
  4. Preview para confirmar
  5. Restaure ou copy-paste

Edição Indesejada por Membro de Equipa

  1. Veja alteração com que discorda
  2. Abra histórico de revisões
  3. Encontre revisão pré-alteração
  4. Discuta com equipa primeiro
  5. Restaure se acordado

Entender Evolução

  1. Novo no documento
  2. Abra histórico de revisões
  3. Navegue pelas versões
  4. Entenda como decisões evoluíram
  5. Obtenha contexto para estado atual

Resolução de Conflito de Merge

Quando duas pessoas editaram:

  1. Veja conteúdo inesperado
  2. Compare revisões recentes
  3. Identifique ambas contribuições
  4. Faça merge manual do melhor de ambos
  5. Guarde versão combinada

Resolução de Problemas

Sem revisões a mostrar:

  • Página nova tem apenas uma revisão
  • Verifique permissões para ver histórico
  • Tente atualizar modal

Diff não funciona:

  • Selecione exatamente duas revisões
  • Verifique compatibilidade do browser
  • Páginas muito grandes podem dar timeout

Restauro falha:

  • Verifique permissões de edição
  • Verifique se página não está bloqueada
  • Problemas de rede podem interromper

Revisão antiga parece errada:

  • Formato muda ao longo do tempo
  • Conteúdo está preciso
  • Renderização pode diferir

Permissões

Acesso a revisões segue permissões de página:

PapelVer HistóricoRestaurar
Agency Owner
Manager
Developer✓ (páginas próprias)
Client✓ (se vista ativada)

Alguns ambientes podem restringir acesso ao histórico.