Ferramentas de Apoio para Documentação do Produto Sistema de Gestão da Qualidade

Transcrição

1 Página 1 de 48 Sumário 1. DOCUMENTAR APRESENTAÇÃO GERAL DA FERRAMENTA HELP & MANUAL CONFIGURAÇÕES ESSENCIAIS DO DOCUMENTO INSERIR ÂNCORAS NO DOCUMENTO INSERIR TOGGLE E LINK NO DOCUMENTO CORREÇÃO ORTOGRÁFICA CONFIGURAÇÕES DE BUSCA E IDENTIFICAÇÃO DO DOCUMENTO ADICIONAR DOCUMENTO UNIFICAR BOLETIM DE EVOLUÇÃO COMPILAR DOCUMENTO COMPILAR DOCUMENTO PDF EXCLUINDO PÁGINAS DESNECESSÁRIAS PESQUISAR DOCUMENTO NO SVN EDITAR IMAGEM NO PHOTOSCAPE INSTALAR O PHOTOSCAPE TELA INICIAL DO APLICATIVO EDITANDO IMAGENS INSERINDO NOME OU MARCAÇÃO NA IMAGEM RECORTANDO IMAGENS UTILIZAR OCAM INSTALANDO OCAM CONFIGURANDO OCAM GRAVANDO VIDEO TUTORIAL...39

2 Página 2 de DOCUMENTAR 1.1. APRESENTAÇÃO GERAL DA FERRAMENTA HELP & MANUAL O Help&Manual v.5.0 será utilizado para documentar o produto e consolidá-lo. Nele devem ser utilizados todos os recursos necessários para que o usuário possa se orientar pelo aplicativo de forma intuitiva e prática. É indispensável usar os recursos como texto justificado, corretor ortográfico, compartilhamento de ferramenta (vários usuários utilizando o mesmo projeto ao mesmo tempo e/ou vários projetos abertos ao mesmo tempo), facilitando assim a agilidade durante a documentação de quem utiliza essa ferramenta.

3 Página 3 de CONFIGURAÇÕES ESSENCIAIS DO DOCUMENTO A formatação de fontes, tabelas, hyperlinks, imagens, entre outros recursos, pode ser feita através da aba Write, conforme imagem abaixo: Para facilitar a formatação do texto na tela, pode-se configurar seus estilos, clicando em Styles:

4 Página 4 de INSERIR ÂNCORAS NO DOCUMENTO 1) Para inserir uma Âncora (Anchor), selecione no texto a palavra que será a âncora e clique com o botão direito do mouse em Insert e, em seguida, em Anchor:

5 Página 5 de ) Ou então, clique no botão apresentado abaixo, na aba Write: 2) Na tela Insert Anchor preencha a identificação da âncora em Anchor ID e clique em Ok. 3) E, em seguida, será exibido o seguinte ícone antes da palavra:

6 Página 6 de 48 4) Para inserir um Link, copie a âncora efetuando duplo clique sobre a palavra ou clicando com o botão direito do mouse em Edit Anchor. Copie a palavra que aparecerá em Anchor ID e clique no botão OK: 5) Em seguida, selecione, no texto, a palavra que será inserida o link e clique com o botão direito do mouse em Insert e, em seguida, em Link: 5.1) Ou então, clique no botão Link, localizado na caixa Insert, da aba Write. 6) Na tela abaixo é necessário informar:

7 Página 7 de 48 Colar ou digitar o ID da âncora. Selecionar o título onde localiza-se a âncora INSERIR TOGGLE E LINK NO DOCUMENTO O conteúdo do texto pode ser mostrado ou escondido utilizando o toggle. Ele deve ser utilizado para ocultar informações de forma que sua visualização se torne opcional ao usuário. Para inserir um toggle com sinal de +, sem necessidade de link, siga os procedimentos abaixo:

8 Página 8 de 48 1) Selecione o título que deseja incluir o toggle e clique com o botão direito do mouse; 2) Escolha a opção Insert e em seguida + Toggle; 3) Na tela para Editar Toggle, verifique o nome do Capítulo, selecione o Icone Plus/Minus Symbol e escolha a posição da tabela onde o toggle será apresentado. Clique em OK. 4) Aparecerá a linha tracejada para inserir o conteúdo desejado, conforme imagem abaixo:

9 Página 9 de 48 5) Insira o conteúdo desejado. Se este for um link, refaça o procedimento de toggle, utilizando link da seguinte forma: 5.1) Verifique o nome do Capítulo e selecione a opção Link style (blue underlined); 5.2) Marque a opção Toggle a Table e selecione Toggle the table below this link. Clique em OK. 5.3) O link aparecerá no Capítulo desejado, conforme imagem abaixo. Insira o conteúdo desejado no espaço reservado (tracejado) para o conteúdo:

10 Página 10 de 48 Se o conteúdo a ser inserido no toggle se referir a rotinas e/ou mais detalhes relevantes sobre a alteração, que devam ser considerados, faça um link sobre a palavra principal ou frase principal, conforme exemplo abaixo: Palavra-chave Clicando na palavra-chave......aparecerá o conteúdo. Para inserir um link Topo da página, com o objetivo de redirecionar o leitor ao início da página durante o desenvolvimento da leitura e otimizar a busca de novos títulos, siga os procedimentos abaixo:

11 1) Insira uma âncora no início da página (no primeiro título da página), como no exemplo: Página 11 de 48 2) Ao final da descrição de cada título, digitar o texto Topo da página e inserir nele um link direcionado para a âncora criada:

12 Página 12 de CORREÇÃO ORTOGRÁFICA A correção ortográfica e a captura de telas podem ser feitas na aba Project, caixa Tools, através das ferramentas Spelling e Screen Capture.

13 Página 13 de 48 IMPORTANTÍSSIMO: Spelling: realizar a correção ortográfica e selecionar a língua padrão. Para selecionar a opção Português, clique no botão e selecione a opção Configure Spell Checker. Será aberta a tela Spelling Options : selecione a aba Dictionaries e marque a opção conforme apresentado abaixo: Para Adicionar tópicos no índice (árvore) bem como alterar a ordem, destacá-los com cores conforme andamento das atividades, editar o título selecionado, localizar um tópico, alterar o ícone etc, acesse a caixa Manage Topics;

14 Página 14 de 48 1) Ao clicar neste botão na barra ou diretamente na árvore com o botão direito do mouse, será possível adicionar um tópico (antes, depois ou filho do tópico selecionado) conforme apresentado abaixo: Adicionar antes do tópico Adicionar depois do tópico Adicionar tópico filho Deletar tópico 2) Na árvore, ao clicar com o botão direito do mouse sobre o tópico:

15 Página 15 de 48 3) No botão Change, as cores indicam o andamento do projeto, para controle interno:

16 Página 16 de 48 Precisa de revisão Fora da data Em construção As cores não serão apresentadas no arquivo compilado. 4.1) Ainda no botão Change, será possível alterar os ícones da árvore (usar conforme padrão estabelecido):

17 Página 17 de 48 4) No campo das setas, alterar a ordem dos tópicos da árvore ou transformar um tópico filho de outro, se necessário CONFIGURAÇÕES DE BUSCA E IDENTIFICAÇÃO DO DOCUMENTO 1) Informe o nome que deve aparecer no cabeçalho do aplicativo, conforme configuração abaixo: 1.1) Na Ajuda, insira em Configuration > Common Properties > Help Windows o <Cód. Rotina Descrição da rotina v. <Nº versão>.

18 Página 18 de ) No Boletim de Evolução, insira em Configuration > Common Properties > Help Windows o Boletim de Evolução v. <Nº da versão do produto>. Também informar o número da versão em O que há de novo na versão 2) Insira os Direitos Autorais ao final de cada página, selecionando Configuration e em seguida Default. Em HTML Source Code, localize a variável <%TOPIC_TEXT%> e escreva o texto de direitos autorais logo abaixo desta variável. Não clique em Simple Template Layout, isso deletará a informação

19 incluída em HTML Source Code. Página 19 de 48 2) Em Language Settings, insira o código do arquivo para ser buscado pela rotina e menu de acordo com cada tipo de documento: Boletim de Evolução: PCBOLETIM.chm (É através deste código que o Menu buscará o arquivo para visualização do usuário. Este código não deve ser apresentado ao cliente.); Ajuda: PCSIS<Cód.Módulo00>.chm. (É através deste código que a rotina buscará o arquivo para visualização do usuário.)

20 Página 20 de 48 3) Para a Ajuda, é indispensável que o código da rotina seja configurado em Windows has a navigation painel e em User defined buttons para que ao clicar na rotina em F1 ou em seu ícone (?) ela seja buscada automaticamente. O código do módulo deve ser seguido do 00. Ex.: 200 4) As palavras-chave devem ser informadas no Topic Options no tópico de início da árvore;

21 Página 21 de 48 5) Para a Ajuda de cada rotina também deve informar o código da rotina no Help Context Number:

22 Página 22 de 48 6) Para buscar o aplicativo na extensão.chm ou em qualquer outro tipo de extensão disponível na ferramenta Help&Manual, clique com o botão direito do mouse sobre o código da rotina e sua descrição e selecione Include in Builds e em seguida All Builds: Também será possível realizar este mesmo passo no botão Change, conforme imagem abaixo:

23 Página 23 de 48 Outros recursos, como Bookmark (marcador), também poderão ser utilizados de acordo com a necessidade de cada usuário desta ferramenta. O marcador não será apresentado no arquivo compilado, ou seja, é utilizado somente para controle interno, tem o mesmo objetivo das cores. 2. ADICIONAR DOCUMENTO 1) Ao incluir o documento em sua respectiva pasta, clique com o botão direito do mouse sobre ele e adicione-o (Add). Em seguida, ao fazer o Commit, insira no campo Message, o nome do assunto e sua(s) respectiva(s) rotina(s) (código das rotina(s) envolvida(s)) para os tipos de documentos abaixo: Tutorial;

24 Ajuda. Página 24 de 48 2) Clique em OK para concluir. Em seguida, realize o Commit na pasta geral, onde a subpasta do documento está inserida para finalizar o Commit. Aguarde alguns segundos e teste sua pesquisa, conforme orientação do item de Pesquisa. 3. UNIFICAR BOLETIM DE EVOLUÇÃO 1) Na aba Project (Projeto), unifique o Boletim de Evolução documentado, feito por mais de um usuário ao mesmo tempo, clicando em Refresh Project. 2) Todos os usuários devem fechar o projeto e o responsável por unificar a informação deve clicar em Abrir; 3) Selecione o arquivo xml salvo, conforme item 3 do item 4 abaixo. Note que o botão Refresh Project estará habilitado. Para que as alterações sejam atualizadas é importante sempre salvar seu projeto.

25 Página 25 de 48 Importante: este recurso não funcionará para alterações realizadas no mesmo tópico. Caso duas pessoas tentem alterar o mesmo tópico ao mesmo tempo, será apresentada uma mensagem de alerta. 4. COMPILAR DOCUMENTO 1) Antes de compilar, posicione o cursor sobre o primeiro tópico da árvore. Isso permitirá que ele oculte os demais tópicos e seja apresentado conforme ilustração da imagem abaixo.

26 Página 26 de 48 2) Clique no botão Publish (Publicar) para compilar o documento para a extensão utilizada como padrão. Para Boletim de Evolução e para Ajuda use extensão.chm. Importante: após a compilação do documento de Ajuda, é necessário testá-lo. Para isso, copie o aquivo.chm e cole no caminho: C:\WinThor\Prod\Help 3) Para que várias pessoas utilizem o mesmo documento será necessário salvar o arquivo em xml, conforme imagem abaixo:

27 Página 27 de ) Na pasta escolhida para salvar o arquivo uncompressed xml não poderá conter outros arquivos, ou seja, deverá ser uma pasta vazia. Caso existam outros arquivos, será arpresentada uma mensagem de alerta. Escolher outro local Criar uma nova pasta 3.2) Selecione a opção desejada. Ao salvar, todos os arquivos abaixo serão apresentados na pasta selecionada.

28 Página 28 de COMPILAR DOCUMENTO PDF EXCLUINDO PÁGINAS DESNECESSÁRIAS Após criar/importar o Boletim de Evolução na ferramenta Help & Manual 5, siga os passos abaixo: 1) Clique no botão Manual Designer da caixa Tools; 2) Selecione a aba Empty Pages e a opção Page Options... 3) Na aba This Section Only, desmarque a opção Print section (uncheck if you don t want this section in your manual). Selecione as demais abas que não deseja apresentar e clique na mesma opção;

29 Página 29 de 48 4) Salve na pasta desejada, que já será aberta. Clique no botão Publish e selecione a opção Publish with Options; 5) Clique no link Customize PDF Layout e selecione a opção PDF Layout;

30 Página 30 de 48 6) Em Print Manual Template, selecione o modelo salvo na pasta onde o pdf foi gerado anteriormente; 7) Clicar no botão Publish (Publicar). 5. PESQUISAR DOCUMENTO NO SVN 1) No Repositório SVN, clique com o botão direito do mouse sobre a pasta do Produto; 2) Selecione a opção TortoiseSVN Show log;

31 Página 31 de 48 3) No campo de pesquisa, informe o assunto e/ou número da rotina que deseja pesquisar; Para pesquisar o documento pelo assunto e/ou rotina é indispensável que esta informação tenha sido inserida na mensagem durante o commit do documento (ao cria-lo ou atualizálo). 4) Selecione o documento desejado. Se houver a necessidade de abri-lo na terceira caixa, clique duas vezes sobre ele;

32 Selecione o documento aqui. Ferramentas de Apoio para Página 32 de 48 3ª caixa 6. EDITAR IMAGEM NO PHOTOSCAPE 6.1. INSTALAR O PHOTOSCAPE 1) Selecione o arquivo de instalação localizado no Servidor SVN, no endereço: D:\SCRUM\Equipe Documentação\Executaveis\Photoscape e clique 2X (duas vezes) sobre o arquivo PhotoScapeSetup_V3.5.exe para iniciar a instalação. 1.1) Na tela de apresentação do aplicativo, clique no botão Next para continuar a instalação e na tela para aceitação do contrato de licença do aplicativo, clique no botão I Agree;

33 Página 33 de ) Na tela para a escolha dos componentes a serem instalados, clique no botão Next para continuar a instalação.

34 Página 34 de ) Na tela para escolha do local de instalação do aplicativo no seu computador, clique no botão Next para continuar. Em seguida, acompanhe o andamento na tela de instalação.

35 Página 35 de ) Essa é a tela de finalização. Se a opção Run PhotoScape V3.5 estiver marcada ao clicar sobre o botão Finish, o aplicativo será iniciado 6.1. TELA INICIAL DO APLICATIVO

36 Página 36 de EDITANDO IMAGENS INSERINDO NOME OU MARCAÇÃO NA IMAGEM 1) Após inserir a imagem selecione a aba Objeto. Várias ferramentas serão apresentadas. Clique na ferramenta T (Texto); 2) Será apresentada a tela para escrever o texto e formatá-lo. Nessa tela você poderá escolher a fonte, tamanho, cor, negrito, itálico, tipo de alinhamento etc. Após formatar seu texto, clique no botão OK;

37 Página 37 de 48 3) O texto será apresentado na imagem. Ainda será possível fazer algumas alterações no texto: - Clicando no + o texto será duplicado; - Clicando no X o texto será excluído. 4) Ao selecionar o mouse sobre o quadradinho branco será possível editar o tamanho do texto em relação à imagem. Ao selecionar o mouse sobre a seta dupla curvada será possível girar o texto na imagem;

38 Página 38 de 48 Observação: Para movimentar o texto ou objetos sobre a imagem, marque a setinha preta da aba Objeto, depois selecione o mouse sobre o objeto desejado e arreste-o para o local de sua escolha. Para inserir um objeto ou forma, é de maneira semelhante, porém não será apresentada a tela para formatação.

39 Página 39 de 48 5) Após selecionar o objeto desejado, o mouse será a ferramenta para desenhar a forma, ou seja, você segurando e arrastando o mouse, definirá o local na imagem e o tamanho da forma; Formas:

40 Ferramentas de Apoio - Página 40 de RECORTANDO IMAGENS 1) Clique no botão Editor do círculo ou selecione a aba com o mesmo nome. Será apresentada a tela de edição com várias opções. A parte superior esquerda da tela são as pastas do seu computador, para que seja feita a escolha da pasta com as imagens a serem editadas. Na parte inferior esquerda são apresentadas as imagens contidas na pasta selecionada; - 2) Selecione uma imagem da pasta e ela será apresentada na parte principal da tela. Selecione a aba Cortar na parte inferior central da tela. Será habilitada a função para recortar a imagem, use o mouse para selecionar a parte da imagem que deseja cortar.

41 Ferramentas de Apoio - Página 41 de 48 3) Clique no botão Cortar para que a área selecionada seja recortada da imagem. Observação: Para reverter a alteração da imagem, clique no botão Desfazer, se forem várias alterações a serem revertidas, clique no botão Desfazer todos, assim a imagem voltará ao seu estado inicial.

42 Ferramentas de Apoio - Página 42 de 48 4) Para salvar as alterações na imagem, clique no botão Salvar. Será apresentada a tela para escolher as opções de salvamento, clique no botão Salvar Como, não faça qualquer alteração na caixa Opções. 5) Selecione a pasta, escolha o nome da imagem e o formato da imagem, depois clique no botão Salvar.

43 Ferramentas de Apoio - Página 43 de 48 6) Será apresentada a tela para você escolher a qualidade da imagem; Observação: Quanto maior a qualidade, maior também será o tamanho do arquivo. O tamanho máximo recomendado para uma imagem é de 2 MB (megabytes), diminua a qualidade se esse valor for ultrapassado.

44 Ferramentas de Apoio - Ao finalizar o recorte da imagem, vá até a pasta em que salvou a imagem e confira o resultado. Página 44 de UTILIZAR OCAM ocam é um programa que realiza gravações diretamente do computador. Com ele, é possível produzir vídeo tutoriais com áudio. A interface de trabalho é única e traz botões autoexplicativos. Este tutorial apresenta os procedimentos necessários para utilizar esta ferramenta INSTALANDO OCAM Para instalar o programa ocam realize os seguintes procedimentos: 1) Acesse o diretório C:\documentacaoSVN\oCam e em seguida clique no arquivo ocam bits Selecione o idioma Português(Portugal) e clique no botão Ok; 2) Clique no botão Seguinte; 3) Na tela Contrato de Licença selecione a opção Aceito o contrato e clique no botão Seguinte; Clique no botão Concluir; CONFIGURANDO OCAM Para configurar o ocam realize os seguintes procedimentos: 1) Na tela inicial selecione o ícone ; 2) Selecione o menu Gravando em seguida marque a opção Configurar Dispositivos Áudio;

45 Ferramentas de Apoio - Página 45 de 48 3) Selecione na caixa Configurar Dispositivos Áudio as seguintes opções: Dispositivo: Drive de captura de som primário; Canal: Stereo; Taxa de Quadros: ) Selecione o Menu Salvar e no campo Output path informe o diretório onde os vídeos serão salvos e em seguida clique no botão OK;

46 Ferramentas de Apoio - Página 46 de 48 5) Selecione o ícone Codecs e marque a opção Microsoft MPEG -4part2 (.AVI). 6) Selecione o ícone tamanho e marque umas das opções destacadas;

47 Ferramentas de Apoio - Página 47 de GRAVANDO VIDEO TUTORIAL Organize todas as informações pertinentes ao processo antes de iniciar a gravação. Não é necessário utilizar linguagem totalmente formal, porém, evite vícios e gírias. Para gravar vídeos no ocam realize os seguintes procedimentos: 1) Clique no ícone ; 2) Realize os procedimentos que serão apresentados no vídeo tutorial e ao finalizar tecle o F2; 3) Utilize os atalhos descritos abaixo conforme necessidade:

48 Ferramentas de Apoio - F2 : grava e finaliza; F3: captura imagem; F4 : alvo. Página 48 de 48