Iniciar uma conversa

Criando uma Documentação Utilizando HelpCase

HelpCase

É um gerador de documentação web totalmente integrado com os projetos desenvolvidos no ScriptCase. Com o HelpCase a documentação do seu sistema se torna uma tarefa muito mais fácil e não será preciso utilizar uma outra ferramenta, sendo desta forma mais uma facilidade implementada.

 

HelpCase - Criando um Manual

Um Manual construido no HelpCase está sempre associado a um Projeto do ScriptCase. Na interface de criar (ver figura1) um novo Manual não é exibido uma opção para escolha do Projeto, pois o Projeto já está implicitamente selecionado sendo ele o projeto em que o ScriptCase esteja acessando no momento.

Figura1: Criando um Novo Manual

 

Iniciando um Projeto

 

HelpCase - Editando um Projeto

 

Barra de Botões Superior:

Está barra é responsável pela manutenção das pastas e arquivos contidos no diretorio selecionado. Inicialmente o Projeto contém um único diretório chamado root ( ). Os diretório que forem criados serão exibidos no menu treeview.

Criando um Novo diretório

Cria um novo diretório no manual no diretório selecionado.

Diretório criado na Raiz do Root.

 

 Criando um Novo Arquivo HTML

Arquivo Html criado na Raiz do Diretório (form_cadastro).

 

* - Realizando Upload de Imagens e Documentos.

 

Selecionando a Barra de Ferramentas a opção - Upload

 

Formulário de Upload de Imagens.

 

Imagem arquivada no mesmo diretório de (_images).

Para realizar includes de arquivos, temos uma opção na barra de Ferramentas do Editor, onde realiza a chamada da inclusão onde estará disponível o arquivo incluído.

Só é necessário informar o nome do arquivo que foi realizado o upload dentro do diretório (_commons).

Veja na Imagem Abaixo:

 


Editanto o Arquivo Html.

 

Editanto o Arquivo Html utilizando o Editor, com as opções na Barra de Ferramentas.

* - A Imagem selecionada abre uma janela para a Inserção de uma Imagem. Informando o endereço da Imagem (sempre a partir da pasta de seu manual HelpCase). Neste exemplo é apartir da pasta (_images) sendo observada na Imagem abaixo.

 

Arquivo Html com as Configurações de Texto e Imagem Definidas. (Depois Salve clicando no Botão Salvar).

 

Selecionando a Opção de Páginal Inicial do Manual.

 

 

Páginal Inicial do Manual. (Depois Salve clicando no Botão Salvar).

 

Gerando o Manual.

Selecinando o Link da Barra de Ferramentas (Gerar WebHelp)

 

Manual Gerado.

1 - Arquivo Html do Manual.

2 - O arquivo zipado contendo imagens e arquivos do Manual.

 

Manual Gerado.

 

Item do Link do Manual.

Escolher arquivos ou arraste e solte arquivos
Esse artigo foi útil?
Sim
Não
  1. Amanda Santos (Migrated deleted Agent)

  2. Publicado
  3. Atualizado

Comentários