Home

da Monografia - Departamento de Sistemas e Computação

1. 62 24 29 11 REPRESENTANDO INFORMA O QUE DEVEM SER DIGITADAS PELO USUARIO assa ea Das era EAE pal 62 24 29 12 REPRESENTANDO TECLAS eee rseemeeenserseneemeereaseena 62 24 29 13 CONES E SINALIZADORES temeeeeeeeeemeeeeeemeeeeeemeereeere 63 2 4 29 13 1 DESIGN CONES OU SINALIZADORES eeememeemeeemeees 63 2 4 29 13 2 ESCOLHA DE UM CONE GR FICO meneame 64 2 429 13 3 EXIBINDO O NOME DOS CONES 64 24 29 14 APRESENTA O DE ILUSTRA ES 64 3 DESENVOLVIMENTO DO SOFTWARE ceeneeneeneenerneeneenerseeneeneersereensersees 65 3 1 AMBIENTE DE DESENVOLVIMENTO aeee 65 3 2 POWER DESIGNER saia ia nie asa A an 65 3 3 AMBIENTE DE DESENVOLVIMENTO DELPHI 65 3 3 1 CARACTER STICAS uns nest ana da oO DR ai oa ia o ad Rd 66 33 2 RECURSOS quiserem gas gundo LOS nd aaa EA cr ca ss 66 3 4 ROBOHELP OFFICE XIen e rs sado na ad Sa ea a ri la 66 3 5 DIAGRAMA DE CONTEXTO aaa Anac ita Soa di te aa 67 3 6 DIAGRAMA ENTIDADE E RELACIONAMENTO 67 3 7 DICION RIO DE DADOS ui cdi a 68 3 8 OPERACIONALIDADE cemeeeeemeemeeeemeemeeree eee mereeereemeereeeemeereee 70 3 8 1 FUNCIONALIDADE DO SOFTWARE eremita 70 3 9 RESULTADOS OBTIDOS aan sono id O ns Sa ren 76 4 CONCLUS ES sacana isa scenes isca atuo 79 AI ER TENS ES adia ss a a a A sia a o O ea ae 79 42 DIFICULDADES essa senao os nan O DR EE E eN 80 REFER NCIAS BIBLIOGR FICAS sesssessssesssssssssescsceccccerorororsososssssssss
2. SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software 84 SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software Todos os Direitos Reservados Qualquer reprodu o adapta o tradu o sem o consentimento do autor s o extremamente proibidos conforme os direitos de reprodu o Primeira Edi o Junho 2004 Autor Anderson Nicolodelli Contato andnicOinf furb br 85 SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software In cio 86 Sum rio Apresentacao assaini en iina EAE aa E aaia Sidi can icon E Dis asc na tnca sas Ud Saad candida 6 Requisitos do Sistema isisisi isian aaa aaa a das ERE CADA iN EAEE Ea a aana 7 Instru es de Instala o csapta a aa aaa aaa aa aaa aiaa a ian 8 Como TNiciatasiay n a a aana a aaa aa SAAE EAN aN EANG 9 EaI E E A EE E E E E A E P E A A 10 Barra d Ferramentas ninantan aa aaia a sho a ana a ana a da SAS Sa ana S ma sa 14 Navega o pelos Cadastros sssssssssssssstsrrnnntnnttktrAnAAANNENEEAANANANAENEEEEAAAENANAANNEEENENAN NENE EE EEEE 15 Cadastro de Avaliadores assonnate nn raaa ai ias aN A aiae 16 Cadastro d Perguntas asrini innana ana aa aAa Aa aaa NE GERA 17 Cadastro de Softwares ajusaua sa ciiaas counianidaeni a aa a aa a aAa a aa 18 Cadastro de Documentos sispann an a aa aaa EA A AA aA T dado 19 Registro de Avalia es seeiiitererasenaaeaneaararasaaaaaanaaana rare aana ana a
3. 67 Figura 15 Diagrama de entidade relacionamento f sico 68 Quadro 3 Detalhamento da tabela avaliador cce si iieererereerereeerereeererrereeeranants 68 Quadro 4 Detalhamento da tabela avalia o in reereeeeeeercereanas 69 Quadro 5 Detalhamento da tabela documento ssnnsossoseneoeesessssoseoereessssosesereessssssesereesesss 69 Quadro 6 Detalhamento da tabela pergunta ii reeeereeeeerercereanos 69 Quadro 7 Detalhamento da tabela resposta ques azaras sein quina Sea SA a 69 Quadro 8 Detalhamento da tabela software c ii iiieeererereerereeeraereeererrereeeraaneta 69 Figura 1 6 Tabelas NO ACCESS Ss espera ish dates saias aea A iee A a aa 70 Figura 17 Tela principal do software ee rseeraeereaeeneeraceraaneaa 71 Figura 18 Tela de cadastro de avaliadores seseseeseeeesessesessessresressetsesrerseesesressressesereseeses 71 Figura 19 Tela de cadastro de softwares eseseeessesesseessesressessresressetsresreesreseeserssressesereseses 12 Figura 20 Tela de cadastro de documentos sesessseesessesessssessessesresseesreseerseestesrrssresreseresreses 12 Figura 21 Tela de cadastro de perguntas eseeesessesessessresressessresressetssesrerseeseeseresressesereseeses 13 Figura 22 Tela de registro de avalia es eneeseeesseeessssseeressessresressersresreesresesrrssresreseresresee 14
4. 93 No item Relat rios podemos encontrar as seguintes op es Avaliadores Gera o relat rio de todos os avaliadores cadastrados Avalia o Gera o relat rio das avalia es com o percentual de conformidade as perguntas com sua respectivas resposta e os dados pertinentes a cada avalia o Perguntas Gera o relat rio de todas as perguntas cadastradas com sua categorias e aplica o Softwares Gera o relat rios dos softwares cadastrados juntamente com a documenta o a eles atrelada SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software Iof x Cadastros Avalia o Relat rios Ajuda Avaliadores amp Avalia es Perguntas ER Softwares e jsjole 48 3 SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software lele le F eles le 94 No item Ajuda podemos encontrar as seguintes op es Informa es Exibe a janela de ajuda do software Sobre Exibe informa es sobre o software como direitos e autor t SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software Iof x Cadastros Avalia o Relat rios Ajuda 9 Informa es N Sobre E T SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software e lz le Elele lelelels 95 Barra de Ferramentas A Barra de Ferramentas est localizada a esquerda da tela inicial do software A seguir defini se a finalidade de
5. realizada atrav s da tela de Registro de Avalia es Quando da conclus o da avalia o voc poder consultar a mesma de duas formas uma delas atrav s da tela de Consulta de Avalia es ou pelo Relat rio de Avalia es 91 Menu No menu voc possui acesso as telas do software A seguir segue uma descri o detalhada do que cada faz No item Cadastros podemos encontrar as seguintes op es Avaliadores Exibe a tela de cadastro dos avaliadores Perguntas Exibe a tela de cadastro das perguntas Documentos Exibe a tela de cadastro dos documentos de cada software Software Exibe a tela de cadastro dos softwares que ser o avaliados Sair Encera o software SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software Iof xi Cadastros Avalia o Relat rios Ajuda Avaliadores Perguntas Documentos ER Softwares Sair X SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software e lz le Slee lele 92 No item Avalia o podemos encontrar as seguintes op es Registro Exibe a tela de registro de uma nova avalia o Consulta Exibe a tela de consulta das avalia es j registradas x SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software Iof xi Cadastros Avalia o Relat rios Ajuda ap Registro amp Consulta 3 SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software IE
6. 31 Tipografia 31 1 Existe somente poucos tipos de fontes utilizadas 31 2 As fontes utilizadas s o consistentes 31 3 As fontes s o leg veis 31 4 Existem fontes adequadas sendo utilizada na apresenta o por exemplo Verdana ou Arial 31 5 Existem diferentes n veis entre os t tulos de f cil percep o 31 6 Os n veis diferentes entre os t tulos representam a hierarquia adotada corretamente x x x x x x 31 7 A maioria do texto est em escrita com inicio de frases em letra mai sculas e o restante em min sculas 31 8 Existem fontes dispon veis na interface do usu rio 31 9 Existem letras mai sculas como o tamanho de pelo menos por 3mm 31 10 Sublinhados que cortam letras min sculas s o evitados 31 11 O m todo utilizado para destacar palavras ou frases consistente x x x x x x x x x x x x 31 12 O m todo utilizado para destacar palavras ou frases efetivo 31 13 No caso de impress o da documenta o as fontes s o impressas corretamente em todos os tipos de impressoras dispon veis para o usu rio 31 14 O tamanho do texto adequado para o ambiente onde o documento ser utilizado 31 15 O espa o entre as linhas suficiente 32 Layout da Informa o 32 1 Mensagem importantes s o exibidas suficientemente 32 2 Existem elementos similares posicionados consistentemente 32 3 Existe espa o em branco para separar eleme
7. Key Words Software Quality Evaluation Support Documentation LISTA DE ILUSTRA ES Figura 1 Conhecimento do modelo CMM pelas empresas de software Jo 17 Figura 2 Conhecimento da norma ISO IEC 12207 pela empresas de software 18 Figura 3 Conhecimento da Norma ISO 15504 SPICE pela empresas de software 19 Figura 4 Exemplo da descri o de uma tarefa com os elementos destacados 30 Figura 5 Exemplo da descri o de uma fun o de uma planilha eletr nica 33 Figura 6 Exemplo de defini o de um termo ir erereeereeneeernanea 36 Figura 8 Exemplo da explora o da informa o atrav s de links 38 Figura 9 Exemplo de menu gr fico usisanesiessanearisacastanac jadrasiagas tan serena adia acesas aa da obesa Deva 42 Figura 10 Exemplo de menu com estrutura hier rquica de dois n veis 42 Figura 11 Exemplo de lista de conte do asma ss serasa rdias Seia aaa Ep aaa 44 Figura 12 Exemplo de sobreposi o de janelas eeeeereracerenaa 53 Quadro 1 Exemplo espa amento e quebra de linhas do texto 59 Quadro 2 Exemplo de representa o da informa o exibida pelo software 62 Figura 13 Diagrama de Contexto usas assa as AS Ena RU aaeoa a ans 67 Figura 14 Diagrama de entidade relacionamento l gico
8. Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Documenta o Impressa Pergunta A apresenta o de cada documento deixa clara o que cada um contem Documenta o Impressa Pergunta O tamanho m dio de cada documento amp adequado a modo de permitir a sua utiliza o Documenta o Impressa Pergunta A orienta o de cada documento amp adequado ao uso Documenta o Impressa Pergunta A maicria da documenta o est impressa em formato retrato Documenta o Impressa Pergunta Existe uma capa adequada para cada documentos conforme sua utiliza o Documenta o Impressa Pergunta Para documentos com encadema o em espiral cespiral n o compromete a leitura da informa o Documenta o Impressa Pergunta Para documentos em pastas existe apenas um tipo dedocumento em cada pasta Documenta o Impressa Pergunta Existem cart es e folhetos adequados para uso Documenta o Impressa Pergunta O papel amp adequado para o uso esperado da documenta o Documenta o Impressa Pergunta Existem p gina divis rias feitas de papal gesso ou transparentes Documenta o Impressa Pergunta Existem p ginas divis rias dur veis o suficiente conforme o usada documenta o Documenta o Impressa Pergunta utilizado papel opaco quando o documentos s o impressos em frente e verso Documenta o Impressa Pergunta O material
9. es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Documenta o Impressa Pergunta Existe refer ncia cruzada entre documentos separados Documenta o Impressa Pergunta Existe refer ncia cruzada suficiente entre as se es quecontem informa es relacionadas Documenta o Impressa Pergunta A refer ncia cruzada amp apropriada Documenta o Impressa Pergunta A refer ncia cruzada necess ria Documenta o Impressa Pergunta A refer ncia cruzada de facil localiza o Resposta N o se aplica Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es Documenta o Impressa e On Line Pergunta Os temos e abreviaturas est o definidos onde h necessidade Resposta Atende Observa es P gina 4 Data SAQDSO Relat rios de Avalia es Documenta o Impressa e On Line Pergunta Os temas s o utilizadas com consist ncia Documenta o Impressa e On Line Pergunta O vacabul ria amp apropriado ao p blico alvo Documenta o Impressa e On Line Pergunta A maioria das palavras nos vocabul rio s o simples e f cil compreens o Resposta Atende Observa
10. o Campo onde deve ser cadastrado informa o sobre o Documento Tipo Campo onde deve ser selecionado o tipo do documento dentre os tr s tipos dispon veis On Line Impresso Impresso e On Line Data de Publica o Atualiza o Campo onde deve ser cadastrada a data de publica o ou a ltima data de atualiza o do documento f SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software9 SAQDS Cadastro dos Docume E3 Cadastros Avalia o Relat rios Ajuda Software Microsoft Word xP hd Nome Manual do Usu rio Descri o Descreve como proceder com o software Microsoft Word XP Tipo Data Publica o Atualiza o impresso e On Line z 25 05 2000 101 Registro de Avalia es Nessa janela realiza se o Registro de Avalia es A seguir defini se todos os campos Avaliador Campo onde deve ser escolhido um o Avaliador Software Campo onde deve ser escolhido o Software Informa es Adicionais Campo onde deve ser cadastradas informa es adicionais sobre a Avalia o caso necess rio Data Campo onde deve ser cadastrada a data em que se realiza a Avalia o M tricas Campo onde deve ser selecionado a m trica desejada para ser utilizada na Avalia o Ap s a entrada da informa es para iniciar a avalia o deve se clicar no bot o Iniciar E SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software SAQDS Reg
11. o e fornecimento de software 18 De acordo com Jomori et al 2004 p 46 a norma ISO 12207 Tecnologia da Informa o Processos de ciclo de vida de software estabelece uma estrutura comum para os processos de ciclo de vida de software cobrindo desde a concep o at a retirada do software do mercado A norma tamb m prov um processo que pode ser utilizado para definir controlar e melhorar os processos de ciclo de vida de software As atividades que podem ser executadas durante o ciclo de vida de software est o agrupadas em cinco processos fundamentais oito processos de apoio e quatro processos organizacionais a processos fundamentais aquisi o fornecimento desenvolvimento opera o e manuten o b processos de apoio documenta o ger ncia de configura o garantia da qualidade verifica o valida o revis o conjunta auditoria e resolu o de problema c processos organizacionais ger ncia infra estrutura melhoria e treinamento Na Figura 2 pode se ver a evolu o do conhecimento da norma ISO IEC 12207 pelas empresas de software m1997 1999 12001 Conhece e usa Conhece mas n o usa N o conhece Fonte Jomori et al 2004 p 46 Figura 2 Conhecimento da norma ISO IEC 12207 pela empresas de software Segundo Jomori et al 2004 p 48 a futura norma ISO 15504 SPICE Tecnologia de informa o avalia o de processos que est em desenvolvimen
12. Documenta o On Line Pergunta A velocidade de acesso ao indice amp adequada Documenta o Impressa Pergunta Est clara em que documentos procurar cada tipo de informa o Documenta o Impressa Pergunta f cil encontrara informa o correta em cada documento Documenta o Impressa Pergunta Existe uma tabela de conte do para cada documento Documenta o Impressa Pergunta Cada tabada de conte do amp de f cil compreens o usual correta e bem editada Documenta o Impressa Pergunta Tantoas refer ncias da tabela de conte dos e dos indices s o f ceis de seguir Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es 136 02707 2004 Documenta o Impressa e On Line Pergunta A informa o est estrutura de uma maneira l gica do pontade vista em que o usu ria necessita da informa o Documenta o Impressa e On Line Pergunta A estrutura da informa o est clara e explicada aos usu rios Documenta o Impressa e On Line Pergunta A informa o est dividida em partes adequadas Documenta o Impressa e On Line Pergunta A ordem em que as informa es foram divididas est adequada Documenta o Impressa Pergunta Cada dacumentoou cada parte est estruturada em capitulos ou se
13. X 16 11 Existe uma tabela de conte do para cada documento X 16 12 Cada tabela de conte do de f cil compreens o usual correta e bem editada X 16 13 Tanto as refer ncias da tabela de conte dos e dos ndices s o f ceis de seguir 120 APLICA O ON LINE IMPRESSA CHECK LIST DOCUMENTA O DE SOFTWARE 02 de 04 17 Estrutura 17 1 A informa o est estrutura de uma maneira l gica do ponto de vista em que o usu rio necessita da informa o 17 2 A estrutura da informa o est clara e explicada aos usu rios 17 3 __A informa o est dividida em partes adequadas x x x x 17 4 A ordem em que as informa es foram divididas est adequada 17 5 Cada documento ou cada parte est estruturada em cap tulos ou se es 17 6 E f cil encontrar o in cio de cada parte e cada cap tulo ou se es x x x x x x x 17 7 Existem ap ndices ou anexos utilizados apropriadamente para referenciar informa es extensas 18 Orienta o 18 1 Est claro que tipo de informa o exibida 18 2 Cada t pico possui um t tulo adequado x x x 18 3 O usu rio podem voltar a um t pico anterior 18 4 Est claro que tipo de informa o est contida em cada se o 18 5 Cada se o possui um t tulo adequado x x x 18 6 O usu rio pode encontrar o melhor ponto de partida para suas necessidades 19 Atalhos 19 1 Existem diferentes
14. do desenvolvimento do produto A qualidade de software considerada uma necessidade Iniciou se os primeiros trabalhos de 1720 publica o de normas da qualidade 2000 Come a se a verificar que a maioria dos softwares desenvolvidos n o entra no mercado sem que passe por rigorosos testes para assegurar a qualidade dos mesmos Fonte adaptado de Silva 1999 2 3 DOCUMENTA O DE SOFTWARE De acordo com Sommerville 1992 todo sistema de software possui uma grande quantidade de documenta o a ele associado Uma alta propor o do custo de um software 21 est associado a produ o desta documenta o Deveria ser dada tanta aten o documenta o e ao custo associado quanto ao desenvolvimento do software em si Segundo Candid 1997 estima se que a Microsoft possui um custo total de uma simples liga o ao suporte t cnico de mais de 20 d lares desconsiderando a quest o do suporte t cnico possuir ou n o a resposta para o problema De acordo com Sommerville e Candid pode se concluir que a documenta o de software representa uma parcela significativa tanto no custo do produto final software quanto na rea de p s venda Desta forma n o basta produzir apenas a documenta o ela tem que ter qualidade afim de que os usu rios possam compreend la facilmente evitando chamadas desnecess rias ao suporte Segundo Rezende 1997 a documenta o de software tem os seguintes objetivos a
15. o ou tarefa Na Figura 7 pode se ver um exemplo da utiliza o de conceitos F rmula Exemplos Voc pode utilizar uma f rmula para realizar c lculos com valores como uma calculadora normal faz e colocar o resultado em uma c lula Os valores utilizados nas f rmulas podem ser n meros que voc pode digitar n meros que est o em outras c lulas associados por referenciamento de c lulas n meros que resultam da utiliza o de fun es provenientes do sistema Voc pode especificar os c lculos utilizando os seguintes operadores como por exemplo Toda a hora que voc modificar qualquer valor em uma c lula utilizada por uma f rmula o programa automaticamente ir atualizar o resultado da f rmula Veja tamb m Lista de fun es Manual do modo de rec lculos Fonte adaptado de ISO IEC International Organization For Standardization International Electrotechnical Commission 2004 p 71 Figura 7 Exemplo de um conceito 2 4 7 EXPLORA O DA INFORMA O Existem tr s tipos de explora o da informa o em se tratando de informar o usu rio sobre como utilizar fun es providas pelo software a utilizando artif cios visuais complexos b utilizando artif cios usuais c utilizando artif cio de efeitos especiais 38 Embora existam os tr s tipos citados poss vel fazer uma combina o desses tr s tipos Deve se levar em conta alguns itens em se tratando
16. 2 4 4 2 VIS O GERAL DA DOCUMENTA O Conhecida geralmente como overview fornece ao usu rio uma vis o geral da documenta o do produto Nela poss vel saber qual informa o est dispon vel on line e que forma essa informa o toma adicionalmente responde quest es como Como posso acessar a ajuda e Que informa o est dispon vel sobre esse software aconselh vel incluir na estrutura do documento os itens a sum rio e exclu do apenas em circunst ncias especiais o ndice de todos os documentos em exce o a guia de refer ncia r pida como por exemplo cart es b gloss rio c lista de outros documentos que s o referenciados d bibliografia 28 A vis o geral tamb m fornece detalhes de onde encontrar qualquer informa o que o usu rio possa vir a necessitar e que n o esteja dispon vel on line Caso determinadas informa es forem disponibilizadas em conjunto de itens onde o usu rio possa navegar por elas aconselh vel observar os seguintes itens a desenvolver a documenta o de tal forma que seja o mais f cil poss vel de se usar para que mesmo o mais inexperiente usu rio possa utiliz la imediatamente com o m nimo de orienta o b mostrar a estrutura da documenta o c mostrar a abrang ncia de cada item da estrutura d explicar como navegar pela estrutura e se recursos flex veis ou avan ados forem fornecidos como por exemplo anota es inser o de indic
17. 37 6 Ao menos que se necessite de outra cor em especial o papel utilizado branco 38 Layout das P ginas 38 1 O layout das p ginas simples 38 2 As p ginas possuem numera o clara 38 3 Existem elementos comuns as p ginas dispostos na mesma posi o em cada p gina 39 Layout das Se es 39 1 As se es principais come am sempre em uma p gina nova 39 2 Os t tulos das se es s o claros 39 3 As se es est o claramente distinguidas umas das outras 39 4 Assuntos similares s o apresentados com similares layouts 39 5 O layout das se es apropriado para a informa o contida neles x x x x x x x x x x x x x x x x x x x x x x x 39 6 Existe espa o em branco suficiente na p gina a modo dela n o parecer cheia demais AP NDICE C Avalia o dos auditores 123 Microsoft Photo Editor v3 01 Documenta o On Line 01 de 02 Itens Avaliados Hideraldo Julciane Josiane 1 Direitos e vers o do produto PA PA PA 2 Vis o geral da documenta o PA AT PA 3 Descri o de processos NA NA NA 4 Descri o de tarefas AT AT AT 5 Explica o de campos e op es AT AT NT 6 Nomes das op es da interface do usu rio PA PA AT 7 Des
18. Figura 23 Tela de consulta de avalia es camacasissa asrasazmnassaissopesitna sapatos uasaranaguada obesa teana as 75 Figura 24 Exemplo de relat rio de avalia o sseeseeseseseesesseseresreeserssesrerseeseeserssrenreseresreses 15 Figura 25 Janela de ajuda do software esa nd aa GEO E US 76 LISTA DE TABELAS Tabela 1 Defini es que se aplicam qualidade ssesseeseeeeeseeeseeressetssesresseesresressressesereseeses 16 Tabela 2 Certifica o do Sistema da Qualidade ISO 9000 nas empresas de software 16 Tabela 3 Evolu o da qualidade do produto software sssessseeeseeessseesseessessseeesseeesseesseess 20 Tabela 4 Equ vocos da documenta o de software errar 22 Tabela 5 Documenta o adotadas anos gap A A 23 Tabela 6 Exemplo de m todos de acesso ccceesersereereerserseeeeracesesererescereeseeererceesenecerenoe 41 Tabela 7 C lculo do percentual de conformidade e erereerenaa 74 SUM RIO INTRODUCA Onninen GUI 13 TIVOBIETI VO merin eena unauna annan a a na R 14 12 JUSTIFICATIVA aiin a Sa dd a 14 1 3 ESTRUTURADO TRABALHO dust ia in ta erreen 15 DEU ALI ADE Esso SS E E 16 2 1 QUALIDADE DESORTRARE as cassia ai a na a 16 2 2 EVOLU O DA QUALIDADE DE SOFTWARE enem 20 2 3 DOCUMENTA O DE SOFTWARE eee eee eee 20 2 4 QUALIDADE NA DOCUMENTA O DE SOFTWARE 21 2 4 1 FORMAS DE DOCUMENTA O t eee e
19. Pergunta O texto da ilustra es amp grande o suficiente para ser compreendico pelos menas 3mm para letras mai sculas Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es P gina 7 Data SAQDSO Relat rios de Avalia es Documenta o On Line Pergunta O usu rio pode imprimir as ilustra es Documenta o On Line Pergunta Existem reas de ativa o atalhos nas ilustra es claramente identificadas Documenta o On Line Pergunta Para documentos que necessitam serem impressos tanto as ilustra es linhas e textos s o impressos de forma cometa legivel Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es 141 02707 2004 Documenta o On Line Pergunta Os icones e os sinalizadores s o de f cil compreens o Documenta o On Line Pergunta Os gr ficos utilizados nos icones e sinalizadores s o claras Documenta o On Line Pergunta Os gr ficos utilizados nos icones e sinalizadores representam as objetos atuais as a es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Documenta o Impressa Pergunta A apresenta o de cada documento deixa clara o que cada um contem Documenta o Impressa Pergunta O tamanho m dio de cada documento amp adequado a modo de permitir a sua
20. Tipo Documento VARCHAR 150 Data Pub Documento DATE Nm Pub Documento VARCHAR 250 Figura 15 Diagrama de entidade relacionamento f sico 3 7 DICION RIO DE DADOS O dicion rio de dados consiste em uma descri o das entidades do sistema como seus respectivos atributos Na documenta o do Dicion rio de Dados foi adotado a seguinte formata o a a coluna Name apresenta uma breve descri o do atributo b a coluna Code apresenta o nome que identifica o atributo na tabela c a coluna Data Type apresenta o tipo do atributo e seu tamanho d a coluna Mandatory identifica se o atributo obrigat rio e a coluna Primary identifica se o atributo chave prim ria Data Type Mandatory Bairro do Avaliador CEP do Avaliador C digo do Avaliador Cidade do Avaliador Endere o do Avaliador Estado do Avaliador Nome do Avaliador N mero do Endere o do Avaliador Telefone do Avaliador BAIRRO AVAL CEP AVAL CD AVAL CIDADE AVAL END AVAL ESTADO AVAL NOME AVAL NUMERO END AVAL TELEFONE AVAL VARCHAR 100 VARCHAR 50 INTEGER VARCHAR 100 VARCHAR 150 VARCHAR 50 VARCHAR 150 INTEGER VARCHAR 50 Quadro 3 Detalhamento da tabela avaliador 69 Data Type Mandar C digo Avaliador CD_AVAL INTEGER C digo da Avalia o CD_ACAO INTEGER C digo do Software CD_SOFTWARE INTEGER Coment rio da Avalia o COM_ACAO VARCHAR 250 Data da Avalia o DATA_ACAO DATE Resultado da Avalia
21. divulgar e deixar claro transparente o que o sistema faz como utiliz lo as suas vantagens opera o e requisitos para funcionamento b mostrar quais as t cnicas ou ferramentas utilizadas para o desenvolvimento tempo custos equipe cronogramas metodologia integra o etc c orientar e treinar o usu rio na opera o dos sistemas d possibilitar a garantia para a empresa da continuidade do funcionamento do sistema 2 4 QUALIDADE NA DOCUMENTA O DE SOFTWARE Qualquer pessoa que usa um software deseja ter informa es corretas sobre como usar o mesmo Se essa informa o fornecida de uma maneira conveniente com facilidade de se encontrar o que se procura e com clareza os usu rios podem rapidamente se tornar proficientes no uso desse produto Consegiientemente a vis o do cliente sobre esse produto passe a ser positiva Com isso fortalece se a imagem da empresa junto ao cliente Assim uma documenta o bem desenvolvida n o s auxilia o usu rio e contribui na redu o de custos de treinamento e suporte mas tamb m aumenta a reputa o dos produtos do fabricante e de seus distribuidores E importante ressaltar que a documenta o um componente essencial de qualquer produto Todo o sucesso ou fracasso de um produto pode depender da documenta o gerada 22 uma vez que esta pode ser o primeiro item tang vel com o qual o usu rio toma contato e isso os influ ncia na primeira impress o sobre o prod
22. tulo adequado como por exemplo Nota ou Informa o Deve se utilizar as instru es a seguir quando for elaborar mensagens informativas a n o utilize nenhum tipo de abrevia o ela pode dificultar a compreens o especialmente em se tratando de linguagem t cnica b apresente a situa o a prov vel causa e a a o que o usu rio pode tomar n o importando o quanto bvia ela possa ser c fa a mensagens espec ficas Evite a combina o de mais de duas ou tr s condi es em uma nica mensagem Por exemplo se a a o n o pode ser feita por diversas raz es apresente uma mensagem espec fica para cada raz o d tente oferecer aos usu rios as op es de SIM ou N O como escolha da resposta da mensagem em quest o e evite referi se a ajuda que n o possa estar dispon vel ao usu rio f descreva o efeito da escolha da a o que o usu rio possa escolher g evite m ltiplos passos para um solu o Caso isso seja inevit veis providencie instru es separadas ou adicione um bot o de ajuda para que uma janela apropriada possa ser acessada Sempre apresente os passos na segii ncia correta h apresente somente a informa o necess ria para que o usu rio possa compreender a mensagem A informa o deve ser suficiente a modo de permitir um usu rio avan ado ou uma pessoa de suporte a diagnosticar a condi o 2 4 4 9 2 TERMINOLOGIA Em rela o terminologia empregada nas mensagens deve se lev
23. tulos j texto normal o tipo pode ser o mesmo utilizado para os t tulos k pode se utilizar uma terceira fonte para informa es que o usu rio tenha que digitar no sistema l o mesmo tipo de fonte do texto normal pode ser utilizado para cabe alhos e rodap s 59 2 4 29 2 UTILIZA O DE NEGRITO E IT LICO O negrito e o it lico s o utilizados em texto normal para chamar a aten o de um item espec fico no texto A utiliza o em avisos e precau es n o recomendada Deve se limitar o uso de negrito a a t tulos b t tulos em tabelas c t tulos de tabelas e ilustra es Deve se limitar o uso de it lico a a texto que os usu rios dever o digitar na aplica o b vari veis c identifica o de elementos na interface em particular menus d identifica o de palavras em particular como por exemplo nomes de campos em um formul rio e introdu o de novos termos f cita es g t tulo de artigos e livros 2 4 29 3 LINHAS DO TEXTO importante garantir o espa amento entre linhas de texto esse espa amento deve ser de no m nimo um ter o do tamanho da fonte utilizada N o recomend vel utilizar espa os em branco ou quebra de linha afim de separar parte da informa o deve se seguir o exemplo apresentado no Quadro 1 O valor do exemplo 1 kHz O ideal seria escrever da seguinte forma O valor do exemplo 1 kHz Quadro 1 Exemplo espa amento e q
24. utiliza o Documenta o Impressa Pergunta A orienta o de cada documento amp adequado ao uso Documenta o Impressa Pergunta A maioria da documenta o est impressa em formato retrato Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Documenta o Impressa Pergunta Existe uma capa adequada para cada documentos conforme sua utiliza o Documenta o Impressa Pergunta Para documentos com encadema o em espiral espiral n o compromete a leitura da informa o Documenta o Impressa Pergunta Para documentos em pastas existe apenas um tipo dedacumento em cada pasta Documenta o Impressa Pergunta Existem cart es e folhetos adequados para uso Resposta Atende Observa es Resposta Atende Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es Documenta o Impressa Pergunta O papel amp adequado para o uso esperado da documenta o Documenta o Impressa Pergunta Existem p gina divis rias feitas de papa gesso ou transparentes Documenta o Impressa Pergunta Existem p ginas divis rias dur veis o suficiente conforme o usoda documenta o Documenta o Impressa Pergunta utilizado papel opacoquando o documentos s o impressos em frente e verso Documenta o Impressa Pergunta O material utilizado na documenta o im
25. A Deus pelo seu imenso amor e gra a A minha fam lia que sempre me ajuda em todos os momentos Aos meus amigos pelos empurr es e cobran as Aos meus colegas de trabalho Hideraldo Vilasboas Machado Julciane da Silva Pinheiro e Josiane Nicolodi Bernabe que me ajudaram na parte de valida o do trabalho Ao meu orientador Carlos Eduardo Negr o Bizzotto por ter acreditado na conclus o deste trabalho RESUMO O presente trabalho tem como objetivo a concep o e o desenvolvimento de um software para auxiliar na avalia o da qualidade da documenta o de software Inicialmente o trabalho faz uma apresenta o detalhada da norma ISO IEC 18019 2004 Software and System Engineering Guidelines for the Design and Preparation of User Documentation for Application Software a qual ser utilizada como base para o desenvolvimento do software proposto Em seguida o conte do da referida norma ser utilizado para a cria o de um check list o qual tornar a avalia o mais objetiva Al m do check list o trabalho prop e o desenvolvimento de m tricas que permitam a quantifica o da qualidade da documenta o do software em quest o Ap s ser desenvolvido o software proposto utilizado para auxiliar na realiza o de tr s avalia es por tr s auditores diferentes O grau de efetividade tanto do check list quanto do software ser avaliado pela magnitude da variabilidade entre as diferentes avalia es Quanto menor a di
26. INFORMA ES ON LINE 40 I a MENUS sad mas Sia si do aaa Si AE ca T 41 2 4 12 LISTA DE CONTE DO ac tirano UN coa aa ara aaa 43 DAS INDICES actas SA ed fai ab a O o SE Rg O i 44 DAMA BUSCAS aan e n ai ad a a BO a aa cao a 45 2415 NAVEGA O PELO USUARIO asa uteaga o siga irmandade da aa 45 2 4 16 IDENTIFICA O DA INFORMA O CORRENTE ememenes 46 2 417 POSI O ATUAL EM UM T PICO eee 46 2 4 18 ACESSANDO NOVAMENTE A INFORMA ES 47 2 4 19 NAVEGA O ENTRE A APLICA O E A DOCUMENTA O 47 2 420 IMPRESS O DAS INFORMA ES ieeemememeee een 48 2 421 MOVIMENTA O ENTRE T PICOS DIFERENTES 48 24 22 INFORMA ES EXTRAS eteemeeeeeeeemeeeeeeemeeeereeeemeeeeeereeas 49 2 423 NAVEGANDO PELAS INFORMA ES iteememeeeeeemeeeemeeemeres 49 2 424 VISUALIZADO T PICOS EM SEQU NCIA 49 2 425 SAINDO DA DOCUMENTA O ON LINE 50 2 426 BUSCA DA INFORMA O FORNECIDAS PELO USU RIO 50 2 427 TAMANHO DOS T PICOS OU FRAGMENTOS 50 2 4 28 APRESENTA O DA DOCUMENTA O ON LINE 51 DART JANELAS acao Mons se a a Ma ai a a De A E 51 24 28 11 RELACIONAMENTO ENTE A EXIBI O DA INFORMA O E DA APLICACAO pi coesa Eae TS AD a RA NA 52 2 4 28 1 2 JANELAS SIMULT NEAS sctinsis anos Soo sn e a ren 52 2 4 28 1 3 JANELAS PADR ES aan ai nado a alien iG edad 52 2 4 28 1 4DISPOSI O DAS JANELAS iemeemeeereereenereeemeemeeee ereto 53 24 282 LAYOUTS E GRI
27. NA NA 42 Espa os em branco AT AT AT 43 T tulos e caminhos AT AT AT 44 Controles de navega o AT AT AT 45 Areas de n o rolagem AT AT AT 46 Utiliza o de cores AT NA AT 47 Personaliza o de cores NT NA NT 48 Paleta de cores NA NA NA 49 Cores de fundo e da aplica o AT AT AT 50 Design monocrom tico AT AT AT 51 N mero de cores AT AT AT 52 Fonte e tamanhos AT AT AT 53 Utiliza o de negrito e it lico AT AT AT 54 Linhas de teto AT AT AT 55 Espa amento vertical AT AT AT 56 T tulos em texto AT AT AT 57 Destaques de texto AT AT AT 58 Listas AT AT AT 59 Tabelas NA NA NA 60 Caixas e bordas AT AT AT 61 Anota es NA AT AT 62 Representando a informa o exibida pelo software AT AT AT 63 Representando informa o que deve ser digitada pelo usu rio NA AT NA 64 Representando teclas AT AT AT 65 Vari veis NA NA NA 124 Microsoft Photo Editor v3 01 Documenta o On Line 02 de 02 Itens Avaliados Hideraldo Julciane Josiane 66 Controles AT AT AT 67 Icones e sinalizadores AT AT AT 68 Design cones ou sinalizadores AT AT AT 69 Escolha de um cone gr fico AT AT AT 70 Exibindo o nome dos cones NA NA NA 71 Apresenta o de ilustra es NA NA NA Percentual total de conformidade 70 80 87 Legenda AT Atende PA Atende parcialmente NT N o atende NA N o se aplica Notas 1 Atende somente nos quesi
28. Observa es Os tituks rolam junto com o texto Resposta Atende Observa es Documenta o Impressa Pergunta Para documentos divididos em volumes os volumes est o chramente chssificados Documenta o Impressa Pergunta Para documentos divididos em partes as partes est o numeradas Documenta o Impressa Pergunta Os capitulos ou se es est o claramente numerados ou classificados de uma maneira apropriada Documenta o Impressa Pergunta O n mero da p gina de cada volume ou de cada parte deixa clara a qual volume ou parte ele pertence Documenta o Impressa Pergunta O m tado de numera o adotado amp adequado para o tipo de documento Documenta o Impressa Pergunta A numera o das p ginas est clara Documenta o Impressa Pergunta O m todo de numera o das p ginas amp consistentecom o m todo de numera o das se es Documenta o Impressa Pergunta A numera o das se es est clara Documenta o Impressa Pergunta Existem ilustra es que s o referenciadas no texto numerado Documenta o Impressa Pergunta Existem tabelas que s o referenciados no texto numerado Documenta o Impressa Pergunta Existem p ginas preliminares numeradas em uma sequ ncia separada do resto da documento Resposta N o se aplica Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa
29. RIO Os nomes refor am o significado dos cones ou elementos de interface provendo um m todo de visualiza o efetivo E aconselh vel fornecer nomes como por exemplo enviar registro ou limpar formul rio usando os mesmos tipos de nomes utilizados em menus Em se tratando de cones importante fix los pr ximos ao pr prio cone acima abaixo ou aos lados Tanto o nome como o cone devem estar ativos ou temporariamente ativos quando o usu rio necessitar de alguma ajuda por exemplo atrav s do status ou caixa de informa o Se os nomes das fun es e controles estiverem em diferentes formas gramaticais deve se torn los claros para que o usu rio saiba a finalidade de cada um Por exemplo um conjunto de fun es com os seguintes nomes Novo Registro Enviar Pedido Cancelar Pedido Inserir Item Pre o Unit rio Os usu rios necessitam muitas vezes descobrir o que um elemento da interface realiza nesse caso deve se exibir a informa o com uma frase simples e de prefer ncia come ando com um verbo como por exemplo enviar o pedido para a base de pedidos Caso o usu rio puder visualizar os nomes dos cones ou elementos da interface ou ainda algum detalhe de um elemento da interface na tela deve se fornecer tal facilidade para todos os elementos de interface 2 4 4 7 DESCRI O DAS FUN ES DO SOFTWARE As fun es do software s o parte de um sistema e fornecem facilidad
30. apoio ao processo de avalia o da qualidade da documenta o de software tomando como base a norma ISO IEC 18019 1 1 OBJETIVO O objetivo principal do presente trabalho desenvolver um software para auxiliar no processo de avalia o da qualidade da documenta o de software tomando como base a norma ISO IEC 18019 Os objetivos espec ficos do trabalho s o a utilizar o software SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software desenvolvido na avalia o da qualidade da documenta o do software b permitir que o avaliador possa criar e ou alterar as perguntas do check list elaborado c possibilitar a redu o da subjetividade da norma ISO IEC 18019 2004 atrav s da cria o de propostas de quantifica o d possuir toda a documenta o do software afim de garantir a conformidade aos requisitos normativos da norma ISO IEC 18019 2004 utilizada no processo de elabora o do check list 1 2 JUSTIFICATIVA Segundo Wohlgemuth 2003 p 12 em 2000 foi formado um grupo de trabalho com apoio da ISO International Organization for Standardization tendo como objetivo fornecer interpreta es das normas da s ria ISO 9000 prevenindo interpreta es amb guas e vagas Com base nessa preocupa o da ISO em fornecer interpreta es corretas de documentos normativos justifica se a relev ncia do desenvolvimento do presente trabalho pelos seguintes aspectos a dificuldade na compree
31. das janelas amp apropriado para a informa o que ela exibe Documenta o On Line Pergunta Existe espa o em branco suficiente na janela de modo que n o pare a cheia demais Documenta o On Line Pergunta Os titulos das janelas s o chrs Documenta o On Line Pergunta Os controles das janelas s o devidamente apropriados Documenta o On Line Pergunta Existem tituks dos t picos e controles contidos em reas onde n o possuem rolagem Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Documenta o Impressa e On Line Pergunta As cores s o utilizadas de forma apropriada Documenta o Impressa e On Line Pergunta As cores s o utilizadas de forma consistente Documenta o Impressa e On Line Pergunta Existem apenas poucas cores utilizadas Documenta o On Line Pergunta A apresenta o da aplica o trabalha em mada mancgram tico Documenta o On Line Pergunta O usu rio pode madificar as cores da interface e de funda da aplica o Documenta o Impressa e On Line Pergunta Existe consist ncia de polaridade por exemplo texto escuro com fundo claroj Documenta o On Line Pergunta O contrate entre as cores da interface e do fundo s o adequadas Documenta o Impressa Pergunta Na casa de impress o do documentos no
32. de documenta o dispon veis em todos os meios Dessa forma a fase de planejamento tamb m assume um papel pr vio importante no produto software com um todo No entanto esta fase n o ser abordada no presente trabalho J que o foco principal sobre o processo de avalia o propriamente dito As defini es crit rios especifica es e exemplos desse cap tulo est o em conformidade com a norma ISO IEC 18019 2004 ou seja foram traduzidos interpretados e adaptados a fim de facilitar o seu entendimento 2 4 4 1 DIREITOS E VERS O DO PRODUTO Os avisos sobre a reprodu o do material e detalhes da vers o do produto devem estar inclusos na documenta o Essas informa es podem variar de acordo com o pa s que se comercializa o software Se existir alguma informa o vital que o usu rio necessite conhecer importante assegurar que o usu rio possa ter acesso f cil a mesma por exemplo apresentando a informa o de uma s vez quando o software for iniciado Existem algumas informa es em rela o aos direitos e vers o do produto que devem ser consideradas dentre as quais destaca se a identifica o do software incluindo o nome sistema operacional edi o vers o linguagens suportadas e datas b data da publica o da documenta o c n mero de identifica o do produto d nome da empresa ou distribuidor do produto como endere o telefone fax e mail e endere o da p gina na Intern
33. diferente ao fornecido com a documenta o impressa 2 4 21 MOVIMENTA O ENTRE T PICOS DIFERENTES Caso exista a facilidade para o usu rio mover se de um t pico a outro recomend vel deixar claro os seguintes aspectos a o que ele deve fazer para mover se entre os t picos b que efeito isso ir gerar Particularmente deve se deixar claro o que ir ocorrer com a informa o atual e onde a nova informa o ser exibida Quando for poss vel deve se considerar as seguintes facilidades de navega o a voltar para o t pico anteriormente visualizado se houver algum b voltar para o in cio o n vel mais alto do menu ou da lista de conte do c subir um n vel na estrutura hier rquica d ir a frente para um t pico relacionado e ir a frente para um t pico em uma sequ ncia Adicionalmente recomend vel levar em considera o os seguintes itens a caso facilidades diferentes foram disponibilizadas em diferentes partes da hierarquia fornecer ao usu rio uma forma de compreender estas b se a facilidade de utilizar um atalho selecionando um texto ativo for disponibilizada diferencia o texto de sele o do texto normal que se encontra pr ximo ao mesmo c reunir alguns elementos no final dos t picos como por exemplo t picos com os seguinte t tulos T picos relacionados ou Veja tamb m d fornecer uma maneira para o usu rio retornar ao t pico de origem 49 2 4 22 INFORMA ES EXTR
34. documenta o as fontes s o impressas corretamente em todos os tipos de impressoras dispon veis para o usu rio e lesjo de Resposta Atende parcialmente Observa es Apresentou algumas irregularidades quando foi impresso em uma impressora HP 1520 Em duas outras impressoras EPSON 755 e uma LEXMARK 780e a impress o ficou dentro do esperado Avalia o Anterior Pr xima Avalia o Figura 23 Tela de consulta de avalia es Os relat rios s o gerados a partir do menu ou da barra de tarefas existem quatro tipos de relat rios dispon veis avaliadores perguntas avalia es e softwares Na Figura 24 pode se ver um exemplo de relat rio de avalia o Report Preview olx Fie Page Zoom aBS 44 pb Page fi fI A Am B Zoom O E Data 21 05 2004 SAQDS Relat rios de Avalia es Software Data Microsoft Photo Editor 3 0 1 2105 2004 Avaliador Anderson Nicolodelli Percentual de Conformidade Informa es Complementares Avalia o da documenta o on line help Categoria Informa es Gerais Documenta n e Resposta Atende Pergunta Est vare que a documenta da Observa es Documenta o es nl Resposta Atende Pergunta O n E r Observa es Documenta npres ni Resposta N o Atende Pergunta onde os usu rio sam encontrar Observa es N o foi evidenciado nenhuma informa o sobre como entrar em contato com o suporte Resposta N o Atende P
35. e se encontram dispon veis na maioria dos sistemas Antes de iniciar o projeto deve se ter em mente quais ser o os caracteres especiais que ser o utilizados Procure evitar o uso de caracteres visualmente parecidos como por exemplo o L I 1 eles podem confundir o usu rio Quando for selecionar fontes e tamanhos para serem utilizadas na documenta o on line deve se levar em conta os seguintes aspectos a a variedade de diferentes telas que a informa o ser exibida b a variedade de fontes que o sistema operacional do usu rio ter dispon vel dessa forma o mais aconselh vel utilizar fontes padr o j instaladas no sistema operacional c os diferentes tipos de ambiente que o documenta o estar em uso d a tradu o da documenta o o conjunto de caracteres requeridos para um linguagem espec fica por exemplo chin s devem estar dispon veis e o tamanho das fontes f para documenta o on line deve se selecionar o tamanho de modo que sua visualiza o fique clara Recomenda se que as letras mai sculas tenham pelo menos 3mm de altura g para documentos impressos deve se selecionar fontes em mai sculo de no m nimo 2 5mm de altura e em min sculo de no m nimo 2mm Esses tamanhos correspondem a fontes entre 9 e 11 dependendo do seu tipo h n o deve se utilizar mais que tr s tipos diferentes de fonte e lembre se de utiliz las consistentemente 1 t tulos utilize um tipo apenas para todos os t
36. entrar no software o primeiro passo a seguir realizar o cadastramento dos avaliadores na Figura 18 pode se ver a tela de cadastramento de avaliadores onde o mesmo realizado 71 S SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software efe aleje e leje B Figura 17 Tela principal do software BJ T S SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software SAQDS Cadastro dos Avaliad lol l x idriano da Silva Soares m T Rua das Palmeiras CACA T 41 5200 1250 es E m Figura 18 Tela de cadastro de avaliadores fas TOS EC o a Sao E O pr ximo passo cadastrar um software na Figura 19 pode se ver a tela de cadastro de softwares onde deve ser efetuado o cadastramento do mesmo 72 S SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software9 SAQDS Registro dos Softwares Ak E Q Macromedia Corporation Inc it T Ferramenta de anima o da Internet cacal T agan Figura 19 Tela de cadastro de softwares O pr ximo cadastramento caso o software possua alguma documenta o o cadastramento da documenta o que deve ser feito conforme Figura 20 que traz a tela de cadastramento de documentos SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software SAQDS Cadastro dos Docume olx l
37. es Resposta Atende Observa es Resposta Atende Observa es 138 02707 2004 Documenta o Impressa e On Line Pergunta A forma de escrever est cometa Documenta o Impressa e On Line Pergunta A gram tica est correta Documenta o Impressa e On Line Pergunta Os verbos est o empregados corretamente Documenta o Impressa e On Line Pergunta As instru es est o na forma imperativa Documenta o Impressa e On Line Pergunta A pontua o amp adequada Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Documenta o Impressa e On Line Pergunta O tamanho das frases amp vari vel Documenta o Impressa e On Line Pergunta A maioria das frases amp pequena e desimples compreens o Documenta o Impressa e On Line Pergunta A maicria dos verbos amp transitivo Documenta o Impressa e On Line Pergunta O texto dirigido ao leitor na segunda pessoa Documenta o Impressa Pergunta A escrita concisa Documenta o Impressa e On Line Pergunta As frases levam o usu rio a conhecer acque ele n o sabia Documenta o Impressa e On Line Pergunta Os paragrafos levam o usu rio a conhecer o que ele n o sabia Documenta o Impressa e On Line Pergunta O estilo adotado amp apropriado ao p blico alvo Documenta o Impressa e On Line Perg
38. mero Avenida Paulista 1560 de Estado Paulo Paulo Nome Telefone Adriano da Silva Soares 41 5200 1250 Endere o N mero Rua das Palmeiras 200 Cidade Estado Curitiba Paran Home Telefone Camila Magalh es 45 5623 3215 Endere o H mero Rua IX d Novembro 780 Cidade Estado Terezina Piaui Home Telefone Carlos da Silva 21 3256 3625 Endere o Rua das Palmeira 560 Cidade Estado Rio de Janeiro Rio de Janeiro 111 Os itens do menu e a barra de ferramentas possuem exatamente as mesmas funcionalidades na tabela abaixo segue a defini o de cada item da barra de ferramentas que se aplica ao menu tamb m Zoom 100 0 Abre um arquivo Rave Snapshot ndr Grava o relat rio num dos formatos dispon veis Imprime o relat rio atual Exibe a Primeira p gina do relat rio Exibe a p gina Anterior do relat rio Exibe a Pr xima p gina do relat rio Exibe a ltima p gina do relat rio Exibe a Localiza o atual conforme o n mero da p gina Aumenta o zoom do relat rio Diminui o zoom do relat rio Ajuda o zoom a Largura da P gina Exibe o zoom da P gina Inteira Personaliza o zoom do relat rio Encera o Report Preview 112 Suporte ao Usu rio Em caso de d vidas t cnicas operacionais ou quais outras favor entrar em contato com Anderson Nicolodelli atrav s do e mail andnicOinf furb br 113 FAQ Perguntas Feitas Frequentemente Como fazer par
39. o Impressa e On Line Pergunta As ilustra es s o utilizadas em lugares apropriados Documenta o Impressa e On Line Pergunta Os tipos de ilustra es s o adequados informa o Documenta o Impressa e On Line Pergunta As ilustra es s o simples e claras Documenta o Impressa e On Line Pergunta As ilustra es detipos similares s o consistentes entre si Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es P gina SAQDSO Relat rios de Avalia es Documenta o Impressa e On Line Pergunta As ilustra es s o completas Resposta Atende Observa es 130 Data 21 05 2004 Documenta o On Line Pergunta O sistema de janelas acomoda a informa o que o usu rio necessita Documenta o On Line Pergunta Existem tamanhos e cais padr es para as janelas Documenta o On Line Pergunta O usu rio pode redefinir o formato das janelas de informa o Documenta o On Line Pergunta Os tamanhos e cais pades para as janelas podem ser recuperados Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende parilmente Observa es Apenas de forma manual ou reinicializado a ajuda Documenta o On Line Pergunta Existem t picos similares exibidos em janelas com layouts similares Documenta o On Line Pergunta O layout
40. o RESULTADO_ACAO VARCHAR 250 Quadro 4 Detalhamento da tabela avalia o Data Type Mandar C digo do Documento CD DOCUMENTO INTEGER C digo do Software CD SOFTWARE INTEGER Data de Publica o DATA PUB DOCUMENTO DATE Atualiza o do Documento Descri o do Documento DESC DOCUMENTO VARCHAR 250 Nome do Documento NM PUB DOCUMENTO VARCHAR 250 Tipo do Documento TIPO DOCUMENTO VARCHAR 150 Quadro 5 Detalhamento da tabela documento Data Type Mandar Categoria da Pergunta CAT_PERGUNTA VARCHAR 250 C digo da Pergunta CD_PERGUNTA INTEGER Descri o da Pergunta DESC_PERGUNTA VARCHAR 250 Tipo da Pergunta TIPO_PERGUNTA VARCHAR 150 Quadro 6 Detalhamento da tabela pergunta Data Type Mandar C digo da Avalia o CD ACAO INTEGER C digo da Pergunta CD PERGUNTA INTEGER Coment rio da Resposta COM RESPOSTA VARCHAR 250 Op o da Resposta OP RESPOSTA VARCHAR 250 Quadro 7 Detalhamento da tabela resposta Data Type Mardan C digo do Software CD_SOFTWARE INTEGER Descri o do Software DESC SOFTWARE VARCHAR 250 Empresa do Software EMPRESA SOFTWARE VARCHAR 200 Nome do Software NOME SOFTWARE VARCHAR 150 Quadro 8 Detalhamento da tabela software Na Figura 16 apresentado o banco de dados desenvolvido na ferramenta Microsoft Access que ser utilizado para o armazenamento dos dados do software 70 5 Relacionamentos oi x A CD ACAO CD AvAL CD SOFTWARE OP RESPOSTA COM ACA
41. op es de reposta dispon veis 0a1lo N o se Aplica 106 C lculo do Percentual de Conformidade O C lculo do Percentual de Conformidade realizado conforme tabela a seguir Requisitos Valor Porcentagem Valor Notas Valor Atende 100 0 0 0 0 Atende 50 20 20 1 10 Parcialmente N o Atende 0 40 40 2 20 N o se Aplica 60 60 3 30 80 80 4 40 100 100 5 50 N o se Aplica 6 60 7 70 8 80 9 90 10 100 N o se Aplica A coluna valor apresenta o peso no c lculo de cada resposta conforme a m trica escolhida Em ambos os casos caso o valor selecionado seja N o se Aplica a pergunta n o far parte na estat stica final logo n o possui valor 107 Op es de Impress o de Relat rios Quando um Relat rio gerado atrav s do acionamento pelo menu principal ou pela barra de ferramentas uma janela de configura es com as seguintes op es ser apresentada a segue a defini o dos itens Em Report Destination voc encontra tr s op es a primeira se refere a impress o direta do relat rio gerado Printer nesse caso voc pode definir o n mero de c pias no item Option gt Copies Dependendo das funcionalidades da impressora configura como padr o no seu Sistema Operacional nesse caso espec fico aparecem mais duas op es Collate que agrupa as c pias e Duplex que realiza a impress o em frent
42. pelo e mail andnicOinf furb br informando o erro e a opera o que estava sendo realizada no ato do mesmo para que possamos fornecer o mais r pido poss vel uma solu o para o problema 117 Gloss rio ISO IEC Entidades internacionais de padroniza o ISO International Organization for Standardization IEC International Electrotechnical Commission Conformidade Significa atender a uma certa regra padr es estabelecidos est de acordo 118 SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software 119 AP NDICE B Check list APLICA O CHECK LIST DOCUMENTA O DE SOFTWARE 01 de 04 ON LINE IMPRESSA 1 Informa es Gerais X X 1 1 Est claro qual a vers o do software que a documenta o aborda X X 1 2 ___O nome do fabricante est devidamente identificado x x 1 3 A documenta o cont m informa es de onde os usu rios possam encontrar suporte quando necessitarem X X 1 4 Existe uma descri o da licen a de uso do software 2 Vis o Geral do Software X X 2 1 Existe uma vis o geral do software X X 2 2 A vis o geral do software explica sua aplica o X X 2 3 _A vis o geral do software descreve quais s o as fun es dispon veis para o usu rio X X 2 4 A vis o geral da softwa
43. que as ilustra es s oexibidas amp adequada Documenta o Impressa e On Line Pergunta As ilustra es podem ser visualizadas juntamente com o texto queas referenciam Documenta o Impressa e On Line Pergunta As linhas exibidas s o grassas o suficiente para serem notadas Documenta o Impressa e On Line Pergunta O texto da ilustra es amp grande o suficiente para ser compreendia pelos menes 3mm para letras mai sculas y Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es P gina 7 132 Data 21 05 2004 SAQDSO Relat rios de Avalia es Documenta o On Line Pergunta O usu rio pode imprimir as ilustra es Documenta o On Line Pergunta Existem reas de ativa o atalhos nas ilustra es claramente identificadas Documenta o On Line Pergunta Para documentos que necessitam serem impressos tanta as ilustra es linhas e textos s o impressos de forma cometa legivel Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Documenta o On Line Pergunta Os icones e os sinalizadores s o de f cil compreens o Documenta o On Line Pergunta Os gr ficos utilizados nos icones e sinalizadores s o claras Documenta o On Line Pergunta Os gr ficos utilizados nes icones e sinalizadores representam as objetos atuais as a es
44. que o usu rio necessita 28 2 Existem tamanhos e locais padr es para as janelas 28 3 O usu rio pode redefinir o formato das janelas de informa o 28 4 Os tamanhos e locais padr es para as janelas podem ser recuperados 29 Layout das Janelas 29 1 Existem t picos similares exibidos em janelas com layouts similares 29 2 Olayout das janelas apropriado para a informa o que ela exibe 29 3 Existe espa o em branco suficiente na janela de modo que n o pare a cheia demais 29 4 Os t tulos das janelas s o claros 29 5 Os controles das janelas s o devidamente apropriados 29 6 Existem t tulos dos t picos e controles contidos em reas onde n o possuem rolagem 30 Cores 30 1 As cores s o utilizadas de forma apropriada 30 2 As cores s o utilizadas de forma consistente x x x 30 3 Existem apenas poucas cores utilizadas 30 4 A apresenta o da aplica o trabalha em modo monogram tico 30 5 O usu rio pode modificar as cores da interface e de fundo da aplica o 30 6 Existe consist ncia de polaridade por exemplo texto escuro com fundo claro x x x x x x x x x x x x x xxx x x x x x x x x x x gt lt gt lt lt lt gt lt gt lt gt lt 30 7 O contrate entre as cores da interface e do fundo s o adequados x 30 8 No caso de impress o do documentos no modo monogram tico est fica clara para compreens o
45. simples compreens o x x x x x x x x x x x x x x x x x x x x x x x x x x x x x 26 3 A maioria dos verbos transitivo 121 APLICA O ON LINE IMPRESSA CHECK LIST DOCUMENTA O DE SOFTWARE 03 de 04 26 4 _O texto dirigido ao leitor na segunda pessoa 26 5 A escrita concisa 26 6 As frases levam o usu rio a conhecer ao que ele n o sabia 26 7 Os par grafos levam o usu rio a conhecer o que ele n o sabia 26 8 O estilo adotado apropriado ao p blico alvo 26 9 Otexto de f cil entendimento 26 10 Existem metas a serem alcan adas para as instru es 26 11 Existem pr requisitos no come o da execu o de alguma instru o 26 12 Em se tratando da hifeniza o ela utilizada quando necess rio para evitar mal entendimento 26 13 Consegue se distinguir os tipos de mensagens exibidas 26 14 Clich s s o evitados 26 15 Palavras ou letras em letra mai scula s o utilizadas de forma adequada 27 Ilustra es 27 1 As ilustra es s o utilizadas em lugares apropriados 27 2 Os tipos de ilustra es s o adequados informa o 27 3 As ilustra es s o simples e claras 27 4 As ilustra es de tipos similares s o consistentes entre si x x x x x x x x x x x x x x x x x 27 5 As ilustra es s o completas 28 Janelas 28 1 O sistema de janelas acomoda a informa o
46. t cnicos por exemplo se um termo t cnico for utilizado como nome de um campo deixe claro o seu significado e sempre o utilize para o campo em quest o agrupar todos os termos com suas defini es em um cap tulo separado como por exemplo um gloss rio caso a defini o do termo estiver contida no texto em quest o essa defini o deve ser igual em todas as utiliza es do termo n o utilizar jarg es ou coloquialismo Mantenha as defini es o mais simples poss veis os leitores podem n o estar lendo as defini es em sua l ngua de origem logo isso requer um aten o especial no uso de palavras mais simples e comuns aos usu rios de uma forma geral se houver necessidade da compreens o pelo usu rio de algum termo antes da utiliza o da documenta o notifique os usu rios onde possam encontrar tal defini o como por exemplo num gloss rio em termos e defini es ou termologias 37 2 4 6 CONCEITOS Como existem grandes diferen as em rela o aos conceitos do que o usu rio precisa ou qual a informa o que ele quer n o poss vel sugerir um guia espec fico todavia recomenda se a utiliza o dos princ pios a deve se fornecer a cada conceito um t tulo ou cabe alho indicando claramente sua abrang ncia b caso um conceito fizer refer ncia a uma fun o em particular do software ou especificar uma tarefa permita que o usu rio fa a um liga o com a informa o que trata dessa fun
47. tipos de atalhos claramente distinguidos 19 2 Os atalhos s o apropriados 19 3 Todos os atalhos s o necess rios 19 4 Os atalhos levam aos locais corretos 19 5 Os atalhos s o suficientes 20 Sequ ncia da Informa o 20 1 E poss vel navegar atrav s da informa o em uma sequ ncia x x x x x x x x 20 2 O usu rio tem a possibilidade de voltar bem como de ir a adiante na navega o 20 3 Os assuntos s o apresentados em uma segu ncia l gica em cada documento 20 4 A seg ncia da informa o de cada parte do documento corresponde ao modo que os usu rios precisar utiliz la 21 Rolagem 21 1 Tanto o texto quanto os gr ficos possuem a velocidade de rolagem adequada x x 21 2 Quando da rolagem os t tulos continuam sendo exibidos 21 3 Existe um sinalizador que indica a posi o do usu rio em rela o ao final de um t pico quando o mesmo estiver realizando a rolagem do texto 22 Numera o 22 1 Para documentos divididos em volumes os volumes est o claramente classificados 22 2 Para documentos divididos em partes as partes est o numeradas 22 3 Os cap tulos ou se es est o claramente numerados ou classificados de uma maneira apropriada 22 4 O n mero da p gina de cada volume ou de cada parte deixa claro a qual volume ou parte ele pertence 22 5 O m todo de numera o adotado adequado para o tipo de documento
48. 22 6 A numera o das p ginas est clara 22 7 O m todo de numera o das p ginas consistente com o m todo de numera o das se es 22 8 A numera o das se es est clara 22 9 Existem ilustra es que s o referenciadas no texto numerado 22 10 Existem tabelas que s o referenciados no texto numerado x x x x x x x x x x x 22 11 Existem p ginas preliminares numeradas em uma seg ncia separada do resto do documento 23 Refer ncia Cruzada 23 1 Existe refer ncia cruzada entre documentos separados 23 2 Existe refer ncia cruzada suficiente entre as se es que contem informa es relacionadas 23 3 A refer ncia cruzada apropriada 23 4 A refer ncia cruzada necess ria 23 5 A refer ncia cruzada de f cil localiza o 24 Vocabul rio 24 1 Os termos e abreviaturas est o definidos onde h necessidade 24 2 Os termos s o utilizados com consist ncia 24 3 O vocabul rio apropriado ao p blico alvo 24 4 A maioria das palavras nos vocabul rios s o simples e f cil compreens o 25 Gram tica 25 1 A forma de escrever est correta 25 2 A gram tica est correta 25 3 Os verbos est o empregados corretamente 25 4 As instru es est o na forma imperativa 25 5 A pontua o adequada 26 Estilo 26 1 O tamanho das frases vari vel 26 2 A maioria das frases pequena e de
49. 4 9 CONTE DO PERSONALIZADO PELO USU RIO Se a tecnologia permitir e se a an lise do sistema demonstrar que necess rio deve ser prover ao usu rio a facilidade de adicionar seu pr prio conte do a documenta o on line Essa facilidade pode ir desde acrescentar uma simples nota a um texto existente at promover um atalho a informa es personalizadas pelo pr prio usu rio Para os softwares utilizados em rede por diversos usu rios pode se destacar as seguintes categorias de personaliza o da informa o a global que pode ser vista por todos os usu rios b grupo que pode ser vista por um grupo espec fico de usu rios c local que pode ser vista somente pelo usu rio que a criou Em todos os casos importante garantir que a um usu rio n o possa apagar informa es adicionadas por outro usu rio b erros possam ser corrigidos c a informa o original possa ser restaurada Tenha especial aten o quando da atualiza o do software para que a informa o que o usu rio adicionou n o seja simplesmente descartada Quando poss vel deve ser manter as informa es personalizadas pelo usu rio em caso de impossibilidade deixe essa situa o clara para o mesmo 2 4 10 NAVEGA O Geralmente os usu rios v em cada t pico isoladamente todavia quando um t pico exibido deve ser fornecer aos usu rios uma rota para encontrar outros t picos tais como a um n vel mais baixo de detalhe em um m
50. 50 pixels wide 500 pixels deep Text area 420 pixels wide by 450 pixels deep Fonte adaptado de ISO IEC International Organization For Standardization International Electrotechnical Commission 2004 p 88 Figura 12 Exemplo de sobreposi o de janelas 54 24 28 22 LAYOUTS E GRIDS Os layouts s o estruturas onde as informa es ficam dispostas por exemplo pode se definir um layout como apresentando ilustra es sempre no canto inferior direito da tela e o texto ao seu redor Os grids s o reas dispostas nos layouts que ajudam a organizar a informa o 2 4 28 2 1 GRIDS importante desenhar um grid para cada tipo de documenta o on line afim de posicionar todos os elementos requeridos na janela adicionalmente deve se levar em considera o os seguintes aspectos a qualquer t tulo de t pico b controle das janelas bot o de fechar maximizar e minimizar janelas c controles de navega o barras de rolagem d rea da informa o e espa o em branco f reas que possuem e que n o possuem rolagem g sinalizadores que indicam onde a informa o se encontra no t pico h localiza o das anota es 1 posi o das ilustra es Caso o usu rio tiver a possibilidade de redimensionar as janelas deve se fazer o planejamento na hora em que se estiver implementando a parte do design o que poder ocorrer com os seguintes elementos na hora do redimensionamento a r
51. AS Os usu rios podem necessitar de informa es extras sobre alguma informa o como por exemplo a defini o de um termo nesse caso importante fornecer um mecanismo que possa mostrar tal informa o temporariamente ou ainda onde o usu rio possa encontrar detalhes sobre a informa o em quest o como por exemplo num gloss rio independente de termos Adicionalmente recomend vel levar em considera o os itens a evitar que o usu rio tenha que acessar um atalho que o tire da tela de informa o atual para visualizar uma de informa o extra Todavia se caso isso for inevit vel deve se fornecer um meio r pido e f cil para que ele possa retornar ao t pico de origem b garantir que o m todo utilizado para exibir essa informa o extra seja claramente diferente do m todo utilizado para interligar t picos diferentes Dessa forma evitar com que o usu rio possa se confundir entre os dois m todos 2 4 23 NAVEGANDO PELAS INFORMA ES Na navega o pelas informa es importante providenciar v rios meios de navega o como por exemplo navegar para apreender sobre novos assuntos visualizar a informa es dispon veis etc Quando poss vel deve se leve em considera o os itens a exibir a estrutura hier rquica da informa o e permitir que o usu rio possa selecionar o caminho b fornecer um caminho padr o para navega o nos t picos c em cada t pico incluir detalhes sobre t picos relaciona
52. Campo onde deve ser cadastrado a Categoria Documenta o Campo onde deve ser selecionado a aplica o da pergunta em quest o existem tr s op es dispon veis On Line Impressa Impressa e On Line E SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software SAQDS Cadastro das Pergunt ES TA Cadastros Avalia o Relat rios Ajuda laj x eljesjesol G e Ei Pergunta E st claro qual a vers o do software ao qual a documenta o aborda Categoria informa es Gerais Documenta o impressa e On Line 99 Cadastro de Softwares Nessa janela realiza se o Cadastramento de Softwares A seguir defini se todos os campos Empresa Campo onde deve ser cadastrado a Empresa Nome Campo onde deve ser cadastrado o nome do Software Descri o Campo onde deve ser cadastrado informa o sobre o Softwares r f SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software SAQDS Registro dos Softwares P E3 W Cadastros Avalia o Relat rios Ajuda Empresa Microsoft Nome Microsoft word xP Descri o Editor de Texto elx lellei lelles or 100 Cadastro de Documentos Nessa janela realiza se o Cadastramento de Documentos A seguir defini se todos os campos Software Campo onde deve ser escolhido um Software dentre os j cadastrados Nome Campo onde deve ser cadastrado o nome do Documento Descri
53. DS es a SSI 54 TAIRI GRIDS oA ERTE E GOE EEEE O E GIERE REGIEN 54 2 4 28 2 2 REA DA INFORMA O ssa tesao door oca app 54 2 4 28 2 3 LOCALIZA O DAS ILUSTRA ES ienes 55 2 4 28 2 4ESPA OS EM BRANCO cu ainsi es Spa iea aa boi Ra A rr Doado a da aaa 55 24 283 T TULOS E CAMINHOS tierra eeteeeeereeeee reter eee 55 24284 CONTROLES DE NAVEGA O susana ss gaba s OSSO 55 24 28 5 REAS DE N O ROLAGEM eeameseaeaserseaeeesearese meneame rrereenennas 55 2 4 28 6 UTILIZA O DAS CORES ss sa pasa e opa a pass ndo ps lg 56 2 4 28 6 1 PERSONALIZA O DE CORES eme 56 242862 PALETA DE CORES susasiaisiiatalo mafia dh RAN Rd 57 2 4 28 6 3CORES DE FUNDO E DA APLICA O 57 2 4 28 6 4DESIGN MONOCROM TICO meme eee eee 57 24086 SNUMERO DE CORES ss css censios fersoeafaa o serasa Opa a 57 2 429 APRESENTA O DO TEXTO emeeereemenereeemeemeeeeeemenreneres 57 24007 FONTES E TAMANHOS ss SA pe ren 58 24292 UTILIZA O DE NEGRITO E IT LICO ienes 59 24 293 LINHAS DO TEXTO sussa e od is a 59 2 4 29 4 ESPA AMENTO VERTICAL ou atrasar ga gerada Sea ara 60 2400 T TULOS EMITE RO qdo ariana a 60 24 29 6 DESTAQUES DE TEXTO emeeeneseeemmerresermeeeeserseeemeererseea 60 24297x LISTAS usinas cad a a AR o i 61 DADOR CTA DELAS nais ir paga aaa a a a 61 DADO O CAIXAS E BORDAS aan tis ia bata rod ds abas sato do 62 24 29 10 REPRESENTANDO A INFORMA O EXIBIDA PELO SOFTWARE
54. Existem ap ndices ou anexos utilizados apropriadamente para referenciar informa es extensas Documenta o On Line Pergunta Esta claro que tipo de informa o amp exibida Documenta o On Line Pergunta Cada t pico possui um titulo adequado Documenta o On Line Pergunta O usu rio podem voltara um t pico anterior Documenta o Impressa Pergunta Est claro que tipo de informa o est contida em cada se o Documenta o Impressa Pergunta Cada se o possui um titulo adequado Documenta o Impressa e On Line Pergunta O usu rio pode encontrar o melhor ponto de partida para suas necessidades Documenta o On Line Pergunta Existem diferentes tipos de atalhos claramente distinguidas Documenta o On Line Pergunta Os atalhos s o apropriados Documenta o On Line Pergunta Todos os atalhos s o necess rios Documenta o On Line Pergunta Os atalhos levam aos locais corretos Documenta o On Line Pergunta Os atalhos s o suficientes Documenta o On Line Pergunta possivel navegar atrav s da informa o em uma sequ ncia Resposta Atende Observa es Resposta Atende Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es Resposta Atende Observa es Resposta N o Atende Obser
55. N LINE importante criar diferentes m todos de acesso para usu rios acessarem informa es apropriadas para diferentes tipos de informa o adicionalmente considere o contexto de uso e determine o melhor m todo de acesso Selecione um m todo de acesso adequado e consistente das tecnologias que j vem sedo utilizadas Deve se considerar o m todo contexto sensitivo para informa es sobre a o campo atual b a tarefa atual 41 c a fun o atual por exemplo uma caixa de di logo transa o ou comando d a mensagem atual e um objeto na interface do usu rio Caso n o seja poss vel determinar o contexto em que o usu rio necessita de ajuda considere selecionar um dos citados e garanta que o usu rio tenha f cil acesso a escolha de outras informa es Se a informa o for contexto sensitiva a exibir qualquer item espec fico com o contexto b exibir a informa o relevante no topo da rea de informa o pois essa a primeira informa o que o usu rio v se a informa o for parte de um t pico longo A Tabela 6 traz alguns exemplos de m todos de acesso que podem ser adequados a diferentes tipos de informa o Tabela 6 Exemplo de m todos de acesso Tipos de informa o M todo de acesso Descri o da tarefa para a tarefa atual Descri o da fun o para a fun o atual Explica o da mensagem atual Pressione uma tecla especial Clicar no bot o o
56. O COM RESPOSTA NOME AVAL END AVAL NUMERO END AVAL CIDADE AVAL DATA ACAO BAIRRO AVAL RESULTADO ACAO CEP AvAL SOFTWARI TELEFONE AvAL 1 ESTADO Av L CD SOFTWARE NOME SOFTWARE DESC DOCUMENTO DESC SOFTWARE TIPO DOCUMENTO EMPRESA SOFTWARE DATA PUB DOCUMENTO NM PUB DOCUMENTO Figura 16 Tabelas no Access 3 8 OPERACIONALIDADE No desenvolvimento do software para auxiliar na avalia o da qualidade da documenta o de software foi utilizado a programa o procedural no ambiente de programa o Visual Borland Delphi 7 da Inprise Corporation com a linguagem de programa o Object Pascal Para a cria o do banco de dados foi utilizado o Microsoft Access vers o 2000 da Microsoft Corporation Na cria o dos arquivos de documenta o on line foi utilizado o RoboHelp Office X5 da Macromedia Corporation Inc 3 8 1 FUNCIONALIDADE DO SOFTWARE Para exemplificar melhor a funcionalidade do software de avalia o da documenta o de software s o apresentados os passos que deve se seguir na sua utiliza o mais detalhes sobre o software poder o ser obtidos no Ap ndice A que traz o manual do usu rio Na Figura 17 pode se ver a tela principal do software nela o avaliador tem acesso a todas as fun es do mesmo As fun es podem ser acessadas de duas formas atrav s de um menu localizado na parte superior do software ou atrav s de uma barra de ferramentas localizada na parte esquerda do software Ap s
57. RAW 11 Es Criar um logotipo mostra como criar um logotipo no CorelDRAW 11 SE Trabalhar com layout mostra como realizar o layout de texto e gr ficos para criar um an ncio no CorelDRAW 11 SE Criar um bot o de efeito de ativa o mostra como criar um bot o de efeito de ativa o para a Web no CorelDRAW 11 1 Figura 8 Exemplo da explora o da informa o atrav s de links S Meu computador A E Conclu do 2 4 8 PERGUNTAS FEITAS FREQ ENTEMENTE FAQ O FAQ consiste em elaborar uma base de tipos de perguntas que os usu rios possam querer respostas sobre a aplica o essa base geralmente poupa tempo do suporte ao usu rio Na elabora o de um FAQ importante considerar os itens a agrupar a informa o convenientemente de modo que o usu rio possa encontrar o t pico que lhe interessa sem ter que olhar um n mero grande de quest es 39 irrelevantes Por exemplo agrupe as quest es de acordo com a parte da aplica o que elas tratam ou de acordo com as tarefas que os usu rios ir o realizar b responder as quest es especificamente e de modo abrangente deve se prover acesso ou referenciar toda a informa o que o usu rio precisar Por exemplo aconselhe o usu rio de como proceder para ajustar o tamanho da p gina diga a ele qual a fun o que ser necess ria e quais s o os detalhes que ele precisar configurar ou forne a um atalho para a informa o apropriada 2
58. ROMEDIA CORPORATION INC Help RoboHelp Office X5 San Diego Macromedia 2004 MCT MINIST RIO DA CI NCIA E TECNOLOGIA Qualidade e produtividade no setor de software brasileiro Brasil 2001 NAYAR Pawan Tem misconceptions about software documentation Intercom Bel Air p 21 29 mai 2000 PALADINI E Pacheco Qualidade total na pr tica implanta o e avalia o de sistemas de qualidade total S o Paulo Atlas 1994 REZENDE Denis Alcides Engenharia de software empresarial Rio de Janeiro Brasport 1997 SILVA Dem trius Domingos Wolff An lise comparativa entre ambientes Oracle relacional vers o 7 Oracle objeto relacional vers o 8 utilizando padr es da norma ISO IEC 9126 1999 81 f Relat rio de est gio supervisionado Bacharelado em Ci ncias da Computa o Centro de Ci ncias Exatas e Naturais Universidade Regional de Blumenau Blumenau SOMMERVILLE Ian Software engineering Reading USA Addison Wesley 1992 82 STANGE Pl nio Sobre o gerenciamento da produ o orientado para a qualidade total da empresa com base na fun o perda de Taguchi Apostila da disciplina de Engenharia da Qualidade Departamento de Engenharia da Produ o e Sistemas UFSC Universidade Federal de Santa Catarina Florian polis 1996 WOHLGEMUTH Eduardo Germano How the new ISO 9001 2000 interpretation process works ISO Management systems Geneza v 3 n 6 p 12 14 nov 2003 AP NDICE A Manual do usu rio
59. T TULOS E CAMINHOS Sempre que for poss vel procure exibir de forma consistente os t tulos e caminhos atalhos nas janelas Quando o usu rio tiver a necessidade de navegar entre t picos deve se indicar qual o t pico atual na estrutura permita tal recurso na estrutura do grid 2 4 28 4 CONTROLES DE NAVEGA O E recomend vel a utiliza o dos mesmos nomes e da mesma localiza o dos controles de navega o para os mesmos tipos de situa o onde s o utilizados 2 4 28 5 REAS DE N O ROLAGEM Quando for poss vel deve se exibir os itens a seguir em reas de n o rolagem a t tulo do t pico no caso de uma janela da Internet esse t tulo pode ser exibido no t tulo da barra b controles de navega o para navegar a outros t picos no caso de uma janela de Internet esses controles podem estar num quadro que n o possua rolagem 56 c atalhos para T picos Relacionados ou Exemplos onde o usu rio possa ter acesso a outros t picos 2 4 28 6 UTILIZA O DAS CORES As cores ajudam a chamar a aten o do usu rio para determinadas situa es quando da sua utiliza o importante levar em considera o os seguintes aspectos a n o deve se utilizar apenas cores para conduzir algum significado sempre utilize mais algum sinalizador uma palavra cone ou ilustra o b utilizar as cores apenas para dar nfase em determinado item por exemplo um certo texto em um gr fico ou em um atalho rel
60. TF Plain Text TXT Clicando na figura do disquete se abre uma janela onde deve ser escolhido o local e fornecido o nome para gera o do arquivo do relat rio Salvar como 2 x Salvar em a DISCO LOCAL D o E ER E Compet ncias Inetpub Diversos CO Intraweg Documentos Pessoal Exchange TP Figuras 3 10 Misconceptior Fotos TE 266434 1 1 pdt GED T Manual SGO IS Geral Gr ficos Hist rico amp Desktop Meu computa E ad a Nome do arquivo avaliadores pol Salvar como tipo Adobe Acrobat PDF bd Cancelar 109 Basta clicar em Salvar e depois em OK para gerar o arquivo Output Options e Ele provasmiores por Pd Aroa POP E Selecionado a op o Preview uma nova janela se abrir com a visualiza o do relat rio gerado Output Options Mais informa es sobre o Preview podem ser encontradas no cap tulo Report Preview 110 Report Preview O Report Preview uma janela acionada a partir do Output Options gt Preview quando da solicita o de gera o de um relat rio Report Preview lej x SUGA gt Pef n AA m B nomfno A SAQDS Relat rios de Avaliadores Home Telefone Anderson Nicolodelli 47 372 3668 Endere o H mero 1605 e o A Bairro Rua Exp Ant nio Carlos Ferreira Vila Lenzi Cidade Estado Jaragu do Sul Santa Catarina Home Telefone Ana Maria Braga 11 2360 3200 Endere o H
61. UNIVERSIDADE REGIONAL DE BLUMENAU CENTRO DE CI NCIAS EXATAS E NATURAIS CURSO DE CI NCIAS DA COMPUTA O BACHARELADO SOFTWARE PARA AUXILIAR NA AVALIA O DA QUALIDADE DA DOCUMENTA O DE SOFTWARE ANDERSON NICOLODELLI BLUMENAU 2004 2004 1 01 ANDERSON NICOLODELLI SOFTWARE PARA AUXILIAR NA AVALIA O DA QUALIDADE DA DOCUMENTA O DE SOFTWARE Trabalho de Conclus o de Curso submetido Universidade Regional de Blumenau para a obten o dos cr ditos na disciplina Trabalho de Conclus o de Curso II do curso de Ci ncia da Computa o Bacharelado Prof Dr Carlos Eduardo Negr o Bizzotto Orientador BLUMENAU 2004 2004 1 01 SOFTWARE PARA AUXILIAR NA AVALIA O DA QUALIDADE DA DOCUMENTA O DE SOFTWARE Por ANDERSON NICOLODELLI Trabalho aprovado para obten o dos cr ditos na disciplina de Trabalho de Conclus o de Curso II pela banca examinadora formada por Presidente Prof Dr Carlos Eduardo Negr o Bizzotto Orientador FURB Membro Prof Dr Oscar Dalfovo FURB Membro Prof Dr Fabiane Barreto Vavassori Benitti FURB Blumenau 28 de Junho de 2004 Dedico este trabalho a todos os amigos especialmente aqueles que me ajudaram diretamente na realiza o deste Dedico tamb m aos meus pais e a minha irm pelo apoio que sempre deram Os bons livros fazem sacar para fora o que a pessoa tem de melhor dentro dela Lina Sotis Francesco Moratti AGRADECIMENTOS
62. a o Delphi pode se ressaltar a descendente da linguagem de programa o pascal b programa o orientada a objetos e baseada em eventos c linguagem compilada e n o interpretada d conectividade atrav s de ODBC e padr o SQL em banco de dados e gera o de relat rios de forma r pida RAVE 3 3 2 RECURSOS O Delphi cont m um conjunto de recursos que vai desde seus criador de formul rios Form Designer passando pela programa o voltada a WEB e chegando ao o suporte transparente a todos os formatos mais comuns de banco de dados Alguns dos principais recursos segundo Cant 1996 a componentes reutiliz veis e aplic veis b suporte a OCX c modelos de aplicativos e de formul rios d ambiente personalizado de desenvolvimento e recursos eficientes de acesso a dados f cria o de bibliotecas de fun es as DLL s 3 4 ROBOHELP OFFICE X5 Segundo Macromedia Corporation Inc 2004 o RoboHelp Office X5 uma ferramenta de desenvolvimento de ajuda ele se integra a v rias vers es do processador de texto Microsoft Word para facilitar a elabora o dos arquivos tamb m possui um painel de controle que organiza os t picos e disponibiliza v rias fun es que podem ser utilizadas no arquivo de ajuda A compila o do arquivo de ajuda pode ser gerada para HTML Flash WinHelp vers es 3 4 e 2000 e Java 3 5 DIAGRAMA DE CONTEXTO 67 Na Figura 13 apresentado o diagrama de contexto Nele
63. a Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Docum enta o Impressa e On Line Pergunta Existe uma vis o geral do software Documenta o Impressa e On Line Pergunta A vis o geral do software explica sua aplica o Documenta o Impressa e On Line Pergunta A vis o geral do software descreve quais s o as fun es disponiveis para o usu rio Documenta o Impressa e On Line Pergunta A vis o geral da software aboia a estrutura da documenta o Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta N o Atende Observa es Categoria Descri odas Tarefas Documenta o Impressa e On Line Pergunta Existe uma descri o de cada tarefa queo usu ria possa utilizar Documenta o Impressa e On Line Pergunta Existe uma descri o das tarefas que est o agrupadas dentro dos processos Resposta Atende Observa es Resposta N o Atende Observa es Documenta o Impressa e On Line Pergunta Tedes os campes de entrada de informa o da software est o devidamente explicados Documenta o Impressa e On Line Pergunta Todas as op es das campos de entrada de informa o est o claras Documenta o Impressa e On Line Pergunta As informa es sobre os diferentes tipos de campos de entrada da informa o estockhras Resposta Atend
64. a Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es P gina 9
65. a Os par grafos levam o usu rio a conhecer o que ele n o sabia Documenta o Impressa e On Line Pergunta O estilo adotado amp apropriado ao p blico alvo Documenta o Impressa e On Line Pergunta O texto de f cil entendimento Documenta o Impressa e On Line Pergunta Existem metas a serem alcan adas para as instru es Documenta o Impressa e On Line Pergunta Existem pr requisitos nocome a da execu o de alguma instru o Documenta o Impressa e On Line Pergunta Em setratando da hifeniza o ela amp utilizada quando necess rio para evitar mal entendimento Documenta o Impressa e On Line Pergunta Consegue se distinguir os tipos de mensagens exibidas Documenta o Impressa e On Line Pergunta Clich s s o evitados Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta N o se aplica Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Documenta o Impressa e On Line Pergunta Palavras ou letras em leta mai scula s o utilizadas de forma adequada Categoria Ilustra es Resposta Atende Observa es Documenta
66. a cadastrar um Avaliador Voc deve ir at o cap tulo de Cadastro de Avaliadores onde est se encontra a explica o para essa pergunta Como fazer para cadastrar um Software Voc deve ir at o cap tulo de Cadastro de Softwares onde est se encontra a explica o para essa pergunta Como fazer para cadastrar Documentos Voc deve ir at o capitulo de Cadastro de Documentos onde est se encontra a explica o para essa pergunta lembrando que um software pode ter v rios documentos cadastrados Como fazer para cadastrar Perguntas Voc deve ir at o cap tulo de Cadastro de Perguntas onde est se encontra a explica o para essa pergunta Como fazer para registrar uma nova Avalia o Voc deve ir at o cap tulo de Registro de Avalia es onde est se encontra a explica o para essa pergunta Como fazer para consultar uma Avalia o Voc deve ir at o cap tulo Consulta de Avalia es onde est se encontra a explica o para essa pergunta Como fazer para apagar Avalia o Na janela de Consulta de Avalia es existe um bot o para esse fim basta clicar nele que a Avalia o atual ser exclu da do sistema Posso fazer a mesma avalia o de um Software Pode sim apenas se preocupe em informar a data correta sempre para poder se organizar melhor na hora de identificar qual foi a primeira avalia o feita e as subsequentes Como fa o para gerar um relat rio e enviar por e mail Para gerar um r
67. a documenta o ou j s o de uso familiar da usu rio Documenta o Impressa e On Line Pergunta A terminokbgia utilizada amp consistente Data 2102004 Percentual de Conformidade 87 90 Resposta Atende Observa es Resposta Atende Observa es Resposta N o Atende Observa es N o foi evidenciado nenhuma informa o sobre comaentrar em contato com suporte Resposta N o Atende Observa es Resposta Atende Observa es Resposta N o Atende Observa es Resposta N o Atende Observa es Resposta N o Atende Observa es Resposta Atende parcialmente Observa es Existea descri o apenas para as tarefas principais Resposta N o Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es P gina 1 126 Data 21 05 2004 SAQDSO Relat rios de Avalia es Docum enta o Impressa e On Line Ee Todos s conceitos importantes est o explicados Docum enta o Impressa e On Line sm Existem informa es de como explorar recursos avan ados do software Docum enta o Impressa e On Line Pergunta A documenta o responde peuntas que os usu rios possam ta Documenta o Impressa e On Line Pergunta Existe algu
68. a linha deve se garantir que as linhas sejam grossas o suficiente para serem claramente visualizadas pelo usu rio em caso de utilizar linhas com texto n o as deixa t o grossas a modo de tirar a aten o do usu rio b fonte e tamanho do texto utilizar o mesmo padr o da documenta o on line c tamanho de flechas e conectores selecione um tamanho apropriado de modo que o mesmo ressalte o que se deseja d sombreado utilizar apenas quando for necess rio destacar algum objeto ou local da ilustra o evite o uso apenas para fins decorativos e apresenta o do t tulos utilizar t tulos nas ilustra es acima ou abaixo delas tente utiliz lo em consist ncia aos t tulos das tabelas 65 3 DESENVOLVIMENTO DO SOFTWARE Neste cap tulo s o mostrados os aspectos principais relacionados ao desenvolvimento do software 3 1 AMBIENTE DE DESENVOLVIMENTO Para a especifica o do software foi utilizada a ferramenta CASE Power Designer 9 para a implementa o do mesmo utilizou se o ambiente de desenvolvimento Delphi 7 para a elabora o da ajuda on line o software utilizado foi o RoboHelp Office X5 e para o banco de dados foi utilizado o Microsoft Access 2000 3 2 POWER DESIGNER O Power Designer uma ferramenta CASE voltada para a modelagem de aplica o modelagem de dados e processos de modelagem de databases Dispon vel para v rias plataformas de comunica o entre elas o Windows o Power Designer perm
69. acionado c n o deve se utilizar cores arbitrariamente a considerar o efeito que a cor poder causar aos olhos do usu rio b n o deve se citar os nome das cores na tela alguns usu rios podem estar utilizado a aplica o no modo monocrom tico ou terem configura es de cores personalizadas c fornecer uma mapa de cores e qual ser sua utiliza o na documenta o d tanto a documenta o on line quanto a documenta o impressa devem seguir o mesmo padr o de cores e teste qual a melhor combina o de cores para determinada informa o f considerar interpreta es culturais na escolha das cores g impress es coloridas podem ser caras desta forma deve se estudar um modo de reduzir as cores na documenta o impressa quando poss vel h assegure se de quais as cores que ir o ser impressas tanto no modo colorido como no modo monocrom tico 2 4 28 6 1 PERSONALIZA O DE CORES Quando for poss vel aconselh vel permitir ao usu rio a facilidade de mudan a das cores de fundo e da interface da aplica o tamb m deve se disponibilizar a possibilidade de retornar as cores padr o da aplica o 57 2 4 28 6 2 PALETA DE CORES E recomend vel utilizar apenas as cores definidas no mapa de cores da documenta o para que as cores da documenta o impressa sejam as mesmas que aparecem na documenta o on line 2 4 28 6 3 CORES DE FUNDO E DA APLICA O E importante utilizar cores s lidas de f
70. ada um tecla ou selecionada uma outra janela b se a informa o for necess ria apenas temporariamente deve ser remov la quando o usu rio for para o pr ximo passo na aplica o desse modo o usu rio n o precisar executar quaisquer comando para fechar a janela de ajuda como por exemplo uma janela pop up ou uma linha de informa o de texto em uma posi o padr o na tela Quando a informa o e aplica o necessitarem ser exibidas simultaneamente na tela deve se observar os seguintes itens a fornecer telas tanto para a aplica o quanto para a documenta o b exibir ambas as telas que forma que sejam perfeitamente vis veis c fornecer uma maneira simples de se alternar entre uma janela e outra d disponibilizar a mesma informa o em documentos impressos 2 4 28 1 2 JANELAS SIMULT NEAS Quando v rias janelas tiverem que ser exibidas ao mesmo tempo na tela deve se levar em considera o os seguintes aspectos a a informa o de cada janela segue os padr es citados at agora b o usu rio poder visualizar a informa o mais relevante em cada janela c o t tulo de cada janela se encontra totalmente vis vel 2 428 1 3 JANELAS PADR ES E recomendado utilizar uma disposi o fixa das janelas somente se tiver conhecimento exato de quantas janelas o usu rio necessitar ao mesmo tempo e exatamente quanta e qual informa o ser requerida em cada janela Caso isso n o se aplique deve se desen
71. adores ou mecanismo de busca avan ado deve se disponibilizar informa es de como utiliz los 2 4 4 3 DESCRI O DE PROCESSOS Geralmente um usu rio realiza os processos individualmente mesmo assim aconselh vel explicar com abrang ncia os mesmos de modo que ajude o usu rio na sua execu o importante utilizar se da descri o dos processos para responder perguntas como por exemplo O que devo fazer agora Porque estou fazendo isso e O que acontece agora Caso o usu rio tenha que executar diferentes processos em diferentes momentos deve se deixar claro qual processo deve ser executado em cada momento por exemplo qual processo deve ser executado para realizar a impress o ap s um processo de cadastramento de dados As tarefas que s o executadas por diversos usu rios devem conter a identifica o dos usu rios que as realizaram bem como informa es de quais ser o os pr ximos usu rios que realizar o as tarefas seguintes de um processo Os diagramas s o de grande ajuda na descri o dos processos assim importante garantir que toda a informa o necess ria esteja inclusa no diagrama e que todos os usu rios possam visualizar o diagrama completo de cada processo de um s vez Para alguns produtos deve se incluir a descri o dos processos 29 2 4 4 4 DESCRI O DE TAREFAS A descri o de tarefas responde quest es como Como eu fa o isso Eu preciso fazer isso e Es
72. ar em considera o os itens a utilize apenas termologias que os usu rios possam compreender b seja consistente com as palavras e frases para condi es similares Providencie um guia para os desenvolvedores afim de garantir a mesma termologia utilizada na interface com usu rios mensagens e documenta o c evite frases que possam culpar erros dos usu rios d n o demonstre que a aplica o ou o hardware pode pensar ou que tem algum tipo de sentimento 36 e evite o uso da express o por favor 2 4 5 DEFINI ES DE TERMOS As defini es de termos respondem a quest es dos usu rios como por exemplo O que isso significa e O que isso Na Figura 6 pode se observar um exemplo de defini o de termo Contato Uma pessoa que se encontra cadastrada no banco de dados de contatos da nossa empresa Ela associada a um cliente Fonte adaptado de ISO IEC International Organization For Standardization International Electrotechnical Commission 2004 p 70 Figura 6 Exemplo de defini o de um termo Quando da defini o de termos importante levar em considera o os itens a b c d e 8 h que os termos que ser o utilizados sejam familiares ao usu rio e que o significado possa estar atrelado ao mesmo construir uma lista de termos onde cada defini o possa ser inclu da diferenciar os termos que s o aplicados ao software aqueles que s o termos
73. as informa es que geralmente o usu rio necessita que estejam dispon veis na forma impressa tais como a vers o nome da empresa e demais informa es do produto afim de que o usu rio possa identific lo b instru es de como manusear o produto c especifica es t cnicas o equipamento necess rio para rodar o software ambiente entre outros d instru es para configura o do equipamento para rodar o software e instru es de instala o f informa es de diagn sticos e migra o g instru es para come ar a usar o software h o que fazer quando o software falhar como por exemplo ter um telefone de suporte ou ajuda 2 4 3 3 INFORMA O ON LINE OU IMPRESSA Existem algumas informa es que podem ser disponibilizadas tanto no formato impresso quanto no formato on line tais como a informa o inicial de familiariza o com o software b exemplos extensos c refer ncia estruturada do material particularidades ou fun es caracter sticas avan adas do software d perguntas feitas frequentemente FAQ e guias de como utilizar o teclado e outros equipamentos de entrada de dados 26 2 4 4 CRIT RIOS PARA ELABORA O DA DOCUMENTA O Na fase de planejamento da documenta o do software define se quais ser o os tipos de documenta o que ser o adotadas os recursos tecnol gicos empregados e o or amento necess rio Isso ocorre porque nem sempre um software requer todos os tipos
74. as s o devidamente apropriados Documenta o On Line Pergunta Existem tituks dos t picos e controles contidas em reas onde n o possuem rolagem Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Documenta o Impressa e On Line Pergunta As cores s o utilizadas de forma apropriada Documenta o Impressa e On Line Pergunta As cores s o utilizadas de forma consistente Documenta o Impressa e On Line Pergunta Existem apenas poucas cores utilizadas Documenta o On Line Pergunta A apresenta o da aplica o trabalha em modo managram tico Documenta o On Line Pergunta O usu rio pode madificaras cores da interface e de funda da aplica o Documenta o Impressa e On Line Pergunta Existe consist ncia de polaridade por exemplo texto escura com fundo claroj Documenta o On Line Pergunta O contrate entre as cores da interface e do fundo s o adequadas Documenta o Impressa Pergunta Na caso de impress o do documentos no modo monagram tico est fica clara para compreens o Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta N o Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Ob
75. cada cone Ig ela e alee leles Exibe a tela de cadastro dos Avaliadores Exibe a tela de cadastro das Perguntas Exibe a tela de cadastro dos Documentos de cada software Exibe a tela de cadastro dos Softwares que ser o avaliados Exibe a tela de Registro de uma nova Avalia o Exibe a tela de Consulta das Avalia es j registradas Gera o Relat rio de todos os Avaliadores cadastrados Gera o Relat rio das Avalia es registradas Gera o Relat rio de todas as Perguntas cadastradas com sua categorias e aplica o Gera o Relat rios dos Softwares cadastrados juntamente com a documenta o a eles atrelada Exibe a janela de Ajuda do software Exibe Informa es sobre o software como direitos e autor Encera o software 96 Navega o pelos Cadastros A Navega o pelos Cadastros est presente nas seguintes janelas Cadastro de Avaliadores Cadastro de Perguntas Cadastro de Documentos Cadastro de Softwares Consulta de Avalia es A Navega o pelos Cadastros se d atrav s de uma Barra de Ferramenta localizada na base do software a seguir defini se a funcionalidade de cada bot o lembrando que nem todas as op es poder o estar dispon veis isso depender da janela acessada Exibe o Primeiro Registro Exibe o Registro Anterior Exibe o Pr ximo Registro Exibe o ltimo Registro Realiza a cria o de um Novo Registro Executa a opera o de Apagar Registro Executa a ope
76. claros Documenta o mpressa Pergunk As se es est o caram ente distinguidas um as das outas Docurrenta o mpressa Pergunk assuntos similares s o apresentados com similares layouts Documenta o mpressa Perguntk Olayout das se es apropriado para aintem a o contidaneles Docurrenta o mpressa Pergunk E ste espa o em branco sutciente na p gina a modo delan o parecer cheia demais Resposta N o se aplica Otserva es Resposta N o se aplica Oteserva es Resposta N o se aplica Oteserva es Resposta N o se aplica Oteerva es Resposta N o se aplica Otserva es Resposta N o se aplica Oteerva es P gina 9 AP NDICE E Avalia o da documenta o do SAQDS SAQDSO Relat rios de Avalia es Softwar oba Sistema de Avalia o da Qualidade da Documenta o de Softuare Avaliador Anderson Nicokdelli Informa es Complementares Percentual de Conformidade 134 Data 02 07 2004 Docum enta o Impressa e On Line Pergunta Est claro qual a vers o dosoftuare quea documenta o aborda Documenta o Impressa e On Line Pergunta O nome do fabricante est devidamente identificado Documenta o Impressa e On Line Pergunta A documenta o cont m informa es de onde as usu rias possam encontrar suporte quando necessitarem Documenta o Impressa e On Line pargurta Existe uma descri o da licen a de usodo software Respost
77. como base o check list e desenvolver um sistema especialista onde o mesmo teria o papel de analista da documenta o de software 4 2 DIFICULDADES Algumas dificuldades foram encontradas na elabora o desse trabalho como a atividade de tradu o interpreta o e adapta o da norma adotada que demandou um tempo consider vel a elabora o da documenta o conforme a mesma norma sem possuir dados concretos em alguns casos como por exemplo o nome da empresa endere o telefone de contato e a fase de aprendizado dos softwares utilizados na implementa o o Delphi 7 e o RoboHelp Office X5 81 REFER NCIAS BIBLIOGR FICAS CANDID Saul Saving time money and expertise with a self help support system Microsoft technet Seattle v 5 n 5 mai 1997 CANT Marco Dominando o Delphi 3 Tradu o Jos Carlos Barbosa dos Santos revis o t cnica de Edmilson Kazyoshi Miyasaki S o Paulo Makron Books 1996 ISHIKAWA Kaoru Controle de qualidade total maneira japonesa Rio de Janeiro Campus 1993 ISO IEC INTERNATIONAL ORGANIZATION FOR STANDARDIZATION INTERNATIONAL ELECTROTECHNICAL COMMISSION ISO IEC 18019 software and system engineering guidelines for the design and preparation of user documentation for application software Su a 2004 JOMORI Sergio Massano VOLPE Renato Luiz Della ZABEU Ana Cec lia Peixoto Qualidade de software Falando em qualidade S o Paulo n 141 p 44 53 fev 2004 MAC
78. como um todo sejam estruturados a modo de garantir que cada produto realizado tenha as mesmas caracter sticas ou seja importante ampliar a repetibilidade do processo 2 1 QUALIDADE DE SOFTWARE Segundo Jomori et al 2004 p 44 cada dia maior o n mero de empresas de software que buscam melhorias em seus processos de desenvolvimento de software Essa evolu o na busca por melhorias evidenciada na Tabela 2 que apresenta a evolu o no n mero de empresas de desenvolvimento de software certificadas pela ISO 9000 Tabela 2 Certifica o do Sistema da Qualidade ISO 9000 nas empresas de software Categorias 1993 1995 1997 1999 2001 Certifica o ISO 9001 1994 ou 2000 3 8 36 63 68 Certifica o ISO 9002 1 11 16 17 Software explicitado no escopo 16 39 58 Fonte adaptado de Jomori et al 2004 p 46 Segundo Jomori et al 2004 p 45 as principais refer ncias para melhoria dos processos utilizadas pelas organiza es que desenvolvem produtos de software s o o modelo Capability Maturity Model CMM e as normas ISO S rie 9000 ISO 12207 e ISO 15504 17 SPICE Software Process Improvement and Capability Determination A seguir pode se ver o detalhamento de cada refer ncia citada acima bem como um gr fico de evolu o referente ao seu conhecimento e aplica o De acordo com Jomori et al 2004 p 46 o Capability Maturity Model CMM um modelo desenvolvido pelo Soft
79. cri o das fun es do software NA NA NA 8 Mensagens informativas PA AT AT 9 Mensagens on line NA NA AT 10 Defini es e termos NT PA PA 11 Conceitos NA NA AT 12 Explora o da informa o AT AT AT 13 Perguntas feitas freq entemente FAQ NT NT AT 14 Conte do personalizado pelo usu rio NT NT PA 15 Navega o AT AT PA 16 Acessando informa es on line PA AT AT 17 Menus NT PA PA 18 lista de conte do AT PA AT 19 Indice NT NT AT 20 Buscas AT AT AT 21 navega o pelo usu rio NA NA NA 22 Identifica o da informa o corrente NT PA NT 23 Posi o atual de um t pico NA NT NA 24 Acessando novamente a informa o AT AT AT 25 Navega o entre a aplica o e a documenta o NT NT AT 26 Impress o das informa es PA PA AT 27 Movimenta o entre t picos diferentes AT AT PA 28 Informa es extras AT AT PA 29 Navegando pelas informa es AT AT AT 30 Visualizando t picos em seq ncia NT AT AT 31 Saindo da documenta o on line AT AT AT 32 Busca da informa o fornecida pelo usu rio NA NA AT 33 Tamanho dos t picos ou fragmentos AT AT NT 34 Apresenta o da documenta o on line AT AT AT 35 Janelas Relacionamento entre a exibi o da informa o e da aplica o a AT AT 36 Janelas simult neas PA AT AT 37 Janelas padr es PA PA PA 38 Disposi o das janelas AT PA AT 39 Grids AT AT AT 40 Area da informa o AT AT AT 41 Localiza o das ilustra es NA
80. cumenta o on line do software Microsoft Photo Editor 3 0 1 a avalia o tamb m foi realizada com o software desenvolvido Os auditores elaboraram com base na norma uma lista com os principais t picos que iriam ser avaliado e tomaram como medida padr o a forma atendimento a requisitos aplicando as seguintes op es atende atende parcialmente n o atende e n o se aplica Segundo a percep o do auditor Hideraldo com experi ncia na rea de software e sistema de gest o da qualidade a documenta o on line do software avaliado de uma forma geral atende 70 das especifica es da norma em quest o Para Julciane com experi ncia em sistemas de gest o da qualidade e ambiental a conformidade foi de 80 J para Josiane com experi ncia na rea de gerenciamento da rotina ferramentas da qualidade e gest o da qualidade a documenta o apresentou o ndice de conformidade de 87 Na avalia o T11 realizada pelo software desenvolvido o mesmo registrou um atendimento de 87 90 se assemelhando muito a auditora Josiane Outra an lise que pode ser feita que a diferen a entre a avalia o do auditor Hideraldo para a avalia o da auditora Josiane se deu pelo fato da criteriosidade adotada um exemplo disso o item 16 que trata de acesso a informa es on line na avalia o do auditor Hideraldo o resultado foi o atendimento parcial pois segundo ele as informa es estavam muito pobres j para a au
81. de explora o da informa o a dicas sugest es b explica o de como as fun es pode ser utilizadas em conjunto afim de produzirem resultados espec ficos c informa o personalizada explicando como o usu rio pode adaptar a aplica o a modo de suprir suas necessidades por exemplo alterar algoritmos utilizados em alguns c lculos d informa es sobre a rea que a aplica o ir abordar para que com isso o usu rio possa caso necess rio aprofundar seu conhecimento nessa rea e s ent o partir para a utiliza o da fun es da aplica o Na Figura 8 pode se ver um exemplo de explora o da informa es atrav s de links CorelTUTOR tm Microsoft Internet Explorer Arquivo Editar Exibir Favoritos Ferramentas Ajuda Corel TUTOR Bem vindo Bem vindo p gina do tutorial do CorelDRAW Estes tutoriais envolvem voc em projetos que o ajudar o a aprender mais sobre o aplicativo Alguns tutoriais est o dispon veis localmente em seu sistema enquanto outros est o dispon veis em nosso site da Web CorelTUTOR Embora os tutoriais locais sejam uma boa fonte de informa es teis eles n o mudam Os tutoriais dispon veis no CorelTUTOR on line s o atualizados periodicamente D uma olhada no que est dispon vel agora mas retorne para ver os novos tutoriais que n s criaremos Tutoriais dispon veis localmente JE Tour da rea de trabalho apresenta os conceitos b sicos do CorelD
82. definidos f n o deve se utilizar marcadores maiores que um caractere normal de texto g decidir se os item da lista ter o t tulos e qual ser a sua formata o h caso a lista seja muito longa a modo de n o poder ser visualizada completamente na tela deve se utilizar m todos de navega o que possam suprimir essa dificuldade 2 4 29 8 TABELAS recomend vel em uma tabela colocar os itens que devem ser lidos juntos em linhas n o em colunas adicionalmente quando estiver projetando tabelas para documenta o on line deve se levar em considera o os seguintes itens a se o usu rio tiver que aplicar a rolagem para visualizar a tabela deve se garantir que o t tulo cabe alho da mesma sempre esteja vis vel b caso a rolagem acontecer para a direita deve se permitir a visualiza o da primeira coluna c lembrar os usu rio que eles tem a op o de mudar o tamanho das janelas nesse caso textos ou colunas podem ficar escondidos 62 d dividir uma tabela em tabelas menores e apresentar a tabela como uma s rie de listas f separar os itens utilizando espa os em branco g n o deve se utilizar linhas para separar c lulas que devem ser lidas em conjunto h em se tratando de tradu es o tamanhos do texto pode variar e a tabela deve prever tal varia o de modo que o texto fique adequadamente acomodado 2 4 29 9 CAIXAS E BORDAS E recomend vel separar itens com espa os em branco ao inv s d
83. ditora Josiane o item atendeu perfeitamente aos requisitos O check list desenvolvido pode ser encontrado no Ap ndice B e ambas as avalia es dos auditores bem como a realizada pelo software desenvolvido encontram se nos Ap ndices C e D respectivamente A documenta o do software foi avaliada quanto adequa o ao check list ap s a avalia o no software desenvolvido obteve se um percentual de conformidade com a norma ISO IEC 18019 2004 de 95 3 entretanto deve se considerar alguns aspectos a algumas partes da documenta o desenvolvida atendem os requisitos da norma em quest o todavia o conte do apresentado poderia ser mais rico com um maior n mero de detalhes b em alguns casos a falta de experi ncia no desenvolvimento de documenta es desse tipo acarretou o n o cumprimento de alguns requisitos espec ficos tais como a descri o de cada tarefa que o usu rio poderia utilizar apenas existe a descri o das principais tarefas na vis o geral a descri o das fun es dispon veis para o usu rio apresentado apenas uma breve descri o das funcionalidades o que n o chega a atender o requisito entre outros casos c pode se dizer que ainda a documenta o on line encontra se mais completa do que a documenta o impressa pois existem algumas funcionalidades dispon veis na documenta o on line que foram esquecidas quando da elabora o da documenta o impressa por exemplo o ndice que na d
84. do software ao qual a documenta o aborda Resposta Observa o atende parcialmente vers o est o incompleta Pr xima Pergunta 103 Quando as pergunta terminarem ser exibida uma janela onde informar que as mesmas foram preenchidas com sucesso deve se clicar no bot o OK que automaticamente ser iniciado uma nova janela para Registro de Avalia es 104 Consulta de Avalia es Nessa janela realiza se a Consulta de Avalia es A seguir defini se todos os campos Avaliador Exibe o nome do Avaliador Percentual de Conformidade Exibe o percentual de conformidade da documenta o avaliada com base nas regras pr definidas em m tricas O c lculo desse percentual est explicado em Percentual de Conformidade Softwares Exibe o nome do Software Informa es Adicionais Exibe informa o adicionais referente a Avalia o Data Exibe a data que foi realizada a Avalia o Categoria Exibe a categoria da pergunta atual Documenta o Exibe a aplicabilidade da pergunta atual Resposta Exibe a resposta da pergunta atual Observa o Exibe a observa o da resposta se houver Existem dois bot es no janela que facilita a navega o entre avalia es s o eles Avalia o Anterior Exibe a primeira pergunta da avalia o anterior Pr xima Avalia o Exibe a primeira pergunta da pr xima avalia o Tamb m nessa janela poss vel cl
85. dos d fornecer um ndice e permitir buscas 2 4 24 VISUALIZADO T PICOS EM SEQU NCIA recomend vel levar em considera o os itens a seguir quando da visualiza o de t picos em seqgii ncia a se houver uma seq ncia natural para um grupo qualquer de t picos sequ ncia de navega o fornecer um m todo para o usu rio visualizar essa segii ncia tanto de t picos anteriores e sucessores 50 b caso o m todo utilizado requerer que o usu rio utilize uma combina o de teclas para avan ar ou regressar entre os t picos deve se exibir essa combina o c em uma segii ncia indicar claramente qual ser o resultado alcan ado ao final da mesma para o usu rio tamb m deve se considerar exibir o in cio da segii ncia 2 4 25 SAINDO DA DOCUMENTA O ON LINE Quando o usu rio necessitar sair da documenta o on line importante fornecer uma forma simples de sa da a n o ser que exista um sistema padr o fornecido pelo sistema operacional adicionalmente deve se garantir que o m todo de sa da seja sempre o mesmo em todo o software 2 4 26 BUSCA DA INFORMA O FORNECIDAS PELO USU RIO Caso o usu rio tenha a facilidade de realizar suas pr prias anota es na documenta o importante levar em considera o os seguintes aspectos a garantir que o m todo utilizado seja simples e claro b garantir a f cil busca das anota es Ainda recomend vel exibir o local onde o usu rio fe
86. e Observa es Resposta Atende Observa es Resposta Atende Observa es Docum enta o Impressa e On Line pg Todos os elementos da interface do usu rio est o devidamente explicados Resposta Atende Observa es Docum enta o Impressa e On Line atrai Todas as fun es do software est o descritas Resposta Atende Observa es Docum enta o Impressa e On Line Epa As mensagens est o devidamente explicadas quando necess rio Resposta Atende Observa es Docum enta o Impressa e On Line Pergunta Todos os termos utilizados est o definidas na documenta o ou j s o de uso familiar da usuario Documenta o Impressa e On Line Pargurka A terminokgia utilizada consistente Resposta Atende Observa es Resposta Atende Observa es 135 Data 02 07 2004 SAQDSO Relat rios de Avalia es Documenta o Impressa e On Line Pergunta Todos os conceitos importantes est o explicados Docum enta o Impressa e On Line E Existem informa es de como explorar recursos avan ados do software Docum enta o Impressa e On Line Pergunta A documenta o responde perguntas que as usu rios possam ter Documenta o Impressa e On Line Pergunta Existe alguma solu o de problemas descrita quando necess rio Documenta o Impressa e On Line Pergunta A solu o de problemas cobre tados as problemas que o usu rio possa vira ter Documenta o Impres
87. e Pergunta Data_Pub_Documento D Cd_Software lt pi gt lt M gt Cd_Pergunta lt pi gt lt M gt Nm_Pub_Documento VA250 Nome Software VA150 Desc Pergunta VA250 ID CD Documento lt pi gt Desc Software VA250 Tipo Pergunta VA150 Empresa_Software VA200 Cat_Pergunta VA250 ID CD Software lt pi gt ID CD Pergunta lt pi gt Figura 14 Diagrama de entidade relacionamento l gico Avaliador Cd Aval INTEGER lt pk gt W FK AVALIACA REALIZA A AVALIADO Nome Aval VARCHAR 150 es Avalia o End Aval VARCHAR 150 E Numero End Aval INTEGER sn Ec Ea Cidade Aval VARCHAR 100 Bairro_Aval VARCHAR 100 Cd soitware INTEGER sies CEP_Aval VARCHAR 50 Com_Ag o VARCHAR 250 Telefone Aval VARCHAR 50 y Dala Agad DATE Estado Aval VARCHAR 50 Resultado A o VARCHAR 250 z9 Pa FK_AVALIACA_POSSUI_AV_SOFTWARE FK RESPOSTA POSSUI RE AVALIACA Resposta Software Cd A o INTEGER lt pkfkt gt Cd Software INTEGER lt pk gt Cd_Pergunta INTEGER lt pkfke gt Nome Software VARCHAR 150 op Resposta VARCHAR 250 Desc Software VARCHAR 250 Com Resposta VARCHAR 250 Empresa Software VARCHAR 200 PE SEO TER T E Pergunta Cd_Pergunta INTEGER lt pk gt Desc_Pergunta VARCHAR 250 Tipo_Pergunta VARCHAR 150 68 FK_DOCUM m asa Cat Pergunta VARCHAR 250 Documento Cd Documento INTEGER Cd Software INTEGER lt fk gt Desc Documento VARCHAR 250
88. e disponibiliza as seguintes op es de resposta notas de O a 10 n o se Aplica amp SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software9 SAQDS Registro das Avalia ME ES Cadastros Avalia o Relat rios Ajuda Avaliador sofia da Rocha 7 Software Flash MX X Informa es Adicionais avalia o da nova vers o do Macromedia Flash Requisitos Porcentagem Notas Data M trica f 9 05 2004 Categoria Documenta o Informa es Gerais Impressa e On Line Perqunta No caso de impress o da documenta o as fontes s o impressas corretamente em todos os tipos de impressoras dispon veis para o usu rio Resposta Observa o atende parcialmente Apresentou algumas irregularidades quando foi impresso em uma impressora HP 1520 Em duas outras impressoras EPSON 755 e uma LEXMARK 780e a Pr xima Pergunta impress o ficou dentro do esperado Figura 22 Tela de registro de avalia es 74 Para consultar as avalia es j registradas deve se acessar o item do menu consulta de avalia o na Figura 23 pode se ver a tela de consulta de avalia es nela tamb m poss vel excluir uma avalia o O c lculo do percentual de conformidade foi definido a modo de permitir ao avaliador poder optar por desde uma avalia o mais gen rica no caso do op o por requisitos at uma avalia o mais detalhada como no caso por n
89. e e verso Output Options x r Selected Printer Vorjgs152N4SA QUAL L1 Setup Report Destination E C Preview Cancel C Eite Ej Format Rave Snapshot File NCE Options Copies I Collate i I Duplex Podem ser configuradas outras op es de impress o conforme as impressoras dispon veis clicando no bot o Setup Configurar impress o 2 x m Impressora Nome Propriedades Status Pronta Tipo HP LaserJet 9000 PS Local BR SCJARAGUA PF1 Coment rio LaserJet 9000 Qualidade m Papel Orienta o Tamanho as Retrato Origem Bandeja 4 C Paisagem Rede Cancelar 108 Selecionado a op o File o relat rio gerado ser salvo em uma dos formatos dispon veis na lista em Format Rave Snapshot File NDR Formato nativo do gerador de relat rio Native Printer Output PRN Formato padr o de arquivos de impress o Adobe Acrobat PDF Formato de arquivo no padr o pdf da Adobe Web Page HTML Formato padr o de arquivo para Internet Rich Text Format RTF Formato texto que preserva a formata o do relat rio Plain Text TXT Formato texto que descarta a formata o do relat rio deixando o mesmo em texto puro Selected Printer Worjgs1S2HNSA QUAL L1 r Report Destination Printer C Preview Native Printer Output PRN Adobe Acrobat PDF Copiedaeb Page HTML Rich Text Format R
90. e est escrito Essa uma quest o cl ssica sobre documenta o de software mesmo com uma documenta o pobre o usu rio ir entender o que est escrito Isso totalmente equivocado por exemplo em um treinamento quanto melhor estruturado a documenta o o treinamento ser melhor absorvido e de maneira mais r pida evitando chamadas ao suporte t cnico Fonte adaptado de Nayar 2000 p 27 29 De acordo com a Tabela 5 Tecnologia MCT 2001 pode se que traz pesquisa realizada pelo Minist rio da Ci ncia e constatar que das 434 empresas pesquisadas cerca 22 23 n o possu am o manual do usu rio dos softwares desenvolvidos Outro ponto interessante que aproximadamente 40 das empresas pesquisadas n o possu am documenta o da especifica o do sistema e apenas 15 afirmavam possuir um plano de controle da qualidade dos softwares desenvolvidos Tabela 5 Documenta o adotada Categorias N de organiza es Jo Acompanhamento de custos 161 37 1 Acompanhamento de prazos 265 61 1 Contratos e acordos 295 68 0 Descri o do produto p comercializa o 231 53 2 Documenta o de marketing 161 37 1 Documenta o de programas 273 62 9 Documenta o do processo de software 154 355 Documenta o no c digo 272 62 7 Especifica o do sistema 267 61 5 Guia de instala o 249 57 4 Help on line 284 65 4 Hist rico do
91. e linhas Deve se utilizar caixas de texto e ilustra es se for auxiliar o entendimento do usu rio ou para deixar o texto agrupado a uma ilustra o espec fica N o deve se utilizar caixas nem bordas apenas para fins de decora o da documenta o 2 4 29 10 REPRESENTANDO A INFORMA O EXIBIDA PELO SOFTWARE As informa es que s o exibidas pelo software devem quando referenciadas na documenta o serem escritas de forma completa e com outra formata o de letra conforme apresentado no Quadro 2 Voc deseja continuar Para SIM pressione S Para N o pressione N Quadro 2 Exemplo de representa o da informa o exibida pelo software 24 29 11 REPRESENTANDO INFORMA O QUE DEVEM SER DIGITADAS PELO USU RIO E importante diferenciar claramente a informa o que os usu rio necessitam digitar da informa o que o software apresenta deve se utilizar recursos como negrito e ou it lico 24 29 12 REPRESENTANDO TECLAS 2 Quando se referir no texto a uma tecla espec fica recomend vel considerar os seguintes aspectos a utilizar uma fonte especial b utilizar um caractere especial para separar a tecla do resto do texto por exemplo lt gt pressione a tecla lt a gt 63 2 4 29 13 CONES E SINALIZADORES Os cones representam um conceito objeto ou uma a o em uma pequena rea A utiliza o de cones poupa espa o em uma janela logo permite que mais informa o possa se
92. ea da informa o b tamanho do texto e das ilustra es c reas que n o possuem rolagem 2 4 28 2 2 REA DA INFORMA O importante utilizar espa os adequados para grandes quantidades de informa o em texto adicionalmente deve se levar em considera o os seguintes aspectos a apresentar o texto em uma coluna simples b evitar longas linhas de texto em uma janela de tamanho padr o c se textos prolongados estiverem presentes em tabelas deve ser garantir que as 55 colunas n o sejam muito estreitas pois desse modo a frases ficariam dif ceis de ler d desenvolver a rea de informa o a modo de permitir que o usu rio possa rolar a informa o verticalmente N o deve se fazer com que os usu rios tenham que rolar a informa o horizontalmente e quando a informa o estiver sendo exibida em uma janela de Internet deve se redefinir os controles para evitar duplicidade 2 4 28 2 3 LOCALIZA O DAS ILUSTRA ES E recomendado especificar no grid da janela onde as ilustra es devem ficar localizadas adicionalmente deve se exibir de modo consistente ilustra es do mesmo tipo de acordo com as mesmas necessidades dos usu rios 2 4 28 2 4 ESPA OS EM BRANCO importante separar claramente os elementos em uma janela para tanto utilize se de espa os em branco para separar linhas textos e ilustra es de modo que elas fiquem bem definidas e de f cil entendimentos ao usu rio 2 4 28 3
93. ecess rios Documenta o On Line Pergunta Os atalhos levam ace locais corretos Documenta o On Line Pergunta Os atalhos s o suficientes Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Documenta o On Line Pergunta possivel navegar atrav s da informa o em uma sequ ncia Resposta Atende Observa es P gina 3 137 Data 02 07 2004 SAQDSO Relat rios de Avalia es Documenta o On Line Pergunta O usu riotem a possibilidade de voltar bem como de ir a adiante na navega o Documenta o Impressa Pergunta Os assuntos s o apresentados em uma sequ ncia l gica em cada documento Documenta o Impressa Pergunta A sequ ncia da informa o de cada parte da documento corresponde ao modo que os usu rios precisar utiliz la Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Documenta o On Line Pergunta Tantoo textaquanto os gr ficos passuem a velocidade de rolagem adequada Documenta o On Line Pergunta Quando da rolagem os titulos continuam sendo exibidas Documenta o On Line Pergunta Existe um sinalizador que indica a posi o do usu rio em rela o aa final de um t pico quando mesmo estiver realizando a rolagem do texto Resposta Atende Observa es Resposta N o Atende
94. elat rio e enfiar por e mail recomenda se que voc gere um arquivo em formato pdf do relat rio Para saber mais sobre a gera o desse arquivo basta acessar o cap tulo Op es de Impress o de Relat rios que cont m toda a explica o necess ria a esse processo Depois da gera o do arquivo em pdf basta anexar o mesmo ao seu e mail Como calculado o percentual de conformidade de uma avalia o O para saber como calculado o percentual de conformidade de uma avalia o viste o cap tulo C lculo do Percentual de Conformidade onde se encontra explicado a forma adotada 114 Qual a diferen a entre as m tricas de avalia o dispon veis A precis o da avalia o ou seja avaliando por requisitos a avalia o se torna mais gen rica e por Notas bem mais detalhada em termos de porcentagem de conformidade para saber mais sobre as m tricas acesso o cap tulo de M tricas nele voc ter uma explica o completa sobre elas Como fa o para gerar um relat rio A gera o de relat rios pode ser feita diretamente no menu ou na barra de ferramentas para ter mais detalhes sobre isso v ao cap tulo Menu ou Barra de Ferramentas onde voc encontrar a ajuda necess ria Existe um limite de avalia es que posso realizar Na teoria existe o limite do seu equipamento mem ria mas na pr tica voc poder realizar muitas avalia es Caso tenha alguma problema em rela o a isso entre em contato com o suporte ma
95. ente compreendido correto e bem editado Documenta o Impressa e On Line Pergunta O indice utiliza sin nimos e refer ncias cruzadas Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende parcialmente Observa es Cobreapanas os problemas principais Resposta Atende Observa es Resposta N o Atende Observa es Existeapanas os passos a serem utilizados faltando exemplos de como utilizar as m tricas e casos pr ticos Resposta N o Atende Observa es Resposta N o Atende Observa es Resposta Atende Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende parcialmente Observa es Existe um idince bem completo na documenta o on line todavia o indice da documenta o impressa deixa a desejar em alguns aspectos Resposta Atende Observa es Resposta Atende Observa es P gina 2 Data SAQDSO Relat rios de Avalia es Documenta o Impressa e On Line Pergunta O ndice amp desenhado do ponto de vista dos leitores ou seja de acordo coma eles acessam a informa o
96. ergunta Existe a de uso do software Observa es Figura 24 Exemplo de relat rio de avalia o 76 O software ainda possui a ajuda on line dispon vel para consulta na Figura 25 pode se ver a janela de ajuda do software a mesma tamb m acessada atrav s do menu ou da barra de ferramentas lt amp SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software Jo x Arquivo Editar Indicador Op es Ajuda E vi mm TS Apresenta o O SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software tem como objetivo realizar a avalia o da documenta o de software afim de assegurar a Conformidade com a Normas ISOJEC 18019 2004 Software and System Engineering Guidelines for the Design and Preparation of User Documentation for Application Software A seguir pode se ver a tela inicial do SAQDS que constitu da de um menu mais acima e de uma barra de ferramentas mais a esquerda da tela TE SAQDS Sistema de Avalia o da Qualidade da Documenta o de Softwares Cadastros Avaka o Relat rios Ajuda SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software T picos Relacionados P Sobre Figura 25 Janela de ajuda do software 3 9 RESULTADOS OBTIDOS Para a valida o do check list elaborado com base na norma ISO IEC 18019 foram escolhidos tr s auditores com experi ncia em reas distintas para realizarem a avalia o da do
97. es Documenta o Impressa Pergunta f cil encontraro inicio de cada parte e cada capitulaou se es Documenta o Impressa Pergunta Existem ap ndices ou anexos utilizados apropriadamente para referenciar informa es extensas Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta N o se aplica Observa es Documenta o On Line Pergunta Esta claro que tipo de informa o amp exibida Documenta o On Line Pergunta Cada t pico possui um titulo adequado Documenta o On Line Pergunta O usu rio podem voltara um t pico anterior Documenta o Impressa Pergunta Est claro que tipo de informa o est contida em cada se o Documenta o Impressa Pergunta Cada se o possui um titulo adequado Documenta o Impressa e On Line Pergunta O usu rio pode encontrara melhor ponto de partida para suas necessidades Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Documenta o On Line Pergunta Existem diferentes tipos de atalhos claramente distinguidos Documenta o On Line Pergunta Os atalhos s o apropriados Documenta o On Line Pergunta Todos os atalhos s o n
98. es para os usu rios realizarem suas tarefas Elas incluem m dulos relat rios telas caixas de di logos comandos e seus equivalentes A descri o das fun es deve responder as seguintes perguntas O que isso O que isso faz e Para que posso utilizar isso 32 importante determinar se o usu rio poder visualizar a descri o das fun es do software simultaneamente com o mesmo tamb m deve se criar uma descri o para cada fun o em particular por exemplo comandos ou caixas de di logo Por causa da grande diversidade em se tratando de fun es do software n o existem regras gerais sobre o que deve se ou n o ter em sua descri o Entretanto alguns itens devem ser levados em considera o a utilizar o nome da fun o como t tulo principal na janela de informa o b incluir um r pida explica o no in cio relatando qual a finalidade da fun o fazendo com que o usu rio possa decidir se essa fun o atende sua necessidade c explicar o contexto onde a fun o pode e n o pode ser utilizada d descrever o que os usu rios podem obter utilizando essa fun o e se os usu rios necessitarem entender como a aplica o trabalha com essa fun o para poderem decidir o uso da mesma prover essa informa o f para fun es similares subdividir a informa o de maneira que cada uma tenha o mesmo conjunto de informa es E importante fornecer caminhos para encontrar informa
99. es sobre fun es relacionadas provendo atalhos diretos a elas como por exemplo incluindo refer ncia a tarefas utilizando fun es ou partes relevantes no tutorial on line Quando atalhos diretos estiverem dispon veis deve se dispor os mesmos no in cio dos t picos ou sempre no final Deve se evitar os seguintes itens na descri o de fun es a instru es gerais de como utilizar a interface do usu rio b explica o sobre termos gerais Na Figura 5 pode se observar a descri o de uma fun o de uma planilha eletr nica com os elementos destacados tais como o nome da fun o a sintaxe de uso o resultado que ser obtido pelo usu rio quando da sua utiliza o consta ainda exemplos de aplica o da fun o bem como fun es que s o relacionadas com a fun o corrente 33 acos Fornece o arcoseno de x em radianos O arcoseno o ngulo onde o coseno x Sintaxe acos x onde x um n mero decimal que varia entre 1 lt x lt 1 Resultado Um ngulo A em radianos varia entre O lt A lt B Se x est fora da varia o ERR mostrado Exemplos acos 0 5 retorna 1 047 B 3 radianos acos 1 retorna 3 142 B radianos Fun es Relacionadas Para converter radianos em graus rad2deg Para encontrar o coseno de um ngulo cos Fonte adaptado de ISO IEC International Organization For Standardization International Electrotechnical Commission 2004 p 68 Figura 5 Exe
100. esentadas na forma de listas numeradas quando a sequ ncia sefaz importante Documenta o Impressa e On Line Pergunta Existem listas apresentadas na forma de marcadores quando a sequ ncia n o sefaz importante Documenta o Impressa e On Line Pergunta Existem tabelas sendo utilizadas apropriadamente Documenta o Impressa e On Line Pergunta Existem r guas e bordas sendo usadas consistentemente Documenta o On Line Pergunta A apresenta o simples Documenta o On Line Pergunta Anota es podem ser distinguidas facilmente Documenta o Impressa Pergunta O texto pode ser lido facilmente Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta N o se aplica Observa es Resposta Atende Observa es Documenta o On Line Pergunta A velicidade com que as ilustra es s o exibidas amp adequada Documenta o Impressa e On Line Pergunta As ilustra es podem ser visualizadas juntamente com o texto queas referenciam Documenta o Impressa e On Line Pergunta As linhas exibidas s o grossas o suficiente para serem notadas Documenta o Impressa e On Line
101. esmo t pico por exemplo uma 40 explica o de um campo ou valor b um n vel mais alto de detalhe por exemplo um vis o geral de um tipo de fun o exibida c informa o procedural como fa o d outros t picos relevantes e acesso imediato a uma tabela ndice ou gloss rio Deve se considerar as seguintes caracter sticas se a tecnologia estiver dispon vel a mover para outros itens de informa o possivelmente porque o que o item atual n o atende a necessidade do usu rio e o mesmo necessita visualizar uma informa o diferente b obter esclarecimentos sobre alguma informa o corrente c navegar atrav s de grandes quantidades de informa o possivelmente para averiguar que informa o est dispon vel e se o assunto em quest o est coberto pela ajuda d navegar atrav s de uma lista de t picos do come o ao fim e sair da documenta o importante levar em considera o os princ pios gerais a seguir quando se tratando de caracter sticas de navega o a tornar a navega o f cil de se utilizar entender e de se lembrar n o oferecer v rios m todos diferentes de navega o isso pode confundir o usu rio b usar o m todo de navega o consistentemente desse modo os usu rios podem atingir os mesmo caminho em diferentes situa es c manter a estrutura da documenta o clara desta forma os usu rios n o se tornar o desorientados 2 4 10 1 ACESSANDO INFORMA ES O
102. et e o nome do elaborador da documenta o caso for diferente do nome da empresa ou distribuidor com o endere o telefone fax e mail e endere o da p gina na Internet f dados do autor incluindo por exemplo o nome posi o e qualifica o g detalhes em rela o de como entrar em contado com a empresa 27 h licen a de uso n mero e nome do detentor da licen a de uso i aviso sobre os diretos de reprodu o do software j condi es e termos de garantia k as responsabilidades legais da empresa e os direitos do consumidor incluindo a parte de treinamento assist ncia t cnica garantia de qualidade e disponibilidade do c digo fonte 1 refer ncia a qualquer padr o ou norma que o software segue indicando o grau ou n vel de conformidade m agradecimentos Caso o produto for traduzindo deve se ter cuidado na elabora o da tradu o da documenta o tanto na parte escrita quanto nas partes gr ficas pois dependendo da linguagem isso pode requerer por exemplo diferentes logotipos da empresa ou do produto Nesse caso aconselh vel a cria o de diferentes vers es de tradu o do produto No caso da vers o impressa da documenta o de software importante levar em considera o os itens a se o documento compreende mais de uma parte deve se listar todas as partes a pa s onde foi impresso b n mero internacional padr o de livros International Standard Book Number ISBN
103. extos s o impressos de forma correta leg vel 34 cones e Sinalizadores X 34 1 Os cones e os sinalizadores s o de f cil compreens o X 34 2 Os gr ficos utilizados nos cones e sinalizadores s o claros X 34 3 Os gr ficos utilizados nos cones e sinalizadores representam os objetos atuais as a es 35 Documentos 35 1 A apresenta o de cada documento deixa claro o que cada um contem 35 2 Otamanho m dio de cada documento adequado a modo de permitir a sua utiliza o 35 3 A orienta o de cada documento adequado ao uso 35 4 A maioria da documenta o est impressa em formato retrato 36 Capas 36 1 Existe uma capa adequada para cada documentos conforme sua utiliza o 36 2 Para documentos com encaderna o em espiral o espiral n o compromete a leitura da informa o 36 3 Para documentos em pastas existe apenas um tipo de documento em cada pasta 36 4 Existem cart es e folhetos adequados para uso 37 Papel 37 1 O papel adequado para o uso esperado da documenta o 37 2 Existem p gina divis rias feitas de papel grosso ou transparentes 37 3 Existem p ginas divis rios dur veis o suficiente conforme o uso da documenta o 37 4 E utilizado papel opaco quando o documentos s o impressos em frente e verso 37 5 O material utilizado na documenta o impressa adequado a adversidades ambientais tais como locais unidos e sujos
104. grandes lacunas na documenta o do software devemos considerar a documenta o como parte integrante do software ou seja quando o produto software estiver acabado o mesmo deve ser fornecido com toda a documenta o de forma a fornecer um produto completo Desenvolvedores e analistas de software podem fazer a verifica o da qualidade da documenta o gerada Desenvolvedores e analistas de software podem realizar as melhores an lises em se tratando da parte t cnica todavia na parte de documenta o a vis o dos usu rios diferente da vis o de um desenvolvedor dessa forma seria ideal destinar essa verifica o a editores usu rios em potencial Documenta o de software diferentes produtos pode diferentes estilos de formata o para seguir Existe uma tend ncia que diferentes tipos de documenta o de software ajuda on line guia do usu rio manual de referencia etc podem seguir diferentes estilos de formata o Na realidade importante assumir um padr o macro de documenta o desde a linguagem utilizada at a apresenta o gr fica Escrita t cnica n o requer criatividade e nem particularmente dif cil Nesse ponto que muitas documenta es perdem o maior valor de qualidade a escrita t cnica de suma import ncia na documenta o de software criar cargos de escritores t cnicos especializados no sistema e em comunica o seria o ideal O usu rio ir entender o qu
105. icando no bot o Apagar Avalia o excluir definitivamente a Avalia o atual amp SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software9 SAQDS Conculta das Avalia ill ES Cadastros Avalia o Relat rios Ajuda E Percentual de Conformidade 38 80 Avaliador Ana Maria Braga Software Microsoft PowerPoint XP Informa es Adicionais Data 17 05 2004 Categoria Informa es Gerais Documenta o Impressa e On Line Pergunta No caso de impress o da documenta o as fontes s o impressas corretamente em todos os tipos de impressoras dispon veis para o usu rio Resposta 2 Observa es Avalia o Anterior 105 M tricas O SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software disponibiliza tr s formas m tricas de avalia o da documenta o de software a escolha do Avaliador A seguir sua defini es Requisitos Quando da op o Requisitos for selecionada para responder uma avalia o a mesma ter as seguintes op es de reposta dispon veis Atende Atende Parcialmente N o Atende N o se Aplica Porcentagem Quando da op o Porcentagem for selecionada para responder uma avalia o a mesma ter as seguintes op es de reposta dispon veis 0 a 100 com intervalos de 20 N o se Aplica Notas Quando da op o Porcentagem for selecionada para responder uma avalia o a mesma ter as seguintes
106. icos em um CD etc 2 4 2 FATORES A SEREM CONSIDERADOS NA ESCOLHA DA DOCUMENTA O Segundo a norma ISO IEC International Organization For Standardization International Electrotechnical Commission 2004 p 9 os principais fatores que devem ser considerados na escolha de qual documenta o se aplica a necessidade do produto de software s o a perfil do software b o ambiente em que a informa o ser usada c conveni ncia para os usu rios d o alcance de facilidades t cnicas incluindo recursos e o produto disponibilidade de desenvolvimento e disponibiliza o on line e caracter sticas da informa o f custos de distribui o e manuten o 2 4 3 DISPOSI O DA INFORMA O Conforme a norma ISO IEC International Organization For Standardization International Electrotechnical Commission 2004 p 10 a informa o pode ser disponibilizada de tr s formas a on line b impressa c em ambos os meios 2 4 3 1 INFORMA O ON LINE Existem algumas informa es que geralmente o usu rio necessita que estejam dispon veis on line tais como a nomes de todos os elementos da interface 25 b fun es de todos os elementos da interface incluindo comandos cones bot es e caixas de di logos c informa o de ajuda d informa o que explica o que o sistema ir fazer est fazendo ou fez bem como o resultado de cada atividade 2 4 3 2 INFORMA O IMPRESSA Existem algum
107. iferencie as mensagens do sistema operacional das do software para que as mesmas n o se confundam entre si d evite definir novos cones ou gr ficos para as mensagens de modo a substituir as que existem dispon veis no seu sistema operacional ou em normas internacionais 2 4 4 9 MENSAGENS ON LINE Geralmente softwares utilizam o padr o que o sistema operacional lhe propicia para exibi o de mensagens relacionadas com uma situa o ou condi o espec fica Sempre que poss vel tamb m deve se utilizar os padr es de s mbolos do sistema operacional para sua aplica o 2 4 4 9 1 APRESENTA O importante utilizar uma caixa de mensagem mostrada em uma janela secund ria com o intuito de notificar os usu rios sobre o resultado de um comando para alertar o usu rio de uma situa o ou condi o onde requer uma decis o antes que de prosseguir ou informe o usu rio de uma condi o ou situa o s ria que requer interven o antes que um processo continue tamb m deve se levar em considera o os itens a utilize um s mbolo apropriado para indicar qual o tipo de mensagens que est sendo apresentada b caso a informa o contida na mensagem afete a decis o do usu rio sobre realizar ou n o alguma a o mostre a mensagem no ponto exato onde a a o ocorrer c apresente mensagens que se aplicam genericamente a t picos ou se es no come o 35 de um t pico ou se o d preceda uma mensagem com um t
108. imagem ou algum elemento gr fico como uma tela ou uma mapa Quando da elabora o dos menus importante levar em considera o os itens a caso o menu se utilizar de cones e textos considera a possibilidade de que o cone e o texto correspondente se ativem juntos permitindo que os usu rios possa selecionar o n vel ou t pico diretamente do menu exibido b fornecer uma breve descri o de cada item do menu Os nomes utilizados no menu devem indicar claramente que informa o pode ser obtida de cada item c n o deve se misture menus com informa es d na hierarquia de menus deve se dividir os n veis e sub n veis de modo que n o fiquem muitos extensos no caso de grandes grupos n o puderem ser evitados agrupe estes em outras entradas para que os usu rios n o precisem percorrer longas listas 2 4 12 LISTA DE CONTE DO As listas de conte do trazem os t tulos do conte do da documenta o em quest o de uma forma estrutura por exemplo estrutura de rvore Geralmente a lista de conte do exibida na pr pria janela do navegador ou em alguns casos em um quadro separado quando da visualiza o da informa o recomend vel considerar os itens em se tratando de listas de conte do a deve se fornecer listas de conte do na documenta o on line para que os usu rios possam dispor de um guia adicional no uso do produto tamb m deve se considerar essa funcionalidade para a ajuda do sistema b permita q
109. indica a posi o do usu rio em rela o a final de um t pico quando o mesma estiver realizando a rolagem do texto Resposta Atende Observa es Resposta N o Atende Observa es Resposta Atende Observa es Documenta o Impressa Pergunta Para documentos divididos em volumes os volumes est o chramente classificados Documenta o Impressa Pergunta Para documentos divididos em partes as partes est o numeradas Documenta o Impressa Pergunta Os capitulos ou se es est o claramente numerados ou classificados de uma maneira apropriada Documenta o Impressa Pergunta O n mero da p gina de cada volume ou de cada parte deixa clara a qual volume ou parte ele pertence Documenta o Impressa Pergunta O m tado de numera o adotado amp adequado para o tipo de documento Documenta o Impressa Pergunta A numera o das p ginas est chara Documenta o Impressa Pergunta O m tado de numera o das p ginas amp consistentecom o m todo de numera o das se es Documenta o Impressa Pergunta A numera o das se es est clara Documenta o Impressa Pergunta Existem ilustra es que s o referenciadas no texto numerado Documenta o Impressa Pergunta Existem tabelas que s o referenciados no texto numerado Documenta o Impressa Pergunta Existem p ginas preliminares numeradas em uma sequ ncia separada do resto do decumento Resposta N o se a
110. is na interface do usu rio Documenta o On Line Pergunta Existem letras mai sculas como tamanho de pelo mencs por3mm Documenta o On Line Pergunta Sublinhados que cortam letras min sculas s o evitados Documenta o Impressa e On Line Pergunta O m todo utilizado para destacar palavras ou frases consistente Documenta o Impressa e On Line Pergunta O m todo utilizado para destacar palavras ou frases amp efetivo Documenta o Impressa Pergunta No caso de impress o da documenta o as fontes s o impressas corretamente em tados os tipos de impressoras dispon veis para o usu rio Documenta o Impressa Pergunta O tamanha do texto amp adequado para o ambiente onde o documenta ser utilizado Documenta o Impressa Pergunta O espa o entre as linhas amp suficiente Resposta Atende Observa es Resposta N o Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es Documenta o Impressa e On Line Pergunta Mensagem importantes s o exibidas suficientemente Documenta o Impressa e On Line Pergunta Existem elementos similares posicionados consistentemente Documenta o Impressa e On Line Pergunta Existe espa o em branco para separar elementos Docume
111. istente Documenta o Impressa e On Line Pergunta O m todo utilizado para destacar palavras ou frases amp efetivo Documenta o Impressa Pergunta No caso de impress o da documenta o as fontes s o impressas corretamente em tados os tipos de impressoras dispon veis para o usu rio Documenta o Impressa Pergunta O tamanho da texto amp adequado para o ambiente onde a documento ser utilizado Documenta o Impressa Pergunta O espa o entre as linhas amp suficiente Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es 140 02707 2004 Documenta o Impressa e On Line Pergunta Mensagem importantes s o exibidas suficientemente Documenta o Impressa e On Line Pergunta Existem elementos similares posicionados consistentemente Documenta o Impressa e On Line Pergunta Existe espa o em branco para separar elementos Documenta o Impressa e On Line Pergunta Os par grafos est o claramente separados Documenta o Impressa e On Line Pergunta Existem listas sendo utilizadas quando necess rias Documenta o Impressa e On Line Pergunta As listas s o consistentes Documenta o Impressa e On Line Pergunta Existem listas apr
112. istro das Avalia Ed W Cadastros Avalia o Relat rios Ajuda laj x Avaliador Adriano da Silva Soares z Software Microsoft Word XP Informa es Adicionais e Avalia o semestral da documenta o Data M trica TE 11 05 2004 ei C Porcentagem Notas Iniciar 102 Quando clicado o bot o Iniciar abre a parte inferior da janela os campos correspondentes a Avalia o em si segue a defini o de cada item Categoria Informa a categoria da pergunta Documenta o Informa a aplicabilidade da pergunta a documenta o Pergunta Informa a pergunta Resposta Campo onde deve ser selecionada a Resposta conforme a m trica selecionada Observa o Campo onde deve ser cadastrado uma observa o sobre a Resposta caso necess rio Ap s o preenchimento da Resposta para ir para a pr xima pergunta deve se clicar no bot o Pr xima Pergunta f SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software SAQDS Registro das Avalia PI E3 Cadastros Avalia o Relat rios Ajuda Avaliador Adriano da Silva Soares z Software Microsoft Word XP Informa es Adicionais Avalia o semestral da documenta o cacas T Data M trica 11 05 2004 Requisitos Porcentagem Notas Ei Categoria Documenta o Informa es Gerais Impressa e On Line Pergunta Est claro qual a vers o
113. ite o trabalho atrav s de grupos realizando o compartilhamento de rea de trabalho por exemplo Quando da modelagem de um projeto ele permite a utiliza o de v rias t cnicas como o Digrama de Contexto Entidade Relacionamento etc Ap s a modelagem de dados o Power Designer pode gerar o banco de dados modelado gerando os scripts SQL e executando o diretamente na base desejada Ele tamb m emite o relat rio do dicion rio de dados do banco modelado Com uma interface amig vel e com alto grau de customiza o o Power Designer abrange v rias fases do ciclo de desenvolvimento de software fazendo com que se torne extremamente abrangente e dessa forma conseguindo realizar modelagens s necessidades da metodologia utilizada 3 3 AMBIENTE DE DESENVOLVIMENTO DELPHI Nos ltimos anos a programa o vem se tornando cada vez mais pr tica e r pida o que h alguns anos estava restrito apenas a usu rios avan ados pois n o bastava possuir o conhecimento da l gica do sistema era necess rio tamb m um profundo conhecimento dos recursos e das limita es das ferramentas de programa o dispon veis A evolu o dos ambientes de programa o contribuiu muito para essa avan o na rea de programa o hoje 66 temos a disposi o ferramentas de programa o visual como por exemplo o Borland Delphi Microsoft NET IBM Notes etc 3 3 1 CARACTER STICAS Das caracter sticas mais relevantes do ambiente de program
114. itores experientes na rea e a realizada atrav s dos softwares desenvolvido No quarto cap tulo encontram se as conclus es e sugest es para trabalhos futuros 16 2 QUALIDADE A qualidade possui diversos conceitos e entendimentos dependendo das circunst ncias e dos interesses dos envolvidos Tendo em vista esse fator importante estabelecer quais s o as defini es que se aplicam qualidade num mbito geral e qual ser adotada no presente trabalho A Tabela 1 resume os conceitos da qualidade criados por diferentes autores Tabela 1 Defini es que se aplicam qualidade Autor Defini o Juran adequa o ao uso atrav s da percep o das necessidades dos clientes Deming persegui o s necessidades dos clientes e homogeneidade dos resultados do processo Crosby conformidade do produto s suas especifica es Feigenbaum conjunto de caracter sticas incorporadas ao produto atrav s do projeto e manufatura que determinam o grau de satisfa o do cliente Ishikawa r pida percep o e satisfa o das necessidades do mercado adequa o ao uso dos produtos e homogeneidade dos resultados do processo Fonte adaptado de Stange 1996 A partir das defini es apresentadas poss vel observar a grande import ncia dada satisfa o do cliente Todavia qualidade n o se d apenas satisfazendo os clientes preciso garantir que os processos que envolvem a concep o de um produto
115. lia o da Qualidade da Documenta o de Software e Izl fejolejo fe je jose 88 Requisitos do Sistema Para que o SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software possa funcionar corretamente no seu sistema o equipamento deve possuir as seguintes caracter sticas Sistema Operacional Microsoft Windows 9X ou superior Processador Pentium 200mHz ou superior Mem ria RAM de 32MB 128 recomendado Espa o em disco dispon vel de 30MB 89 Instru es de Instala o Para que o SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software possa ser utilizado deve se copiar os arquivos que est o contidos no CD de instala o para a pasta C Temp Qualidade Ap s a c pia dos mesmos para iniciar o sistema entre em C Temp Qualidade e localize o arquivo Qualidade exe d um duplo clique no arquivo e o software ser iniciado 90 Como Iniciar Quando o software iniciado existem uma s rie de cadastros que dever o ser efetuados antes da utiliza o do mesmo Abaixo segue a lista de cadastro necess rios Cadastro de Avaliadores Cadastro de Softwares Cadastro de Documentos Eventualmente pode ser realizado alguma atualiza o da base de perguntas que j se encontra cadastrada essa atualiza o pode ser realizada na tela de Cadastro de Perguntas Ap s finalizado os cadastros o software j est preparado para realizar uma avalia o que
116. lustra es s o simples e claras Documenta o Impressa e On Line Pergunta As ilustra es detipos similares s o consistentes entre si Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es P gina SAQDSO Relat rios de Avalia es Documenta o Impressa e On Line Pergunta As ilustra es s o completas Resposta Atende Observa es 139 D207 2004 Documenta o On Line Pergunta O sistema de janelas acomoda a informa o que o usu rio necessita Documenta o On Line Pergunta Existem tamanhos e cais pad es para as janelas Documenta o On Line Pergunta O usu rio pode redefinir o formato das janelas de informa o Documenta o On Line Pergunta Os tamanhos e keai padr es para as janelas podem ser recuperados Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Documenta o On Line Pergunta Existem t picos similares exibidos em janelas com layouts similares Documenta o On Line Pergunta O layout das janelas amp apropriado para a informa o que ela exibe Documenta o On Line Pergunta Existe espa o em branco suficiente na janela de mado que n o pare a cheia demais Documenta o On Line Pergunta Os tituks das janelas s o chs Documenta o On Line Pergunta Os contrades das janel
117. m enta o Impressa e On Line Pergunta Existe uma vis o geral do software Documenta o Impressa e On Line Pergunta A vis o geral do software explica sua aplica o Documenta o Impressa e On Line Pergunta A vis o geral do software descreve quais s o as fun es disponiveis para usu rio Documenta o Impressa e On Line Pergunta A vis o geral da software abora a estrutura da documenta o Dorim enta o Impressa e On Line Pergunta Existe uma descri o de cada tarefa queo usu rio possa utilizar Documenta o Impressa e On Line cana Existe uma descri o das tarefas que est o agrupadas dentro dos processos Docum enta o Impressa e On Line Pergunta Todos os campes de entrada de informa o do software est o devidamente explicados Documenta o Impressa e On Line Pergunta Todas as op es dos campos de entrada de informa o est o claras Documenta o Impressa e On Line Pergunta As informa es sobre os diferentes tipos de campos de entrada da informa o estockhras Docum enta o Impressa e On Line Peri da Todos as elementos da interface do usu rio est o devidamente explicados Docum enta o Impressa e On Line CPR Todas as fun es do software est o descritas Deam enta o Impressa e On Line Pergunta As mensagens est o devidamente explicadas quando necess rio Docum enta o Impressa e On Line Pergunta Todas os termos utilizados est o definidos n
118. ma solu o de problemas descrita quando necess rio Documenta o Impressa e On Line Pergunta A solu o de problemas cobre tados as problemas que q usu rio possa vira ter Documenta o Impressa e On Line Pergunta A solu o de problemas fornece a solu o efetiva do problema Docum enta o Impressa e On Line Pergunta Existem exemplos suficientes Documenta o Impressa e On Line Pergunta Os exemplos s o adequados Documenta o Impressa e On Line Per Pargurka Os exempks propostos s o apresentados com consist ncia Docum enta o Impressa e On Line Pergunta Ostitukis e as chamadas de ajuda para ilustra es tabelas fotografias e outros elementos gr fico s o efetivos e consistentes Docum enta o Impressa e On Line Pergunta O usu riotem a possibilidade de realizar anota es de texto na documenta o Documenta o On Line PADURA Se for possivel o texto original pode ser recuperado Docum RR On Line Pergunta f cilde encontrara documenta o desejada Documenta o On Line Pergunta Os m todos de acesso s o consistentes Documenta o On Line Pergunta f cila saida da documenta o Documenta o Impressa Pergunta Cada usu rio possui os documentos que necessita Docum enta o On Line Pergunta Existe o acesso contexto sensitivo Documenta o On Line Pergunta A informa o exibida decomente do acesso contexto sensitivo cameta Documenta o O
119. modo monagram tico est fica clara para compreens o Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta N o Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Documenta o Impressa e On Line Pergunta Existe somente poucos tipos de fontes utilizadas Documenta o Impressa e On Line Pergunta As fontes utilizadas s o consistentes Documenta o Impressa e On Line Pergunta As fontes s o legiveis Documenta o On Line Pergunta Existem fontes adequadas sendo utilizada na apresenta o por exemplo Verdana ou Arial Documenta o Impressa e On Line Pergunta Existem diferentes niveis entre as titulos de f cil percep o Documenta o Impressa e On Line Pergunta Os niveis diferentes entre os tituks representam a higramquia adotada cometamente Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es P gina 131 Data 21 05 2004 SAQDS Relat rios de Avalia es Documenta o Impressa e On Line Pergunta A maioria do texto est em escrita com inicia de fases em letra mai sculas e o restante em min sculas Documenta o On Line Pergunta Existem fontes disponive
120. mplo da descri o de uma fun o de uma planilha eletr nica 2 4 4 8 MENSAGENS INFORMATIVAS S o informa es exibidas aos usu rios quando da ocorr ncia ou n o de um evento no software As mensagens podem ser de diversos tipos como por exemplo de avisos erros informa es de escolha de op es etc 2 4 4 8 1 FORMATO Quando uma mensagem necessitar ser exibida ao usu rio deve se levar em considera o os itens a avisar os usu rios antecipadamente para ajud los a evitar eventos indesej veis b disponibilizar informa o sobre uma a o corretiva ou de recupera o de um evento indesejado c descrever a informa o de forma clara para que o usu rio tenha agilidade na compreens o da mensagem d especificar informa es sobre o evento que levou essa mensagem a ser exibida 34 e especificar as consegii ncias para o usu rio equipamento software dados ou servi o importante definir o tipo de mensagem seu o prop sito e o estilo de escrita empregado adicionalmente deve se levar em considera o os seguintes tipos de mensagem a mensagens informativas b mensagens de aten o chamando a aten o do usu rio para alguma coisa c mensagens de a o requerendo que o usu rio tome alguma a o Quando da elabora o de uma mensagem deve se especial aten o os itens a evite o linguajar t cnico de sistemas nas informa es b n o utilize mais texto do que o necess rio c d
121. n Line Pergunta Existem t picos de f cil kxaliza o Documenta o Impressa e On Line Pergunta Existe um indicede f cil acesso Documenta o Impressa e On Line Pergunta O indice amp facilmente compreendido correto e bem editado Documenta o Impressa e On Line Pergunta O ndice utiliza sin nimos e refer ncias cruzadas Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta atende Observa es Resposta atende parcialmente Observa es Cobreapaenas os principais problemas Resposta Atende Observa es Resposta Atende parcialmente Observa es Existem diversas exempks todavia poderia haver mais Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta N o Atende Observa es Resposta N o Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta N o se aplica Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende parcialmente Observa es Apenas dos itens principais Resposta Atende Observa es Resposta Atende parcialmente Observa es O indice amp simples e pobre de recursos P gina 2 127 Data 21 05 2004 SAQDSO Relat rios de Avalia es Documenta o Impressa e On Line Perg
122. naaeas asa ne ananaaananad 20 Consulta de Avalia es iseseeeareranarereaananaanaaanaresaa nana anananananere nas ananaaana ras ananaa 23 MEMICAS siriarrei a E E aaa RAEE EEA TA AE A daesaas zen cin spasasldss 24 C lculo do Percentual de Conformidade casaca siaaisas cura diaacansaacassanandESU dgadaSAnGUaNaS E uagidvacagnasa 25 Op es de Impress o de Relat rios ieeeseeeneeeererereeeeaaeneerereresseenaaaenenareseananaa 26 REDOC PrEVIEW isa Asses rias assanico Pesca DEada Eni ao REGE PR aaa ASAA E ARAE EA AAE Dana DANE EE AEAEE 29 Suporte ao UsU FiO caissara a ia araia E EA I Danda Ea a iaaea aa Er 31 FAQ Perguntas Feitas Frequentemente iseeerreraeeerenasaenranannnan aaa nnan Ennn 32 EITOS P E E E E E E E E E E E E E T T E ne d is 34 EE a a EA E E E E E E 36 87 Apresenta o O SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software tem como objetivo realizar a avalia o da documenta o de software afim de assegurar a Conformidade com a Normas ISO TEC 18019 2004 Software and System Engineering Guidelines for the Design and Preparation of User Documentation for Application Software A seguir pode se ver a tela inicial do SAQDS que constitu da de um menu mais acima e de uma barra de ferramentas mais a esquerda da tela SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software Cadastros Avalia o Relat rios Ajuda SAQDS Sistema de Ava
123. nforma o particularmente importante quando se trata de uma conjunto de instru es d caso nenhum dos artif cios citados estiver dispon vel considere a possibilidade de dividir os t picos para que os mesmos possam ser visualizados um ap s o outro utilizando se de menus para exibir o conjunto dos t picos e marcas para mostrar 47 quais t picos j foram visualizados 2 4 18 ACESSANDO NOVAMENTE A INFORMA ES E importante permitir que os usu rios possam voltar a ver informa o visualizada previamente tanto no di logo corrente ou de uma sess o a outra As informa es contexto sensitiva devem ser acess veis novamente quando do retorno ao mesmo contexto todavia isso depende do usu rio lembrar a segii ncia de a es tomadas para chegar nesse contexto E recomend vel para se acessar a mesma informa o em um dialogo corrente a fornecer um controle da navega o para retornar a t picos anteriores b permitir que o usu rio possa retornar a qualquer t pico antes acessado na caixa de di logo corrente Quando poss vel deve se aplicar as seguintes t cnicas para que os usu rios possam acessar novamente por t picos iguais a manter um lista acumulativa de t picos que o usu rio acessou de sess es anteriores e posteriores e permitir que o usu rio possa acessar esta lista b permitir que os usu rios possam criar marcas para retornar a um t pico espec fico como por exemplo atalhos ou qualquer outro
124. ns o e interpreta o dos documentos normativos por exemplo causando por diversas vezes entendimentos divergentes entre requisitos da norma b segundo a ltima pesquisa sobre documenta o de software do Minist rio da Ci ncia e Tecnologia MCT 2001 que apresentada posteriormente Tabela 5 nota se que existe uma defici ncia na documenta o dos software existentes no 15 mercado Adicionalmente o presente trabalho poder ser utilizado pelo Laborat rio da Qualidade de Software o qual est em implanta o no Departamento de Sistemas e Computa o Em termos de melhoria da qualidade dos softwares da regi o o presente trabalho poder ser utilizado como um guia para que a comunidade de desenvolvimento de software melhore a documenta o de seus sistemas e desta forma aumente o grau de satisfa o de seus clientes 1 3 ESTRUTURA DO TRABALHO O cap tulo inicial apresenta uma introdu o ao tema incluindo os objetivos e organiza o do trabalho O segundo cap tulo apresenta uma abordagem sobre qualidade num mbito geral seguido por qualidade de software e se aprofundando em qualidade na documenta o de software O terceiro cap tulo apresenta o desenvolvimento do software come ando pela especifica o e seguindo at a implementa o demonstrando sua opera o e funcionalidade adicionalmente traz a an lise dos resultados obtidos na realiza o da auditoria tradicional realizada por aud
125. nta o Impressa e On Line Pergunta Os par grafos est o claramente separados Documenta o Impressa e On Line Pergunta Existem listas sendo utilizadas quando necess rias Documenta o Impressa e On Line Pergunta As listas s o consistentes Documenta o Impressa e On Line Pergunta Existem listas apresentadas na forma de listas numeradas quando a sequ ncia sefaz importante Documenta o Impressa e On Line Pergunta Existem listas apresentadas na forma de marcadores quando a sequ ncia n o sefaz importante Documenta o Impressa e On Line Pergunta Existem tabelas sendo utilizadas apropriadamente Documenta o Impressa e On Line Pergunta Existem r guas e bordas sendo usadas consistentemente Documenta o On Line Pergunta A apresenta o amp simples Documenta o On Line Pergunta Anota es podem ser distinguidas facilmente Documenta o Impressa Pergunta O texto pode ser lido facilmente Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta N o Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta N o Atende Observa es Resposta Atende Observa es Documenta o On Line Pergunta A velocidade com
126. ntos 32 4 Os par grafos est o claramente separados 32 5 Existem listas sendo utilizadas quando necess rias 32 6 As listas s o consistentes 32 7 Existem listas apresentadas na forma de listas numeradas quando a sequ ncia se faz importante x x x x x x x Xxx x x x XxX XxX x x x x x x 32 8 Existem listas apresentadas na forma de marcadores quando a sequ ncia n o se faz importante 122 APLICA O CHECK LIST DOCUMENTA O DE SOFTWARE 04 de 04 ON LINE IMPRESSA X X 32 9 Existem tabelas sendo utilizadas apropriadamente X X 32 10 Existem r guas e bordas sendo usadas consistentemente X 32 11 A apresenta o simples X 32 12 Anota es podem ser distinguidas facilmente X 32 13 O texto pode ser lido facilmente 33 Apresenta o das Ilustra es X 33 1 A velocidade com que as ilustra es s o exibidas adequada X X 33 2 As ilustra es podem ser visualizadas juntamente com o texto que as referenciam X X 33 3 As linhas exibidas s o grossas o suficiente para serem notadas x x 33 4 O texto da ilustra es grande o suficiente para ser compreendico pelos menos 3mm para letras mai sculas X 33 5 O usu rio pode imprimir as ilustra es X 33 6 Existem reas de ativa o atalhos nas ilustra es claramente identificadas x 33 7 Para documentos que necessitam serem impressos tanto as ilustra es linhas e t
127. o ela cont m Por exemplo se for tarefa o t tulo deve ser algo do g nero Com fazer para ou Instru es Quando for poss vel forne a o nome da tarefa incluindo uma indica o a que processo ela pertence c utilizar diferentes s mbolos para diferentes tipos de informa o Quando da escolha do m todo que ir ser utilizado recomend vel verificar os tipos de quest es que podem ser respondidas ao usu rios na documenta o on line Quando poss vel utilize t tulos para indicar que quest es v o ser respondidas 2 4 17 POSI O ATUAL EM UM T PICO Caso um t pico seja muito extenso a modo de n o poder ser visualizado completamente em uma janela quando poss vel forne a ao usu rio uma maneira clara de saber onde ele se encontra no contexto do t pico recomend vel aplicar os m todos seguintes onde for apropriado utilizando ao menos um m todo para cada t pico a estruturar t picos do mesmo tipo da mesma maneira dessa forma os usu rios sabem onde procurar certos tipos de t picos Por exemplo a descri o de um t tulo de uma tarefa como Prop sito Instru o Tarefas Relacionadas b enumerar os t tulos dos t picos dessa forma os usu rios poder o saber em que parte da estrutura ele se encontra c utilizar barras de rolagem ou qualquer outro indicador como por exemplo n meros de se o ou marcadores de fim de texto para mostrar ao usu rio o quanto perto ele se encontra do final da i
128. o em cones a menos que quando de uma tradu o ele possa ser substitu do 64 2 4 29 13 2 ESCOLHA DE UM CONE GR FICO importante selecionar um cone gr fico cuidadosamente evitando interpreta es amb guas Por exemplo se uma ilustra o de uma impressora for utilizada na documenta o on line o usu rio pode ficar confuso quanto da sua fun o se serve para obter a informa o que consta on line sobre a impressa se exibe informa es sobre onde encontrar a informa o na documenta o impressa ou at mesmo se a informa o que esse cone fornece trata a respeito de como utilizar a impressora e os recursos de configura o de impress o Quando a aplica o for para uso internacional deve se ter a m xima aten o quanto a sua audi ncia tendo em vista as diferentes culturas 2 4 29 13 3 EXIBINDO O NOME DOS CONES recomend vel considerar os seguintes aspectos na exibi o dos nomes dos cones a se sua exibi o n o compromete a disposi o da informa o como um todo b se o nome ir tornar o cone f cil de memorizar com o tempo se tornando usual c se o usu rio poder escolher ilustra es alternativas para os cones d se os nomes ser o traduzidos quando da necessidade de outro idioma 2 4 29 14 APRESENTA O DE ILUSTRA ES Quando da apresenta o de diagramas e ilustra es importante adotar alguns padr es quanto as linhas e sua disposi o a densidade d
129. ocabul rio amp apropriado ao p blica alvo Documenta o Impressa e On Line Pergunta A maioria das palavras nos vacabul rias s o simples e f cil compreens o Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es 129 2105 2004 Documenta o Impressa e On Line Pergunta A forma de escrever est cometa Documenta o Impressa e On Line Pergunta A gram tica est correta Documenta o Impressa e On Line Pergunta Os verbas est o empregados corretamente Documenta o Impressa e On Line Pergunta As instru es est o na forma imperativa Documenta o Impressa e On Line Pergunta A pontua o amp adequada Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Documenta o Impressa e On Line Pergunta O tamanho das frases amp vari vel Documenta o Impressa e On Line Pergunta A maioria das frases amp pequena e desimples compreens o Documenta o Impressa e On Line Pergunta A maicria dos verbas amp transitivo Documenta o Impressa e On Line Pergunta O texto dirigido ao leitor na segunda pessoa Documenta o Impressa Pergunta A escrita amp concisa Documenta o Impressa e On Line Pergunta As frases levam o usu rio a conhecer aque ele n o sabia Documenta o Impressa e On Line Pergunt
130. ocumenta o on line bem completo e na documenta o impressa inexiste d ainda alguns requisitos da avalia o n o se aplicaram a documenta o avaliada como por exemplo os requisitos aplicados a volumes pois nesse caso a documenta o impressa se encontra em um nico documento 78 Dessa forma pode se dizer que a documenta o elaborada apresenta alguns itens que podem ser melhorados e outros que devem ser corrigidos no caso de uma nova vers o da documenta o A avalia o completo e em detalhes se encontra no Ap ndice E 79 4 CONCLUS ES Com base nos resultados obtidos pode se concluir que o check list elaborado vai ao encontro dos resultados obtidos na forma de auditoria tradicional e pode ser utilizado como apoio na avalia o da documenta o de software Outra vantagem da avalia o pelo check list que o mesmo torna a avalia o sistem tica e com resultados estat sticos mensur veis Pode se concluir ainda que em rela o aos objetivos espec ficos o software desenvolvido atrav s do qual a avalia o realizada pode contribuir para a melhoria da documenta o j que ajuda o usu rio no conhecimento dos itens da norma relacionada qualidade da documenta o de software Adicionalmente foi realizado a avalia o da documenta o de do software desenvolvido o manual impresso e on line no pr prio software afim de verificar a sua conformidade O resultado obtido foi de 95 3 de confo
131. ode se ver um exemplo de descri o de uma tarefa com elementos destacados tais como o nome da tarefa objetivo pr requisitos instru es e t picos relacionados Para cada item consta uma pequena descri o com informa es expostas de forma clara para que o usu rio possa tomar a decis o de usar tarefa ou ainda para exclarer alguma d vida em rela o a sua utiliza o 30 Nome da Tarefa L Criando um novo contato Obietivo Criar um novo contato quando voc encontra uma pessoa de uma J companhia que n o esteja cadastrada no sistema A companhia do cliente deve estar cadastrada no sistema Pr Requisitos Antes de entrar em contato use Entidade gt Abra a pesquisa e procure pelo sobrenome para garantir que ele n o esteja registrado Para criar um novo contato 1 Selecione o registro do nome da companhia 2 Selecione Contato gt Novo Contato 3 O sistema ira gerar uma janela com os tipos de contato selecione Contato e precione o bot o OK 4 O sistema ir abrir uma nova janela com os items a serem preenchidos referentes aos detalhes do contato 5 Fleche a janela e salve seu novo contato Instru es Veja tamb m T picos Relacionados Como organizar seus contatos Como apagar um contato Fonte adaptado de ISO IEC International Organization For Standardization International Electrotechnical Commission 2004 p 64 Figura 4 Exemplo da descri o de uma tarefa com os elementos de
132. or Software EIA IS Electronic Interim Alliance Interim Standard 731 e IPD CMM Integrated Product Development Capability Maturity Model b PMBoK Project Management Body of Knowledge um conjunto de Conhecimentos em Ger ncia de Projetos O PMBoK utilizado como refer ncia para que os gerentes de projetos possam compreender os ensinamentos e relacionamentos que por meio das reas de conhecimento e de processos preconizados pela metodologia traduzem os conceitos mais atuais da pr tica de Gerenciamento de Projetos no mundo c SWEBoK Software Engineering Body of Knowledge um guia de uso e aplica o das melhores pr ticas de engenharia de software Segundo os modelos normas apresentados pode se constatar que todos apresentaram evolu o com o passar dos anos em rela o sua ado o e ao conhecimento pelas empresas de software 2 2 EVOLU O DA QUALIDADE DE SOFTWARE A qualidade de software vem apresentando evolu es ao decorrer dos anos pode se acompanhar as evolu es conforme a Tabela 3 Tabela 3 Evolu o da qualidade do produto software Per odo Descri o 1950 A qualidade era vista simplesmente como uma verifica o de que o produto estava pronto 1960 Inclu da a atividade de testes 1970 Inclui se a verifica o do cumprimento de normas definidas para as diversas atividades 1980 O controle da qualidade de software visualizada como uma atividade de todo o ciclo de vida
133. otas a Tabela 7 traz em detalhes os valores adotados para cada caso Tabela 7 C lculo do percentual de conformidade Requisitos Valor Porcentagem Valor Notas Valor Atende 100 0 0 0 0 Atende Parcialm 50 20 20 1 10 N o Atende 0 40 40 2 20 N o se Aplica 60 60 3 30 80 80 4 40 100 100 5 50 N o se Aplica 6 60 7 70 8 80 9 90 10 100 N o se Aplica A coluna valor apresenta o peso no c lculo de cada resposta conforme a m trica escolhida Em ambos os casos caso o valor selecionado seja N o se Aplica a pergunta n o 75 far parte na estat stica final logo n o possui valor Por exemplo no caso de 5 perguntas duas delas foram respondidas como Atende uma delas como Atende Parcialmente e duas como n o se aplica logo temos 100 x 2 50 x 1 250 3 83 33 de percentual de conformidade pois as duas perguntas como n o se aplica n o entram no c lculo EA SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software9 SAQDS Conculta das Avalia PEIES Cadastros Avalia o Relat rios Ajuda Avaliador Percentual de Conformidade Sofia da Rocha Software Flash MX Informa es Adicionais Avalia o da nova vers o do Macromedia Flash Data 19 05 2004 elelee Ele TE Categoria Informa es Gerais Documenta o Impressa e On Line Pergunta No caso de impress o da
134. plica Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es Documenta o Impressa Pergunta Existe refer ncia cruzada entre documentos separados Documenta o Impressa Pergunta Existe refer ncia cruzada suficiente entre as se es que contem informa es relacionadas Documenta o Impressa Pergunta A refer ncia cruzada amp apropriada Documenta o Impressa Pergunta A refer ncia cruzada necess ria Documenta o Impressa Pergunta A refer ncia cruzada de f cil localiza o Resposta N o se aplica Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es Documenta o Impressa e On Line Pergunta Os temos e abreviaturas est o definidos onde h necessidade Resposta Atende Observa es P gina 4 Data SAQDSO Relat rios de Avalia es Documenta o Impressa e On Line Pergunta Os temos s o utilizados com consist ncia Documenta o Impressa e On Line Pergunta O v
135. poss vel ter uma vis o macro do software como um todo Avaliador o Avaliador Ooo Perguntas ci 0 Documentos i Software Respostas ba Avalia o a Relat rio de Perguntas Relat rio dos Avaliadores Relat rio das Avalia o Relat rio dos Softwares Se po ag Figura 13 Diagrama de contexto 3 6 DIAGRAMA ENTIDADE E RELACIONAMENTO Softwre para auxiliar na avalia o da qualidade de documenta o de software O Diagrama de Entidade e Relacionamento DER um diagrama utilizado para detalhar associa es entre entidades e dados do sistema A Figura 14 apresenta o Diagrama de Entidade Relacionamento L gico e a Figura 15 o Diagrama de Entidade Relacionamento F sico Avaliador Avalia o Cd Aval lt pi gt lt M gt B A Cd_A o lt pi gt lt M gt XY Nome Aval VA150 P Com A o VA250 k ma gaue Possui Respostas EA aal Pai Realiza Avalia o Data A o D Sa umero sho Ava Pi Resultado_A o VA250 OE Cidade Aval VA100 Pi N Bairro_Aval VA100 ID_CD_Acao lt pi gt Resposta CEP_Aval VA50 Op_Resposta VA250 Telefone_Aval VA50 Q Com Resposta VA250 Estado Aval VADO ID CD Aval i 7 ua Possui Avalia o V Documento O Possui Perguntas Cd_Documento lt pi gt lt M gt Possui Documentos al Aa Desc Documento VA250 ES Tipo_Documento VA150 Softwar
136. pressa amp adequado a adversidades ambientais tais como locais unidas e sujos Documenta o Impressa Pergunta Ao menos que se necessite de outra cor em especial o papa utilizado amp branco Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Documenta o Impressa Pergunta O kyout das p ginas simples Documenta o Impressa Pergunta As p ginas possuem numem ockra Resposta Atende Observa es Resposta Atende Observa es P gina 8 Data SAQDSO Relat rios de Avalia es Documenta o Impressa Pergunta Existem elementos comuns as p ginas dispostos na mesma posi o em cada p gina Resposta Atende Observa es 142 0207 2004 Documenta o Impressa Pergunta As se es principais come am sempre em uma p gina nova Documenta o Impressa Pergunta Os tituks das se es s o chms Documenta o Impressa Pergunta As se es est ockramente distinguidas umas das outras Documenta o Impressa Pergunta Assuntos simires s o apresentados com similares kayouts Documenta o Impressa Pergunta O layout das se es amp apropriado para a informa o contida neles Documenta o Impressa Pergunta Existe espa o em branco suficiente na p gina a modo dela n o parecer cheia demais Respost
137. projeto 137 31 6 Identifica o de risco 42 9 7 Manual de treinamento 206 47 5 Manual do sistema 256 59 0 Manual do usu rio 298 68 7 Plano de conting ncia 57 13 1 Plano de controle da qualidade 65 15 0 Plano de testes 153 35 3 Projeto do sistema 202 46 5 Registro formal de revis es e testes 131 30 2 Relat rio de teste 139 32 0 Outras 8 1 8 N o adota documenta o 19 4 4 Base 434 100 Fonte adaptado do MTC 2001 Pode se inferir com base na pesquisa acima que existe uma defici ncia consider vel na rea de documenta o de software no Brasil desde os documentos mais b sicos como o manual do usu rio e help on line at a documenta o t cnica como a especifica o e o projeto de sistema 2 4 1 FORMAS DE DOCUMENTA O Conforme a norma ISO IEC International Organization For Standardization International Electrotechnical Commission 2004 p 8 9 existem diversas formas de classificar a documenta o de software 24 a documentos agregados que s o enviados como parte integrante do software ajuda contexto sensitiva assistentes material que aparece automaticamente sem requisi o do usu rio caixas de ajuda etc b documenta o avulsa que fomecida de forma independente do software manuais impressos arquivos de ajuda que n o s o contexto sensitivo p ginas de suporte na Internet documenta o que disponibilizada apenas para leitura visualiza o ou em arquivos eletr n
138. r exibida na mesma janela O sinalizador um caractere que possui um destaque gr fico se diferenciando do caractere comum e dos estilos utilizados na documenta o recomend vel utilizar sinalizadores para a ajudar os usu rio a compreender onde ele se localiza na estrutura da documenta o b sinalizar um tipo de informa o em especial como a explica o de alguma instru o t pico ou conceito 2 4 29 13 1 DESIGN CONES OU SINALIZADORES Quando for trabalhar com o design de cones ou sinalizadores importante considerar os seguintes itens a o cone n o pode tirar a aten o do usu rio todavia o mesmo deve ser grande o suficiente a modo de permitir sua sele o facilmente b utilizar se de imagens que representam o ato no mundo real por exemplo se existir um cone de sair pode se utilizar uma figura de uma porta aberta no cone c n o deve se utilizar ilustra es e cones que possam ser facilmente confundidos diferencia os claramente d utilizar os cones e sinalizadores consistentemente como por exemplo cores forma localiza o gr fica No caso do software se utilizar de s mbolos ou cones espec ficos a utilizar os mesmos s mbolos ou cones na documenta o impressa b n o deve se utilizar s mbolos ou cones para a mesma fun o ou objeto c padronizar os cones e letreiros para toda a documenta o utilizando os consistentemente d n o deve se utilizar text
139. ra o para Editar Registro Grava Registro quando em modo de edi o Cancela Edi o de um registro quando em modo de edi o Atualiza Dados de que s o exibidos AA 97 Cadastro de Avaliadores Nessa janela realiza se o Cadastramento de Avaliadores A seguir defini se todos os campos Nome Campo onde deve ser cadastrado o nome do Avaliador Endere o Campo onde deve ser cadastrada o nome da Rua Avenida do Avaliador Numero Campo onde deve ser cadastrado o n mero do Endere o do Avaliador Bairro Campo onde deve ser cadastrado o nome do Bairro do Avaliador Cidade Campo onde deve ser cadastrado o nome da Cidade do Avaliador Estado Campo onde deve ser selecionado o nome do Estado do Avaliador CEP Campo onde deve ser cadastrado o n mero do CEP do Avaliador Telefone Campo onde deve ser cadastrado o c digo DDD da Cidade e o n mero do telefone do Avaliador f SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software SAQDS Cadastro dos Avaliad E3 Kd Cadastros Avalia o Relat rios Ajuda ftidriano da Silva Soares Endere o N mero Pua das Palmeiras 200 Cento Cidade Estado CEP Curitiba Paran i 70500 390 Tefefone jn 5200 1250 98 Cadastro de Perguntas Nessa janela realiza se o Cadastramento de Perguntas A seguir defini se todos os campos Pergunta Campo onde deve ser cadastrado a Pergunta Categoria
140. ra ou termo que deseja pesquisar sem ter que descolar o cursor at l importante evitar os seguintes itens em se tratando de buscas a mecanismos de busca que tragam toda e qualquer ocorr ncia de uma palavra alguma sele o de um conjunto de assuntos encontrados ser necess rio b buscas que fornecem a mesma informa o que se encontra em menus ndices ou listas de conte do 2 4 15 NAVEGA O PELO USU RIO No caso da navega o pelo usu rio quando for poss vel forne a tais facilidades aos usu rios a escolher o n vel de informa o que exibida se existir diferentes n veis dispon veis b salvar detalhes de um contexto corrente para que possa ser restaurando Por exemplo se v rias tarefas s o necess rias para uma atividade permita que o usu rio possa sair da parte de navega o e que possa retornar mais tarde c nomear se es da documenta o on line para que o usu rio possa ir diretamente a parte que lhe interessa 46 2 4 16 IDENTIFICA O DA INFORMA O CORRENTE importante tornar bvio para o usu rio o assunto da informa o exibida e de que tipo de informa o que se trata adicionalmente deve se utilizar as seguinte t cnicas para garantir a identifica o da informa o corrente a exibir a informa o pr ximo a um objeto por exemplo ao lado ou em baixo de um cone ou um campo b exibir o t tulo de identifica o da janela para explicar que tipo de informa
141. rabalho e os propriet rios de tarefas poder o us lo ao trabalharem em atividades ou as supervisionarem poss vel dizer quem est on line ou off line no Sametime expandindo as listas de grupos e examinando as listas de pessoas em v rias caixas de di logo do Lotus Workflow Architect Lotus Workflow Viewer ou Lotus Workflow Web Viewer Tamb m poss vel obter uma vis o abrangente de quem est on line ou off line no Sametime Abra a biblioteca Objetos comerciais e selecione Exibir por hierarquia Essa exibi o pode ser feita por Departamento Grupo de trabalho ou Atribui o Nessas exibi es poss vel ver listas abrangentes de pessoas no site O cone ao lado do nome da pessoa indica seu status no Sametime e Quando uma pessoa estiver ativa no Sametime um quadrado verde aparecer ao lado de seu nome Figura 10 Exemplo de menu com estrutura hier rquica de dois n veis 42 E Geralmente os menus exibem a informa o em janelas ou quadros que s o substitu dos quando um item selecionado dentre os dispon veis Por exemplo se n o poss vel prever o que o usu rio quer em determinado est gio de um processo exibi se um menu que o permite escolher a op o mais apropriada para a ocasi o Os menus podem ser apresentados das seguintes formas a uma lista ou um conjunto de listas b um diagrama de ilustra es que destaca diferentes n veis de informa o 43 c uma
142. re aborda a estrutura da documenta o 3 Descri o das Tarefas X X 3 1 _ Existe uma descri o de cada tarefa que o usu rio possa utilizar X X 3 2 Existe uma descri o das tarefas que est o agrupadas dentro dos processos 4 Descri o de Campos do Software X X 4 1 Todos os campos de entrada de informa o do software est o devidamente explicados X X 4 2 Todas as op es dos campos de entrada de informa o est o claras X X 4 3 As informa es sobre os diferentes tipos de campos de entrada da informa o est o claras 5 Elementos da Interface do Usu rio X X 5 1 Todos os elementos da interface do usu rio est o devidamente explicados 6 Fun es da Aplica o X X 6 1 Todas as fun es do software est o descritas 7 Mensagens X X 7 1 As mensagens est o devidamente explicadas quando necess rio 8 Termos x x 8 1 Todos E termos utilizados est o definidos na documenta o ou j s o de uso familiar do usu rio X X 8 2 A terminologia utilizada consistente 9 Conceitos X X 9 1 Todos os conceitos importantes est o explicados 10 Aproveitamento X X 10 1 Existem informa es de como explorar recursos avan ados do software 11 Perguntas e Problemas X X 11 1 _A documenta o responde perguntas que os usu rios possam ter X X 11 2 Existe alguma solu o de problemas descrita quando necess rio X X 11 3 A solu o de problemas cobre todos os problemas que o usu rio possa vir a ter X X 11 4 A solu o de problema
143. res t m investido na busca de melhorias n o somente para diminuir os problemas decorrentes de baixa qualidade de seus processos de desenvolvimento e consequentemente do produto final mas tamb m para alcan ar melhores resultados financeiros com o aumento da produtividade e consegiiente diminui o de prazo de entrega de seus produtos e maior satisfa o de seus clientes Desenvolver um produto de software e coloc lo no mercado n o suficiente para competir em igualdade de condi es com as empresas l deres do mercado E essencial que haja uma preocupa o com a qualidade de todo o pacote de software Assim visando a satisfa o do cliente as empresas que desenvolvem produtos de software buscam em documentos normativos e metodologias adotadas a adequa o de seus processos produtos com vistas a conseguir um diferencial competitivo A qualidade em empresas de software pode ser aplicada em diversas reas tais como desenvolvimento implementa o testes suporte documenta o etc No caso da documenta o de software o que se observa em geral a baixa prioridade dada a esta quest o Essa realidade resultado dentre outros aspectos da desmotiva o de programadores e analistas com a elabora o da documenta o do software e do pequeno n mero de bibliografia voltada especificamente ao assunto 14 dentro deste contexto que se enquadra o presente trabalho cujo objetivo desenvolver um software de
144. rmidade com a norma ISO IEC 18019 2004 dessa forma pode se concluir como atingido mais esse objetivo espec fico Pode se ver a avalia o completa dessa documenta o de software no Ap ndice E Tamb m importante ressaltar que a documenta o de software requer um grande esfor o na sua elabora o muitas vezes necess rio profissionais espec ficos para determinadas etapas do processo de elabora o e isso nem sempre est dispon vel a empresas de m dio e pequeno porte todavia o presente trabalho serve como um guia para que aos poucos a documenta o de software se torne mais sistem tica e com um padr o que favore a tanto os usu rios quanto s empresas A realiza o desse trabalho num mbito pessoal possibilitou ampliar os meus conhecimentos na rea de documenta o a qual j venho atuando profissionalmente h algo tempo adicionalmente a elabora o do check list possibilitou um aprendizado na parte de an lise de requisitos normativos que poder ser utilizado no futuro quando da atua o em auditorias 4 1 EXTENS ES Conforme citado anteriormente o presente trabalho n o aborda a parte de planejamento e or amento da documenta o de software todavia ela tamb m faz parte da norma ISO IEC 18019 2004 dessa forma uma extens o desse trabalho pode ser o 80 desenvolvimento de um software que fornecesse apoio a esse planejamento e or amento da documenta o de software Outra extens o seria tomar
145. rre eee mesmas 23 2 4 2 FATORES A SEREM CONSIDERADOS NA ESCOLHA DA DOCUMENTA O 24 2 4 3 DISPOSI O DA INFORMA O iemeeaeemeeeaeeea eee 24 2 4 3 1 INFORMA O ON LINE quase RSA RNA ad 24 2 4 3 2 INFORMA O IMPRESSA iii spo da Sd 25 2 4 3 3 INFORMA O ON LINE OU IMPRESSA ieemeeemeeeeemeemereemeees 25 2 4 4 CRIT RIOS PARA ELABORA O DA DOCUMENTA O nsss 26 2 4 4 1 DIREITOS E VERS O DO PRODUTO eee eee meneame 26 2 4 4 2 VIS O GERAL DA DOCUMENTA O seem ereemereemeeem 27 2 4 4 3 DESCRI O DE PROCESSOS u cus iannarsa dia ar EL 28 2 4 4 4 DESCRI O DE TARERAS uu sine Se Sa AAA SS ra a 29 2 4 4 5 EXPLICA O DE CAMPOS E OP ES seem eee 30 2 4 4 6 NOMES DAS OP ES DA INTERFACE DO USU RIO 31 2 4 4 7 DESCRI O DAS FUN ES DO SOFTWARE iieeemeememeememes 31 2 4 4 8 MENSAGENS INFORMATIVAS eee eee 33 DA A 8I FORMATO dE US RR A O a E O TO E 33 2 4 4 9 MENSAGENS ON LINE eee eee mereemeereeme eee erre eee eeeeneereems 34 24491 APRESENTA O semanais A A 34 24492 TERMINOLOGIA sree nnne coa OS CO RG Ra O 35 2 4 5 DEFINI ES DE TERMOS usas faia cr esa id Rd a ad ua 36 ZAG CONCEITOS canto E AE EE T A AT OE S 37 2 4 7 EXPLORA O DA INFORMA O quad na Rd Aa ara 37 2 4 8 PERGUNTAS FEITAS FREQUENTEMENTE FAQ eee 38 2 4 9 CONTE DO PERSONALIZADO PELO USU RIO 39 PAO NAVEGA O saca bala A an o a e dad 39 2 4 10 1 ACESSANDO
146. s Lotus Notes File Edit View Actions AO ndice Pesquisar WES viso de copyright Informa es de licen a Migra o de vers es anteriores Sobre o Lotus Workflow 3 0 O que h de novo no Lotus Workflow 3 0 Quem usa o Lotus Workflow Quem deve usar esta documenta o designers de proce Sobre o banco de dados Diret rio da organiza o Atribui o de substitutos Cria o de um perfil de aus ncia do escrit rio Conceitos e termos chave Defini o de prefer ncias do Sametime Conex o com o Sametime Desconex o do Sametime In cio de um bate papo do Sametime b Sobre os bancos de dados do Lotus Workflow gt Sobre os exemplos do Lotus Workflow gt Sobre a estrutura o de processos Gloss rio Manual de solu o de problemas KO ioj xi Sobre o Sametime no Lotus Workflow O Sametime um produto da Lotus que permite a conex o instant nea entre as pessoas para bate papos on line e encontros para compartilhamento de aplicativos Se o administrador do Notes ou do Lotus Workflow tiver instalado e ativado o Sametime para Lotus Workflow ser poss vel bater papo com qualquer pessoa que tenha o Sametime e esteja on line O Sametime til para obter informa es de propriet rios de atividade em potencial e reais membros de equipes propriet rios de tarefas supervisores etc Os designers de processos poder o usar o Sametime ao criarem ou modificarem estruturas de processos os participantes do fluxo de t
147. s informa es sobre o suporte voc encontra no cap tulo de Suporte ao Usu rio 115 Erros O SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software possui uma s rie de controles de erros que possam ocorrer a seguir segue as mensagens que podem ocorrer quando da utiliza o do mesmo Cadastramento de Auditores o usu rio esqueceu de preencher algum item obrigat rio Todos os campos para cadastrar o Avaliador s o obrigat rios Favor preencher novamente todos os campos e tentar novamente Cadastramento de Perguntas o usu rio esqueceu de preencher algum item obrigat rio T Todos os campos para cadastrar a Pergunta s o obrigat rios Favor preencher novamente todos os campos e tentar novamente Cadastramento de Documentos o usu rio esqueceu de preencher algum item obrigat rio Algum campo obrigat rio n o foi preenchido a grava o n o pode ser efetuada Favor preencher os campos obrigat rios Software Nome Tipo Data e tentar novamente amp lgum campo obrigat rio do cadastro de Softwares n o foi preenchido Favor preencher novamente os campos obrigat rios Empresa e Nome e tentar novamente 116 Registro de Avalia es o usu rio esqueceu de preencher algum item obrigat rio Registro de Respostas o usu rio esqueceu de preencher a op o da resposta Para quaisquer outra mensagem de erro encontrada sugerimos entrar em contato
148. s fornece a solu o efetiva do problema 12 Exemplos X X 12 1 Existem exemplos suficientes X X 12 2 Os exemplos s o adequados X X 12 3 Os exemplos propostos s o apresentados com consist ncia 13 T tulos e Chamadas de Ajuda x x 13 1 Os t tulos e as chamadas de ajuda para ilustra es tabelas fotografias e outros elementos gr fico s o efetivos e consistentes 14 Conte do do Usu rio X 14 1 O usu rio tem a possibilidade de realizar anota es de texto na documenta o X 14 2 Se for poss vel o texto original pode ser recuperado 15 Navega o X 15 1 E f cil de encontrar a documenta o desejada X 15 2 Os m todos de acesso s o consistentes X 15 3 E f cil a sa da da documenta o X 15 4 Cada usu rio possui os documentos que necessita 16 Encontrando a Informa o Correta X 16 1 Existe o acesso contexto sensitivo X 16 2 A informa o exibida decorrente do acesso contexto sensitivo correta X 16 3 Existem t picos de f cil localiza o X X 16 4 Existe um ndice de f cil acesso X X 16 5 O ndice facilmente compreendido correto e bem editado X X 16 6 O ndice utiliza sin nimos e refer ncias cruzadas x x 16 7 O ndice desenhado do ponto de vista dos leitores ou seja de acordo como eles acessam a informa o X 16 8 A velocidade de acesso ao ndice adequada X 16 9 Est claro em que documentos procurar cada tipo de informa o X 16 10 E f cil encontrar a informa o correta em cada documento
149. sa a coisa certa a ser feita Deve se fornecer a descri o da tarefa para tarefas relacionadas ou similares com uma estrutura comum incluindo os itens a nome da tarefa identificador da tarefa diferencia o entre tarefas b objetivo da tarefa explicando o que pode ser alcan ado realizando a tarefa ou porque a tarefa deve ser realizada c detalhes do que preciso ter antes da realiza o da tarefa bem como o que deve acontecer depois da realiza o da mesma d passo inicial explicar quais s o os pr requisitos e quais s o as entradas necess rias para a realiza o da tarefa e numera o de instru es para segii ncias em cada passo devem ser adotadas f passo final explicar qual ser o resultado da tarefa ou quando a tarefa ir terminar g qualquer pr requisito da tarefa h outras tarefas relacionadas 1 tarefas que podem ser requeridas antes da realiza o da tarefa atual j descri o do processo para qualquer processo que utilize essa tarefa Caso exista um tutorial on line importante disponibilizar o acesso a se o requerida ao usu rio Quando da exibi o da documenta o on line ambos se o software e a documenta o puderem ser visualizados lado a lado aconselh vel n o utilizar figuras do software na documenta o on line se a documenta o on line cobrir ou substituir o software na tela procure incluir figuras com partes do software na documenta o Na Figura 4 p
150. sa e On Line EUR A solu o de problemas fornece a solu o efetiva do problema Docum enta o Impressa e On Line Pergunta Existem exemplos suficientes Documenta o Impressa e On Line Pergunta Os exemplos s o adequados Documenta o Impressa e On Line Pergunta Os exemplos propostos s o apresentados com consist ncia Docum enta o Impressa e On Line Pergunta Os tituks e as chamadas de ajuda para ilustra es tabelas fotografias e outros elementos gr fica s o efetivos e consistentes Docum enta o Impressa e On Line Pergunta O usu riotem a possibilidade de realizar anota es de texto na documenta o Documenta o On Line Kargua Se for possivel q texto original pode ser recuperado Docum enta o On Line Pergunta f cil de encontrara documenta o desejada Documenta o On Line Pergunta Os m tadas de acesso s oconsistentes Documenta o On Line Pergunta f cila saida da documenta o Documenta o Impressa Pergunta Cada usu rio possui os documentos que necessita Docum enta o On Line Pergunta Existe o acesso contexto sensitivo Documenta o On Line Pergunta A informa o exibida decomente do acesso contexto sensitivo cometa Documenta o On Line Pergunta Existem t picas de f cil caliza o Documenta o Impressa e On Line Pergunta Existe um indicede f cil acesso Documenta o Impressa e On Line Pergunta O indice amp facilm
151. serva es Documenta o Impressa e On Line Pergunta Existe somente poucos tipos de fontes utilizadas Documenta o Impressa e On Line Pergunta As fontes utilizadas s o consistentes Documenta o Impressa e On Line Pergunta As fontes s o kegiveis Documenta o On Line Pergunta Existem fontes adequadas sendo utilizada na apresenta o por exemplo Verdana ou Arial Documenta o Impressa e On Line Pergunta Existem diferentes niveis entre os titulos de f cil percep o Documenta o Impressa e On Line Pergunta Os niveis diferentes entre os titubs representam a hieranuia adotada cometamente Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende parcialmente Observa es P gina Data SAQDSO Relat rios de Avalia es Documenta o Impressa e On Line Pergunta A maioria do texto est em escrita com inicio de frases em leta mai sculas e o restante em min sculas Documenta o On Line Pergunta Existem fontes disponiveis na interface do usu rio Documenta o On Line Pergunta Existem letras mai sculas comoo tamanho de pelo menos por 3mm Documenta o On Line Pergunta Sublinhados que cortam letras min sculas s o evitados Documenta o Impressa e On Line Pergunta O m todo utilizado para destacar palavras ou frases cons
152. seseseseeceererorerersrsrss 81 AP NDICE A Manual do usu rio ietieeeeeeeeeeeeeeeeeereeeeeeereeeeeeeeeeeeeeeeeeeeeeeeratnas 83 APENDICE Bi Check A axar seas arara a a RP a 119 AP NDICE C Avalia o dos auditores eeeememereeemeeeeeeeeaeeeereeereeeeeeeteas 123 AP NDICE D Avalia o realizada no software SAQDS eeeeemeememens 125 AP NDICE E Avalia o da documenta o do SAQDS ieeeee meneame 134 13 1 INTRODU O Atualmente n o se pode falar em produtos sem ser mencionada a qualidade que o mesmo possui Grandes corpora es industriais v m trilhando esse caminho da qualidade total h algum tempo Rapidamente este conceito vai se difundindo para outras reas como forma de obter melhores produtos e conquistar novos mercados Segundo Ishikawa 1993 p 43 a defini o da qualidade desenvolver projetar produzir e comercializar produtos com qualidade mais econ micos mais teis e sempre satisfat rios para o consumidor Segundo Paladini 1994 p 17 a qualidade total est completamente direcionada para o consumidor Pela abrang ncia do conceito envolve a todos na organiza o pelo n vel em que se deve colocar a quest o uma das grandes metas da empresa fixada em termos de pol ticas globais Nas empresas de software o caminho n o poderia ser diferente de acordo com Jomori et al 2004 p 45 muitas organiza es que desenvolvem softwa
153. stacados Na descri o de tarefas n o deve se incluir os itens a instru es de uso geral como por exemplo como usar os controles na interface b explica o de ternos gerais caso o usu rio necessite dessas informa es deve se providenciar um m todo de acesso a mesma como por exemplo um atalho ao gloss rio ou a exibi o da explica o em uma janela tempor ria da tela 2 4 4 5 EXPLICA O DE CAMPOS E OP ES Explica o de campos e op es respondem perguntas como estas Para que isso O que eu posso fazer usando isso e O que isso significa importante incluir a explica o da finalidade de cada campo para todos os campos dispon veis adicionalmente deve se fornecer outras informa es que os usu rios possam necessitar tais como a como deve ser realizada a entrada de dados por exemplo usando caixas de sele o bot es selecionando em uma lista ou digitando b quais s o as op es dispon veis c quais s o os valores que devem ser utilizados para escolhas particulares Deve se fornecer explica es dos seguintes itens a campos de condi o ou seja campos que dependem do contexto ou da escolha de 31 outros campos b todas as op es que se aplicam a um campo c da informa o exibida em uma campo d do valor demonstrado em um campo onde esse valor pode ser relacionado com outras possibilidades de valores 2 4 4 6 NOMES DAS OP ES DA INTERFACE DO USU
154. su rio possa adapt lo para suas necessidades por exemplo para poder criar uma tradu o de algum t pico 2 4 28 APRESENTA O DA DOCUMENTA O ON LINE recomend vel dar a apar ncia a documenta o on line um dos itens abaixo a da aplica o b de outros produtos que pertencem ao mesmo pacote c do sistema operacional d outra documenta o on line que o usu rio j se encontra familiarizado importante deixar claro para os usu rio quando a visualiza o da aplica o e quando da visualiza o da documenta o on line para tanto deve se utilizar os seguintes m todos a criar diferentes estilos de janelas b deixar os t tulos claros c utilizar cores diferentes 2 4 28 1 JANELAS As janelas s o partes do software que s o exibidas na tela do usu rio nelas o usu rio pode ter acesso as informa es como por exemplo documenta o on line pode ainda realizar processos e tarefas Geralmente um software composto por um conjunto de janelas que s o exibidas de acordo com as necessidades dos usu rio 52 2 4 28 1 1 RELACIONAMENTO ENTE A EXIBI O DA INFORMA O E DA APLICA O importante analisar o posicionamento ideal da janela em rela o a aplica o conforme a necessidade do usu rio adicionalmente deve se leva em considera o os seguintes itens a caso a informa o seja necess ria o tempo todo n o deve se deixar a janela da informa o desaparecer quando pression
155. tipo de marca c criar um estrutura clara para que o usu rio possa seguir os mesmos caminhos d criar um menu que guarda os ltimos t picos visitados pelo usu rio Em se utilizado de qualquer das t cnicas citadas procurar deix las consistentes e de f cil utiliza o Por exemplo caso existir uma lista que mant m um hist rico de t picos acessados sempre que a mesma estiver dispon vel procure utilizar se dos mesmos m todos no seu acesso 2 4 19 NAVEGA O ENTRE A APLICA O E A DOCUMENTA O Se o usu rio necessitar de informa es durante o uso da aplica o e no caso de n o existir nenhuma facilidade que permita exibir na tela o software e a documenta o on line ao mesmo tempo importante providenciar um meio r pido e de f cil utiliza o para que o usu rio possa fazer um troca entre as telas de documenta o on line e o do software Quando essa troca ocorrer entre software e documenta o on line recomend vel n o permitir que por exemplo o software ou a documenta o seja finalizado sem o consentimento do usu rio 48 2 4 20 IMPRESS O DAS INFORMA ES importante permitir que o usu rio possa imprimir as informa es da documenta o on line selecionado as das seguintes formas a o t pico corrente b uma simples ilustra o c um conjunto de t picos d um gloss rio se o mesmo existir e guia de referencia r pida se o guia dispon vel na documenta o on line for
156. to conjunto pela ISO pela IEC e pelo projeto SPICE tem como objetivo a avalia o de processos da rea de tecnologia de informa o atualmente esta norma est publicada como um relat rio t cnico 19 ISO IEC TR 15504 Os processos propostos por esta norma est o divididos em cinco categorias a cliente fomecedor b engenharia c apoio d ger ncia e organiza o Para se avaliar os processos de uma organiza o cada um deles deve ser classificado em um dos seguintes n veis de capacita o a n vel O incompleto b n vel 1 executado c n vel 2 gerenciado d n vel 3 estabelecido e n vel 4 previs vel f n vel 5 em otimiza o Na Figura 3 apresenta se a evolu o do conhecimento da norma ISO 15504 SPICE pelas empresas de software m1997 m1999 12001 Conhece e usa Conhece mas n o usa N o conhece Fonte Jomori et al 2004 p 46 Figura 3 Conhecimento da Norma ISO 15504 SPICE pela empresas de software De acordo com Jomori et al 2004 p 48 pode se citar outras importantes refer ncias utilizadas pelas organiza es na busca de melhorias nos processos entre outras o CMMI PMBoK e SWEBOK 20 a CMMI Capability Maturity Model Integration um modelo desenvolvido pelo Software Engineering Institute SEI para melhoria da maturidade dos processos de uma organiza o Foi desenvolvido a partir de tr s modelos SW CMM Capability Maturity Model f
157. tos identifica o do software identifica o do produto copyright e condi es de uso pelo consumidor 2 Apresenta somente um sum rio na forma de t picos de ajuda e sistema de buscas sem orienta o de como usar 3 Atende apenas para fun es principais como salvar e fechar 4 Apenas comando b sicos padr o Windows informa es pobres 5 Quando o software finalizado a ajuda continua no ar 6 Permite t pico corrente ou conjunto de t picos contudo esta ltima opera o travou o software 7 Atende parcialmente pois nem sempre indica claramente que tipo de informa o est contida naquela se o 8 Atende parcialmente pois permite a impress o do t pico corrente mas n o a impress o do conjunto de t picos 125 AP NDICE D Avalia o realizada no software SAQDS Data 21 05 2004 SAQDSO Relat rios de Avalia es Software Microsoft Photo Editor 3 0 1 Avaliador Anderson Nicokdelli Informa es Complementares dl da jd on line help Docum enta o Impressa e On Line Pergunta Est claro qual a vers o dosoftuare quea documenta o aborda Documenta o Impressa e On Line Pergunta O nome do fabricante est devidamente identificado Documenta o Impressa e On Line Pergunta A documenta o cont m informa es de onde os usu rios possam encontrar suporte quando necessitarem Documenta o Impressa e On Line tia Existe uma descri o da licen a de usodo software Docu
158. u cone de ajuda Nome de cones Utiliza o dos cones Utiliza o dos campos Defini o de termos Posicionar o ponteiro sobre um objeto espec fico na tela Selecione um objeto na tela por exemplo o principal objeto clique nele utilizando uma diferente t cnica para a ativa o do objeto Descri o de processos Conceitos Explora o da informa o Perguntas feitas frequentemente Vis o geral da aplica o Vis o geral da documenta o Instru es para utiliza o de informa es na tela Livro eletr nico n o acoplado a aplica o Escolha em um menu Procura em uma lista de conte do Procura em um ndice Fonte adaptado de ISO IEC International Organization For Standardization International Electrotechnical Commission 2004 p 76 2 4 11 MENUS Os menus permitem aos usu rios selecionarem itens da informa o desejada on line Normalmente os menus apresentam um ou dois n veis de uma vez na sua estrutura hier rquica Um exemplo de menu gr fico pode ser visto na Figura 9 e um exemplo de menu com estrutura hier rquica de dois n veis pode ser visto na Figura 10 Bem vindo ao CorelDRAW bes Novo gr fico Abrir ltimo editado Abrir gr fico CorelTUTOR O que h de novo Clique em um gr fico para come ar v Mostrar esta tela de boas vindas ao iniciar www designer com Figura 9 Exemplo de menu gr fico Ajuda do Note
159. u rio n o saiba exatamente o vocabul rio que pode ser utilizado para identificar o t pico desejado importante tamb m em se tratando de ndices levar em considera o os itens a permitir que os usu rios possam encontrar informa es procurando por vocabul rios diferentes do que est o citados na documenta o on line e impressa b tornar claro o que cada item que dizer por exemplo se apenas uma simples defini o uma descri o de uma fun o ou tarefa e assim por diante c fornecer m todos simples de sele o dos t picos no ndice na documenta o on line 45 2 4 14 BUSCAS As buscas s o muito teis quando os usu rios necessitam obter ajuda e n o sabem exatamente onde ela se encontra recomend vel levar em considera o os itens em se tratando de buscas a determinar os tipo de busca que ser o disponibilizados ao usu rio baseando se na informa o que os mesmos possam precisar b as buscas podem n o ser apropriadas a usu rios iniciantes Neste caso importante disponibilizar outros m todos de localizar a informa o desenvolvendo os m todos de busca cuidadosamente Adicionalmente importante que sejam disponibilizados recursos completos para usu rios avan ados evitando interfaces e sistemas de busca complexos para usu rios iniciantes c garantir que o cursor esteja localizado na caixa de busca quando de uma busca dessa forma o usu rio pode come ar digitando a palav
160. ue os usu rios possam expandir e contrair os n veis da estrutura das listas de conte do c fornecer um meio para que os usu rios possam acessar o conte do diretamente das listas de conte dos d utilizar t tulos para indicar claramente que informa o est contida em cada se o e utilizar cones para indicar diferentes tipos de informa o em diferentes se es de documenta o ou ainda para indicar diferentes estados dessa documenta o Na Figura 11 pode se ver um lista de conte do parcialmente expandida 44 T picos da Ajuda PowerDesigner General Features Guide Conte do ndice Localizar Selecione o t pico e clique em V deo ou clique em outra guia como por exemplo Indice O PowerDesigner General Features Guide Overview Copyright page WB PART 1 GUI Guide 2 Overview CHAPTER 1 About This Book e CHAPTER 2 PowerDesigner Basic Concepts CHAPTER 3 Using the PowerDesigner Interface QB CHAPTER 4 Using the Browser 8 PART 2 Modeling Guide amp PowerDesigner CDM User s Guide NA PowerDesigner DOM User s Guide PowerDesigner PDM User s Guide PowerDesigner Reports User s Guide a E a x Imprimir Cancelar Figura 11 Exemplo de lista de conte do 2 4 13 NDICES Z E recomend vel fornecer um ndice on line e um impresso para que os usu rios possam tem mais facilidade na utiliza o do software adicionalmente deve se prover ndices onde o us
161. uebra de linhas do texto Para documentos impressos importante aproveitar o m ximo poss vel das linhas assim economizando espa o e folhas quando da impress o dos mesmos 60 24 294 ESPA AMENTO VERTICAL E recomend vel utilizar espa amento vertical acima e abaixo de t tulos para indicar a hierarquia da estrutura do documento Deve se utilizar um espa amento m nimo igual ao espa amento de um par grafo 2 4 29 5 T TULOS EM TEXTO importante utilizar diferentes tamanhos para diferentes n veis de t tulos em um hierarquia Geralmente dois ou tr s tipos de t tulos s o os suficiente para a maioria da documenta o Por exemplo a um tipo para o t tulo dos t picos ou cap tulos b um ou dois tipos para subt tulos de um t pico ou cap tulo recomend vel determinar alguns padr es para os t tulos utilizados a tamanhos diferentes limite se a utilizar dois ou tr s tipos diferentes b negrito e it lico use esses recursos combinados para indicar diferentes tipos de t tulos c cores utilize em conjunto com o contexto de cores aplicados a documenta o d sublinhado evite ao menos se n o houver outro meio dispon vel de expressar a nfase no t tulo desejado 2 4 29 6 DESTAQUES DE TEXTO Se for necess rio destacar algum texto importante criar uma forma que torne esse destaque consistente Os seguintes m todos podem ser aplicados no destaque do texto a negrito adiciona nfase no te
162. undo Deve se evitar cores muito claras ou com efeitos que possam confundir o usu rio Aconselha se a escolher sempre que poss vel um cor neutra para o fundo Deve se ter cuidado quando tiver que exibir ilustra es em um fundo que n o seja branco para n o causar confus o aos usu rio adicionalmente para fins internacionais deve se considerar as diversas culturas dispon veis no caso de combina o de cores 2 4 28 6 4 DESIGN MONOCROM TICO 2 No design monocrom tico importante verificar como os documentos que ir o aparecer no modo monocrom tico ser o efetivamente exibidos na tela e impressos dessa forma assegura se a qualidade da documenta o tanto em cores como no modo monocrom tico 2 4 28 6 5 N MERO DE CORES O n mero de cores aplicadas no software pode variar de acordo com a necessidade de utiliza o entretanto v rias cores podem facilmente distrair a aten o do usu rio do contexto de trabalho levando a perda de produtividade logo recomend vel utilizar duas ou tr s cores diferentes Deve se come ar o design da documenta o no modo monocrom tico e adicionar cores onde necessitar dar nfase 2 4 29 APRESENTA O DO TEXTO A apresenta o do texto trata da forma com que o texto ser exibido para o usu rio desde as fontes empregadas t tulos espa amentos estilos aplicados etc 58 2 4 29 1 FONTES E TAMANHOS E recomend vel utilizar fontes que geralmente s o as mais comuns
163. unta O ndice amp desenhado da ponto de vista das leitores ou seja de acordo coma eles acessam a informa o Documenta o On Line Pergunta A velocidade de acesso ao indice amp adequada Documenta o Impressa Pergunta Est clara em que documentos procurar cada tipo de informa o Documenta o Impressa Pergunta f cilencontrara informa o correta em cada documento Documenta o Impressa Pergunta Existe uma tabela de conte do para cada documento Documenta o Impressa Pergunta Cada tabga de conte do amp de f cil compreens o usual correta e bem editada Documenta o Impressa Pergunta Tantoas refer ncias da tabela de conte dos e das indices s o f ceis de seguir Documenta o Impressa e On Line Pergunta A informa o est estrutura de uma maneira l gica do pontade vista em que a usu ria necessita da informa o Documenta o Impressa e On Line Pergunta A estrutura da informa o est clara e explicada aos usu rios Documenta o Impressa e On Line Pergunta A informa o est dividida em partes adequadas Documenta o Impressa e On Line Pergunta A ordem em que as informa es foram divididas est adequada Documenta o Impressa Pergunta Cada dacumentaou cada parte est estruturada em capitulos ou se es Documenta o Impressa Pergunta f cil encontrar inicio de cada parte e cada capituloou se es Documenta o Impressa Pergunta
164. unta O texto de f cil entendimento Documenta o Impressa e On Line Pergunta Existem metas a serem alcan adas para as instru es Documenta o Impressa e On Line Pergunta Existem pr requisitos nocome o da execu o de alguma instru o Documenta o Impressa e On Line Pergunta Em setratando da hifeniza o ela amp utilizada quando necess rio para evitar mal entendimento Documenta o Impressa e On Line Pergunta Consegue se distinguir os tipos de mensagens exibidas Documenta o Impressa e On Line Pergunta Clich s s o evitados Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Documenta o Impressa e On Line Pergunta Palavras ou letras em leta mai scula s o utilizadas de forma adequada Resposta Atende Observa es Documenta o Impressa e On Line Pergunta As ilustra es s o utilizadas em lugares apropriados Documenta o Impressa e On Line Pergunta Os tipos de ilustra es s o adequados informa o Documenta o Impressa e On Line Pergunta As i
165. utilizado na documenta o impressa adequado a adversidades ambientais tais come locais unidos e sujos Documenta o Impressa Pergunta Ao menos que se necessite de outra cor em especial o papa utilizado amp branco Resposta N o se apli Observa es Resposta N o se apli Observa es Resposta N o se apli Observa es Resposta N o se apli Observa es Resposta N o se apli Observa es Resposta N o se apli Observa es Resposta N o se apli Observa es Resposta N o se apli Observa es Resposta N o se apli Observa es Resposta N o se apli Observa es Resposta N o se apli Observa es Resposta N o se apli Observa es Resposta N o se apli Observa es Resposta N o se apli Observa es Documenta o Impressa Pergunta O layout das p ginas simples Documenta o Impressa Pergunta As p ginas possuem numera ochra Resposta N o se aplica Observa es Resposta N o se aplica Observa es P gina 8 SAQDSO Relat rios de Avalia es Documenta o mpressa Peun E stem elementos comuns as p ginas dispostos na mesm a posi o em cada pagina Resposta N o se aplica Oteerva es 133 Daa 21052004 Documenta o mpressa Pergunk As se es principais com e am sempre em uma p gina nova Documenta o mpressa Pergunk Ostitdos das se es s o
166. uto Levando em considera o todos os pontos levantados nota se que a documenta o de software ganha cada vez mais espa o dentro das empresas de desenvolvimento de software pois a mesma funciona n o somente como suporte ao usu rio mas tamb m como marketing indireto da marca produto Segundo Nayar 2000 p 27 atualmente as pessoas est o cada vez mais conscientes da import ncia da documenta o de software entretanto a documenta o de baixa qualidade ainda persiste no mercado A Tabela 4 apresenta os principais equ vocos ocorridos quando da elabora o planejamento da documenta o de software Tabela 4 Equ vocos da documenta o de software Equ voco Porque Documenta o de software apenas um suporte ao produto Essa id ia errada afeta a documenta o de software pois juntamente com a interface do usu rio a documenta o a parte mais importante do software para os usu rios Documenta o de software escrever tudo sobre o produto significa Como meta realizar toda a documenta o de um software seria admir vel entretanto isso nem sempre poss vel logo a meta deve ser desenvolver a documenta o de software afim de torn lo pr tico o mais simples poss vel de f cil utiliza o e gil na hora de efetuar uma atualiza o Se uma atualiza o inclus o de nova fun o do software deve ser feita a documenta o pode esperar Isso pode gerar
167. va es Resposta Atende Observa es Resposta Atende Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es Resposta Atende Observa es P gina 3 Data SAQDSO Relat rios de Avalia es Documenta o On Line Pergunta O usu riotem a possibilidade de voltar bem como de ir a adiante na navega o Documenta o Impressa Pergunta Os assuntos s o apresentadas em uma sequ ncia l gica em cada documento Documenta o Impressa Pergunta A sequ ncia da informa ode cada parte do decumento corres ponde ao modo que os usu rios precisar utiliz la Resposta Atende Observa es Resposta N o se aplica Observa es Resposta N o se aplica Observa es 128 2105 2004 Documenta o On Line Pergunta Tantoo textaquanto os gr ficos passuem a velocidade de rolagem adequada Documenta o On Line Pergunta Quando da rolagem os titulos continuam sendo exibidas Documenta o On Line Pergunta Existe um sinalizador que
168. verg ncia entre os valores alcan ados pelos auditores maior ser a efetividade do check list e do software O software foi implementado na linguagem de programa o Object Pascal Palavras chaves Qualidade de Software Avalia o Suporte Documenta o ABSTRACT The main objective of this assignment is the conception and the development of a software to support the quality evaluation of software documentation At first it brings a detailed presentation of the standard ISO IEC 18019 2004 Software and System Engineering Guidelines for the Design and Preparation of User Documentation for Application Software standard which will be used as a basement to develop the proposed software In the next step the content of the standard will be used to create the check list in order to make the evaluation more objective Besides the check list the assignment will propose the development of measures which allows the user to quantify the quality of software documentation Once developed the proposed software will be used as a support for three software documentations audits by three different auditors The rate of effectiveness of the check list and the software will be measured by the magnitude of variability among the different evaluations As small is the divergence among the values reached by the audits bigger will be the effectiveness of the software and the check list The software was implemented using the programming language Object Pascal
169. volver janelas flex veis onde a o sistema determina a disposi o padr o das janelas b os usu rios pode personalizar a disposi o das janelas 53 No caso do usu rio necessitar executar uma atividade simultaneamente com a ajuda do sistema janelas com disposi o fixa poder o ser aplicadas tamb m n o deve se encobrir os controles de navega o das janelas quando da sua disposi o 2 4 28 1 4 DISPOSI O DAS JANELAS Quando for poss vel deve se permitir que o usu rio possa definir a pr pria disposi o de suas janelas adicionalmente importante considerar os seguintes aspectos a encobrimento garantir que cada janela seja exibida uma do lado da outra b sobreposi o quando o n mero e o tamanho das janelas que s o exibidas forem v rios e diferentes a resolu o da tela muito baixa desse modo o usu rio pode n o visualizar a informa o realmente relevante em cada janela Na Figura 12 pode se observar um exemplo de sobreposi o de janela Help System Titio AES Window controls Menus e Fie view Heip mno Display and Conis Index T AE E Seah Navigator tabs display in new window icons Text area 325 pixels wide by 440 pixels deep Help System Titio EE 2 Window controls Monus File Go pols UI 4 gt a sed ari a Topic title Robini topis em Related topics n Scroll bar Window size 4
170. ware Engineering Institute SEI para melhoria da maturidade dos processos de desenvolvimento de software O modelo descreve um caminho evolucion rio de melhoria de maturidade por meio do atendimento de pr ticas chave distribu das em cinco n veis de maturidade Quanto maior o n vel maior a maturidade dos processos de desenvolvimento de software de uma organiza o Na Figura 1 pode se ver a evolu o do conhecimento do modelo CMM pelas empresas de software 100 m1995 m1997 11999 12001 80 60 54 i 53 40 37 2 91 24 5 eo 10 FE 11 5 3 0 E E Conhece e usa Conhece mas n o usa N o conhece Fonte adaptado de Jomori et al 2004 p 46 Figura 1 Conhecimento do modelo CMM pelas empresas de software Conforme Jomori et al 2004 p 46 a norma ISO 9001 Sistemas da qualidade Modelo para garantia da qualidade em projetos desenvolvimento produ o instala o e servi os associados utilizada como refer ncia por muitas empresas desenvolvedoras de software em todo o mundo As organiza es que t m o software explicitado em seu escopo de certifica o tamb m podem utilizar como refer ncia a norma ISO 9000 3 Segundo Jomori et al 2004 p 46 A ISO 9000 3 uma norma internacional da s rie ISO 9000 que estabelece diretrizes para aplica o da ISO 9001 s atividades de desenvolvimento manuten
171. x Ele T Fani BD Manual do Usu rio AcAAg Manual que fornece suporte ao usu rio com exemplos Tl E E pa Esse EEE Figura 20 Tela de cadastro de documentos 73 Um conjunto de perguntas j se encontra cadastrado no software eventualmente na tela de cadastro de perguntas pode ser realizado ajustes ou ainda a inclus o de mais perguntas conforme Figura 21 Ak 7 ICAR al E EI E amp SAQDS Sistema de Avalia o da Qualidade da Documenta o de Software SAQDS Cadastro das Pergunt PEIES la x No caso de impress o da documenta o as fontes s o impressas corretamente em todos os tipos de impressoras dispon veis para o usu rio Informa es Gerais Impressa e On Line Figura 21 Tela de cadastro de perguntas Com o t rmino de todos os cadastramentos a pr xima etapa realizar uma avalia o a mesma deve ser feita na tela de registro de avalia es conforme Figura 22 A tela de registro de avalia es busca dados avaliador software cadastrados previamente Quando do in cio da avalia o o avaliador tem tr s formas m tricas dispon veis a requisitos que disponibiliza as seguintes op es de resposta atende atende parcialmente n o atende n o se aplica b porcentagem que disponibiliza as seguintes op es de resposta 0 a 100 com intervalos de 20 n o se aplica c notas qu
172. xto e atrai a aten o do usu rio b it lico pode dificultar a leitura se for utilizado em grande parte do texto utilize apenas para pequenos textos c sublinhado evitar se poss vel d emoldurar o texto deve se utilizar quadrados ou formas retangulares consistentemente e cores n o utilize cores como m todo nico de destaque do texto f efeito de piscar n o deve se utilizar esse efeito no texto em si se for necess rio destacar um texto dessa forma deve se aplicar esse efeito em um objeto pr ximo ao texto em quest o 61 g letras mai sculas n o deve se utilizar letras mai sculas para dar nfase e quando necessitar de sua utiliza o n o recomendado utilizar em grandes textos 2 4 29 7 LISTAS importante criar um padr o para listas logo deve se levar em considera o os seguintes aspectos a o n mero de n veis tente ficar em um n vel apenas evite mais de dois n veis alinhados b numera o dos itens crie uma padr o levando em considera o o estilo de numera o ser adotado para cada n vel se os n meros ser o seguidos por algum marcador ou elemento gr fico ou at mesmo indicar o os itens c utilizar n meros apenas quando a segii ncia dos itens importante por exemplo n mero de passos a serem seguidos d evitar numera o romana e se marcadores forem utilizados como controles de navega o aplicar os mesmos padr es dos controles de navega o j
173. z a anota o em forma de cones sinalizadores ou qualquer outro tipo de marcador No caso da anota o ficar exposta juntamente com o texto da informa o da documenta o deve se diferenciar a anota o do usu rio da informa o original 2 4 27 TAMANHO DOS T PICOS OU FRAGMENTOS importante determinar o tamanho dos t picos ou fragmentos de acordo com a necessidade do usu rio e n o pelas limita es da ferramenta utilizada Quando for decidir o tamanho dos t picos deve se levar em considera o a quanta informa o o usu rio pode ver de uma s vez sem utilizar a rolagem da tela b quanta informa o o usu rio efetivamente necessita versus quanta informa es se encontra dispon vel c que informa o o usu rio pode querer al m a informa o exibida o usu rio pode precisar de informa es adicionais logo essas devem ser de f cil acesso d quanta informa o o usu rio pode absorver levando em conta que ele necessita de 51 ajuda para resolver uma necessidade e quantos passos de navega o ele dever percorrer caso a informa o que ele necessite n o esteja totalmente exibida em apenas uma tela Sempre que poss vel deve se exibir os t picos de uma s vez na tela quando isso n o for poss vel deve se criar um meio para que o usu rio possa ter acesso a toda a informa o como o recurso de rolagem da tela adicionalmente deve se disponibilizar um design flex vel de modo que o u

da Monografia - Departamento de Sistemas e Computação

Contents

Download Pdf Manuals

Related Search

Related Contents

da Monografia - Departamento de Sistemas e Computa&ccedil;&atilde;o

Contents

Download Pdf Manuals

Related Search

Related Contents

da Monografia - Departamento de Sistemas e Computação