Configurar DNSSEC cPanel - New
Configurações de template:
Título: Deve descrever de forma clara o objetivo do artigo.
Estrutura do artigo visível: Pré-requisitos, Instrução de trabalho (Passos) e Conclusão.
Inserir bloco colapsável com o título Informações de controle de versão.
Estrutura do bloco colapsável: Assunto, Introdução, Palavras-Chave, Segurança da Informação e Dados da revisão.
Formatação:
Subtítulos: Fonte Cabeçalho pequeno, alinhamento esquerdo.
Texto: Fonte Paragrafo, alinhamento esquerdo.
Do conteúdo do artigo:
O Autor deve priorizar sempre o uso de conteúdo do tipo texto.
Inserir linha horizontal quando da separação de sessões para melhor visualização do leitor.
Recomenda-se que todo o texto seja alinhado de forma justificada:
Para tanto, o usuário deve selecionar o texto a ser formatado e em seguida utilizar a caixa de ferramentas de formatação de textos e escolher a seguintes opção:
Justificar
Com isso, todo o texto ficará justificado.
Expondo código sem misturar com o contexto da aplicação:
Outra recomendação é distinguir contexto do POP de códigos a serem digitados pelo Leitor.
Para uso de códigos, recomenda-se o uso de balões como o que se segue:
"Inserir código fonte" ou "Insert code block"
EXEMPLIFICAÇÃO DO LAYOUT
Pré-requisitos
Para execução deste processo, o usuário deve:
Possuir permissão de criação de artigo na Base de Conhecimento do Sistema.
Instrução de Trabalho
A seguir são apresentados os passos necessários para execução desta instrução de trabalho:
Passo 1
Texto de exemplo.
Passo 2
Texto de Exemplo.
Passo 3
Texto de Exemplo
Passo 4
Texto de exemplo...
Conclusão:
Com a aplicação deste layout nossas postagens serão padronizadas de forma a melhor utilização e visibilidade dos colaboradores e clientes GK2.
Informações de controle de versão
Assunto
POP-IT-SUP002 - Template para publicações na base de conhecimento GK2.Cloud
Introdução
Este POP (Procedimento Operacional Padrão) tem como objetivo instruir os usuários quanto à correta forma de criar POPs do tipo IT (Instrução de Trabalho) na base de conhecimento da GK2 Cloud.
Palavras-Chave
< Template | IDT | Modelo | POP | Instrução de Trabalho | Layout >
Segurança da Informação
Este documento é de restrita divulgação para qualquer pessoa ou Corporação, mesmo que integrantes da GK2 Cloud.
Dados da Revisão:
Data: 02/09/2024 | Rev.: 2.0 | Criado por: Eder Cesar | Aprovado por: | Visibilidade: Interno |
Descrição das sessões incluídas no bloco colapsável:
Sessão "Assunto: "
A sessão "Palavras Chave" existe com a finalidade de facilitar e garantir que, termos específicos do artigo, façam com que este apareça nas pesquisas realizadas pelos usuários da Base de Conhecimento.
Sessão "Introdução"
A sessão Introdução deve ser escrita com texto curto, claro e objetivo, de forma que, com uma simples leitura das primeiras frases que aparecerão na ferramenta de pesquisa, seja possível ao usuário uma avaliação se o procedimento em questão será ou não útil para atender a demanda necessária.
Sessão "Palavras-Chave"
A sessão "Palavras-Chave" existe com a finalidade de facilitar e garantir que, termos específicos do artigo, façam com que este apareça nas pesquisas realizadas pelos usuários da Base de Conhecimento.
Devem ser utilizados um conjunto de no Configurações de template: máximo 5 palavras-chave ou expressões que levem o usuário diretamente ao assunto. As palavras ou expressões utilizadas devem ser chaves para o objetivo que se propõe.
O parágrafo contendo as TAGs deve sempre ser iniciado pelo caractere "menor que" (<) adicionado de um espaço em branco e finalizado com outro espaço em branco e "maior que" (>). Trata-se de uma técnica para facilitar que usuários, no ato da pesquisa, possam visualizar facilmente as TAGs na exposição dos resultados.
Deve-se ainda, utilizar espaço em branco, pipe (|), e espaço em branco para separar as palavras-chave umas das outras, proporcionando uma melhor leitura para o usuário.
Sessão "Segurança da Informação"
A sessão Segurança da Informação objetiva apresentar de forma clara e objetiva qual o nível de segurança esperado para a documentação em questão.
Entende-se com isso que ele possa ser apenas uma lista de boas práticas onde é definido o que não pode ser feito com o conteúdo deste material e sua aplicação.
Sessão "Dados da revisão"
A sessão consiste em uma tabela de 1x5 com os seguintes campos:
Data: Data da criação/alteração | Rev.: Número da revisão iniciando-se em 1.0 e sendo versionado alterando o número após o ponto. | Criado por: Nome do criador inicial do artigo. | Revisado por: Nome do revisor do criador/editor do artigo | Visibilidade: Informa se o documento deve ser mantido em acesso público ou interno.
Descrição das sessões visíveis (Que não estão no bloco colapsável):
Sessão "Pré-requisitos"
A sessão Pré-Requisitos tem a finalidade de apresentar ao Leitor os requisitos necessários para a realização da instrução de trabalho. Requisitos estes que, caso não garantidos, colocam em risco o sucesso na execução da Instrução de Trabalho, não podendo prever os riscos e seus impactos no ambiente.
Sessão "Introdução"
A sessão Introdução deve ser escrita com texto curto, claro e objetivo, de forma que, com uma simples leitura das primeiras frases que aparecerão na ferramenta de pesquisa, seja possível ao usuário uma avaliação se o procedimento em questão será ou não útil para atender a demanda necessária.
Sessão "Conclusão"
Deve citar o resultado esperado após a aplicação do artigo.