Quando um documento é criado, a versão Working version é adicionada por padrão.
A Working version não deve ser publicada no Help Center.
Para que o documento seja publicado no Help Center, necessitamos criar a versão Current. A chamamos assim, pois é a nossa versão corrente, com as últimas alterações realizadas no produto. Ela também será nossa base para criar o histórico de versões.
Neste artigo
Passo 1 - Criar a versão Current
Acesse o espaço no Confluence
Na barra lateral esquerda, clique em Scroll Documents
Localize o documento recém criado clique nele
Clique no botão Save a version no canto superior direito
Na aba Basic, insira as seguintes informações:
Version: digite Current
Description: deixe em branco
Status: selecione IN PROGRESS
Restrictions: selecione No restrictions
Na aba Advanced, insira as seguintes informações:
Based on version: selecione a Working version e o idioma Portuguese
Prefix: não altere o prefixo
Content: marque a opção Resolve include page macros para que a nova versão herde as macros das páginas da versão anterior
Clique no botão Save
Se a documentação do seu produto for disponibilizada apenas em português, não realize o Passo 2 - Adicionar os idiomas à versão.
Entretanto, se for disponibilizada em mais idiomas, é necessária a realização do Passo 2 - Adicionar os idiomas à versão.
Passo 2 - Adicionar os idiomas à versão
Na versão Current do documento, clique em Add translation
Clique em Manual Translation
Clique no botão Next
Na aba Basic, insira as seguintes informações:
Language: selecione o idioma que deseja adicionar. Se o idioma não estiver na lista, é necessário adicioná-lo
Restrictions: selecione No restrictions
Na aba Advanced, não realize nenhuma alteração
Clique no botão Save
Repita os passos até adicionar todos os idiomas desejados.
Ao adicionar os idiomas à versão, elas serão criadas com a mesma estrutura de páginas e conteúdo da versão em Português. Em razão disso, é necessário editar as páginas para incluir o conteúdo traduzido.
Em todas as páginas que ainda não foram traduzidas conterá o seguinte aviso:
Assim, após realizar a edição para incluir o conteúdo traduzido à página:
Substitua a etiqueta needs-translating para translated
Remova o aviso
Não realize a atualização do Help Center antes de inserir a tradução de todas as páginas.
Passo 3 - Arquive a versão Working version
Conforme ressaltado anteriormente, a versão Working version é criada por padrão pelo Confluence. Após a criação da versão Current, podemos arquivá-la, considerando que ela não será mais utilizada.
Na versão Working version do documento, clique no link Portuguese para abrir a árvore de páginas da versão
Arquive todas as páginas que se referem à versão Working version
Passo 4 - Organize a versão Current
Organize a árvore de páginas da versão Current para que ela seja facilmente localizada.
A organização pode ser realizada conforme suas preferências, mas recomendamos que seja realizada da seguinte forma:
Crie uma página que referencie o documento
No espaço, no campo CONTEÚDO, clique no botão ➕
Clique em Página
Escreva um título para a página que referencie o conteúdo do documento, como por exemplo: Visão geral, Usando o PRODUTO, Release notes…
Clique no botão Publicar…
Na barra lateral esquerda, clique em Scroll Documents
Localize o documento recém criado clique nele
Na versão Current do documento, clique no link Portuguese para abrir a árvore de páginas da versão
Arraste a página Version of NOME DO DOCUMENTO para a página criada no primeiro passo
Pronto! Seu conteúdo está organizado de forma que fique fácil de localizá-lo.
Exemplo de organização do NDD Orbix:
Passo 5 - Crie o conteúdo de suas páginas
O próximo passo é a publicação do documento no Help Center.
Assim, certifique-se de que todas as páginas do documento (em português e nos demais idiomas, se houver) estão com o conteúdo correto.