Manuais
PHC GO Como criar manuais de utilização para os seus add-ons
 
Para facilitar a criação de manuais de utilização para os seus add-ons, está disponível na Toolbox do PHC GO a peça Manuais.

Através desta peça, é possível criar manuais e associa-los ao seu add-on, manuais estes que serão publicados no PHC GO HelpCenter, de modo a que a documentação do seu addon esteja facilmente acessível.

Para conhecer todas as funcionalidades inerentes a este ecrã, iremos começar por explicar os campos que compõem a área da Informação Principal e o tabulador dos Dados Gerais.
Tópicos Relacionados

Para mais informações relacionadas com add-ons do PHC GO, estão disponíveis os seguintes manuais:


 

INFORMAÇÃO PRINCIPAL

Esta área do ecrã é composta pelos seguintes campos:

  • Nome do Manual: Título do manual do seu add-on.

  • Identificador do Manual: Identificador único do manual, a ser preenchido automaticamente aquando da introdução/duplicação de um manual.

  • Tipo de Manual: Através deste campo, é possível definir a natureza do manual, sendo passível de seleção, umas das seguintes opções:

    1. Simples: Tipo de manual utilizado para documentação genérica do add-on.

    2. Step by Step: Tipo de manual utilizado para a documentação/demonstração de um circuito completo do addon, desde a sua primeira configuração à sua primeira utilização. Ao utilizar este tipo de tópico, por cada entrada na tabela do separador Tópicos, será introduzido um novo capítulo (enumerado) no seu manual, ao que este deve representar uma etapa/passo no circuito documentado.

    3. de Ecrã Tipo de manual utilizado para documentar ao detalhe todos os campos e separadores do ecrã do seu add-on. Ao utilizar este tipo de tópico, por cada entrada na tabela do separador Tópicos, será introduzido um novo separador colapsável no seu manual, utilizando o mesmo estilo utilizado pelos separadores do PHC GO.


DADOS GERAIS


Detalhes

Abrir/Fechar

Introdução:

  1. Para tópicos do tipo Simples: Como este tipo de manual não suporta Tópicos, este campo deve ser utilizado para a documentar o respetivo manual.

  2. Para tópicos do tipo de Ecrã/Step by Step: Este campo serve para introduzir um texto introdutório ao manual, surgindo antes dos separadores do ecrã (caso o manual seja do tipo de Ecrã) ou imediatamente antes do circuito documentado (caso o manual seja do tipo Step by Step) .



Tópicos

Abrir/Fechar

Por omissão, aquando da criação de um novo manual, não existem tópicos associados a este. Para adicionar um novo tópico, basta carregar   
Adicione tópico
  .

Após esta ação, será introduzido um novo registo na tabela de tópicos, utilizado para complementar o seu manual, de acordo com o tipo de manual selecionado:

  1. Para tópicos do tipo Step by Step: Por cada entrada na tabela, será introduzido um novo capítulo (enumerado) no seu manual, ao que este deve representar uma etapa/passo no circuito documentado.

  2. Para tópicos do tipo de Ecrã: Por cada entrada na tabela, será introduzido um novo separador colapsável no seu manual, utilizando o mesmo estilo utilizado pelos separadores do PHC GO.
    3. Dicas

    Para remover um tópico de seu manual, carregue no botão  delete  , respetivo à entrada da tabela (tópico) a remover.

    Para adicionar uma novo tópico, basta carregar em  add  .

 

PHC GO