Embed Size (px)
Citation preview
FESP - FUNDAÇÃO DE ESTUDOS SOCIAIS DO PARANÁ
ICSP – INSTITUTO DE CIÊNCIAS SOCIAS DO PARANÁ
CURSO DE ESPECIALIZAÇÃO EM GESTÃO DA INFORMAÇÃO E INOVAÇÕES TECNOLÓGICAS
ELABORAÇÃO E ARMAZENAMENTO DE DOCUMENTAÇÃO DE
SISTEMAS INFORMATIZADOS
CURITIBA
2002
ELISABETH HOFFMANN
ELABORAÇÃO E ARMAZENAMENTO DE DOCUMENTAÇÃO DE
SISTEMAS INFORMATIZADOS
Monografia apresentada para obtenção do título de Especialista no Curso de Pós-Graduação em Gestão da Informação e Inovações Tecnológicas, Fundação de Estudos Sociais do Paraná.
Orientador: Prof. Fernando Leocadio Pianaro
CURITIBA
2002
AGRADECIMENTOS
Agradeço inicialmente a DEUS, pois sem sua luz e força nada se realiza.
Agradeço à Companhia de Informática do Paraná – CELEPAR, pela
oportunidade de reciclaglem e formação profissional, pelo apoio financeiro no custeio
do curso e pela disponibilização de infra-estrutura e do acervo da biblioteca.
À Coordenadora da Divisão Técnica da CELEPAR, Maria Teresa Rodrigues
Pahl pelo incentivo e apoio demonstrados desde o início do curso.
Aos amigos da CELEPAR, pela participação e contribuição respondendo ao
questionário proposto. A Maria José Resmer, pela paciência, apoio e disposição
sempre presentes no momento das pesquisas e pela amizade sempre sincera. A Marco
Aurélio Cordeiro e Alexandre Andrade Teixeira, pelo apoio.
Ao Professor Fernando Leocádio Pianaro, pelo incentivo e orientação nos
trabalhos apresentados durante a realização do curso.
ii
SUMÁRIO
LISTA DE FIGURAS .................................................................................................................. v
RESUMO .............................................................................................................................. vii
CAPÍTULO 1 .............................................................................................................................. 8
1 INTRODUÇÃO......................................................................................................................... 2
1.1 APRESENTAÇÃO................................................................................................................. 2
1.2 APRESENTAÇÃO DO PROBLEMA .................................................................................. 3
1.3 JUSTIFICATIVA PARA A ESCOLHA DO TEMA ............................................................. 3
1.4 OBJETIVOS.......................................................................................................................... 4
1.4.1 Geral: .............................................................................................................................. 4
1.4.2 Específicos........................................................................................................................... 5
1.5 HIPÓTESES ........................................................................................................................... 5
1.6 METODOLOGIA UTILIZADA ............................................................................................ 6
CAPÍTULO 2 .............................................................................................................................. 10
2 REVISÃO DA LITERATURA................................................................................................. 11
2.1 DOCUMENTAÇÃO DE SISTEMAS.................................................................................... 11
2.1.1 Introdução............................................................................................................................ 11
2.12 Importância da Documentação de Sistemas ......................................................................... 155
CAPÍTULO 3 .............................................................................................................................. 19
3 CELEPAR – COMPANHIA DE INFORMÁTICA DO PARANÁ.......................................... 20
3.1 HISTÓRICO:.......................................................................................................................... 20
3.2 ACIONISTAS ........................................................................................................................ 20
3.3 ATIVIDADES........................................................................................................................ 21
3.4 ESTRUTURA ORGANIZACIONAL.................................................................................... 22
3.5 METODOLOGIA DE DESENVOLVIMENTO DE SERVIÇOS - MDS ............................. 23
3.5.1 Composição da Metodologia............................................................................................... 23
3.6 DOCUMENTAÇÃO DE SISTEMAS.................................................................................... 24
iii
3.6.1. Evolução do Processo......................................................................................................... 24
3.6.2 O Processo Atual ................................................................................................................. 25
3.6.3 Estrutura da Base Notes de Documentação de Sistemas................................................... 27
3.6.4 Descrição da Função Documentador de Sistemas............................................................... 27
CAPÍTULO 4 .............................................................................................................................. 29
4 EMPRESAS VISITADAS ........................................................................................................ 30
4.1 VISITAS .............................................................................................................................. 30
4.1.1 Empresa A ........................................................................................................................... 30
4.1.2 Empresa B ........................................................................................................................... 32
4.1.3 Empresa C ........................................................................................................................... 34
CAPÍTULO 5 .............................................................................................................................. 37
5 ANÁLISE DAS PESQUIsAS ................................................................................................... 38
5.1 PRINCIPAIS PONTOS OBSERVADOS naS VISITAS....................................................... 38
5.1.1 Análise dos Principais Pontos Observados Durante às Visitas ........................................... 39
5.2 QUESTIONÁRIO ENVIADO AOS TÉCNICOS DA
CELEPAR (ANEXO V)......................................................................................................... 41
5.2.1 Apresentação dos Dados Coletados..................................................................................... 41
5.2.2 Análise dos Dados Coletados .............................................................................................. 41
CAPÍTULO 6 .............................................................................................................................. 69
6 CONCLUSÃO........................................................................................................................... 70
ANEXOS .............................................................................................................................. 74
ANEXO I - CONTEÚDO DO RDOC (Roteiro de Documentação) ............................................ 74
ANEXO II– SOLICITAÇÃO DE DOCUMENTAÇÃO.............................................................. 83
ANEXO III – SOLICITAÇÃO DE PASTAS .............................................................................. 84
ANEXO IV – ARMAZENAMENTO DE PROJETOS ............................................................... 85
ANEXO V – QUESTIONÁRIO ENVIADO AOS TÉCNICOS DA CELEPAR ........................ 86
GLOSSÁRIO .............................................................................................................................. 87
REFERÊNCIAS ........................................................................................................................... 89
iv
LISTA DE FIGURAS
FIGURA 01 – ESTRUTURAL ORGANIZACIONAL DA CELEPAR...................................... 22
FIGURA 02 – GRÁFICO QUANTIDADE DE QUESTIONÁRIOS REMETIDOS/PREENCHIDOS .......................................................................... 41
FIGURA 03 – GRÁFICO TEMPO DE TRABALHO NA CELEPAR....................................... 42
FIGURA 04 – GRÁFICO TIPO DE ATIVIDADE..................................................................... 43
FIGURA 05 – GRÁFICO PLATAFORMA DE TRABALHO.................................................... 43
FIGURA 06 – GRÁFICO CONHECIMENTO DA METODOLOGIA CELEPAR.................... 44
FIGURA 07 – GRÁFICO UTILIZAÇÃO METODOLOGIA CELEPAR .................................. 45
FIGURA 08 – GRÁFICO CONHECIMENTO DA DOCUMENTAÇÃO DE SISTEMAS ...... 45
FIGURA 09 – GRÁFICO NECESSIDADE DA DOCUMENTAÇÃO DE SISTEMAS ............ 46
FIGURA 10 – GRÁFICO DOCUMENTAÇÃO DE SISTEMAS/QUALIDADE RESULTADO DO PROJETO............................................................................. 46
FIGURA 11 – GRÁFICO TEMPO DOCUMENTAÇÃO/IMPORTÂNCIA RESULTADO..... 46
FIGURA 12 – GRÁFICO CUSTO/PRODUTO FINAL.............................................................. 47
FIGURA 13 – GRÁFICO CONHECIMENTO DA BASE DE DOCUMENTAÇÃO DE SISTEMAS .......................................................................................................... 48
FIGURA 14 - GRÁFICO TIPOS DE DOCUMENTOS ELABORADOS/SOLICITADOS ...... 48
FIGURA 15 – GRÁFICO LOCAL DE ARMAZENAMENTO DOCUMENTOS...................... 49
FIGURA 16 – GRÁFICO FERRAMENTA UTILIZADAS PARA ELABORAÇÃO ................ 49
FIGURA 17 – GRÁFICO SUGESTÕES DE NOVAS FERRAMENTAS.................................. 50
FIGURA 18 – GRÁFICO ATUALIZAÇÃO DA DOCUMENTAÇÃO ..................................... 50
FIGURA 19 – GRÁFICO CONHECIMENTO DOS PRODUTOS ELABORADOS PELA EQUIPE DE DOCUMENTAÇÃO ...................................................................... 51
FIGURA 20 - GRÁFICO SOLICITAÇÃO DE DOCUMENTAÇÃO AO GRUPO DE DOCUMENTAÇÃO............................................................................................ 51
FIGURA 21 – GRÁFICO MOTIVO PELO QUAL NÃO FEZ SOLICITAÇÕES AO GRUPO 51
v
LISTA DE TABELAS
TABELA 01 – DADOS GERAIS DAS EMPRESAS.................................................................. 38
TABELA 02 – DOCUMENTAÇÃO DE SISTEMAS - ELABORAÇÃO .................................. 38
TABELA 03 – DOCUMENTAÇÃO DE SISTEMAS – ARMAZENAMENTO E CONTROLE ........................................................................................................ 39
TABELA 04 – RESPOSTAS DA QUESTÃO 19 - COMO CONSIDERA O ATENDIMENTO DADO PELO GRUPO DE DOCUMENTAÇÃO DE SISTEMAS? ........................................................................................................ 53
TABELA 05 – RESPOSTAS DA QUESTÃO 20 - COMO VÊ A UTILIZAÇÃO DA DOCUMENTAÇÃ9O PELO CLIENTE? (Help, Manual do Usuário, Cartelas, etc.)....................................................................................................................... 55
TABELA 06 – RESPOSTAS DA QUESTÃO 21 - QUAIS AS DIFICULDADES QUE VOCÊ COSTUMA ENCONTRAR NO MOMENTO DE DOCUMENTAR UM SISTEMA? ................................................................................................... 59
TABELA 07 – RESPOSTAS DA QUESTÃO 22 - QUAIS AS DIFICULDADES QUE VOCÊ COSTUMA ENCONTRAR PARA ATUALIZAR A DOCUMENTAÇÃO?.......................................................................................... 62
TABELA 08 – RESPOSTAS DA QUESTÃO 23 - NA SUA VISÃO, O QUE PODERIA SER FEITO PARA A MELHORAR O PROCESSO ATUALMENTE UTILIZADO NA CELEPAR PARA DOCUMENTAÇÃO DE SISTEMAS?.... 65
vi
RESUMO
Este trabalho apresenta uma pesquisa científica na área de Gestão da
Informação, objetivando verificar a adequação do processo de documentação de
sistemas atualmente utilizado pela CELEPAR (Companhia de Informática do Paraná),
através de literatura e pesquisas de campo.
As pesquisas bibliográficas demonstram a documentação de sistemas como
um importante instrumento a ser utilizado, visando manter histórico dos projetos em
todo o seu ciclo de vida, bem como demonstram sua importância como elemento
integrante da qualidade do produto a ser entregue ao cliente.
As pesquisas de campo apresentam o processo de documentação de sistemas
adotados por três empresas que desenvolvem software e expõem informações de
opinião, coletadas através de questionário enviado aos técnicos da CELEPAR.
vii
CAPÍTULO 1
INTRODUÇÃO
1.1 APRESENTAÇÃO
1.2 APRESENTAÇÃO DO PROBLEMA
1.3 JUSTIFICATIVA PARA A ESCOLHA DO TEMA
1.4 OBJETIVOS
1.4.1 Geral
1.4.2 Específicos
1.5 HIPÓTESES
1.6 METODOLOGIA UTILIZADA
2
1 INTRODUÇÃO
1.1 APRESENTAÇÃO
A tecnologia da informação coloca à nossa disposição diferentes meios para
armazenamento de informações. Registrar estas informações de forma que possam ser
utilizadas por outras pessoas, permitindo seu aproveitamento, tem sido preocupação
histórica do homem.
A documentação nos conta toda a história de um sistema, desde sua
concepção, passando pelo seu desenvolvimento e acompanhando sua manutenção,
mostrando-nos o que fazem, como fazem e para quem fazem.
[VALERIANO,1998], nos remete à importância de documentar um sistema,
através da seguinte comparação:
“Muitos projetos não nos legaram sua documentação nem qualquer de seus registros. De alguns, não se conhece nem mesmo seu objetivo, como os megálitos de Stonehenge, por exemplo. De outros, não se sabe como foram executados: as pirâmides egípcias, as das civilizações pré- colobianas e os monumentos da Ilha de Páscoa, apesar de serem muito admirados. Entretanto, da Arca de Noé, quer tenha sido real ou não, conhecem-se suas “especificações” bíblicas, o que permitiria construir uma “réplica’, com razoável segurança.”
Com ponto de partida nestes fatos, este trabalho apresenta estudo teórico e
pesquisas de campo visando analisar os benefícios oferecidos por um processo de
documentação, estruturado de forma a armazenar em local único todas as informações
pertinentes aos sistemas de informação, visto que a expansão da tecnologia da
informação é crescente e que existe uma necessidade agregada de se coordenar
informações úteis para tê-las disponíveis no momento em que forem necessárias, por
qualquer pessoa que delas necessitem, principalmente no que tange aos processos de
tomada de decisão.
3
1.2 APRESENTAÇÃO DO PROBLEMA
O problema a ser analisado foi formulado com o objetivo de verificar a
adequação do processo de documentação de sistemas atualmente utilizado pela
CELEPAR (Companhia de Informática do Paraná), sendo que este trabalho se propõe
a responder as seguintes questões:
O Processo de documentação atualmente utilizado pela CELEPAR é similar
ao processo utilizado por outras empresas que desenvolvem sistemas na região de
Curitiba?
Que avaliação fazem os técnicos que trabalham na CELEPAR em relação
ao processo de documentação atualmente utilizado?
1.3 JUSTIFICATIVA PARA A ESCOLHA DO TEMA
A informação certa no momento certo propicia vantagens assertivas na
tomada de decisões às pessoas envolvidas em processos empresariais.
A informação gerencial de qualidade, aquela destinada ao processo de
tomada de decisão, possui, segundo Bio [BIO, 1993], as seguintes características:
Comparativas: permitem comparar o planejamento realizado;
Confiáveis: informações erradas, ou distorcidas podem ser pior do que a falta de
informação;
Oportunas: geradas e disponibilizadas em tempo hábil;
Com nível de detalhe e atualização adequados: nível de detalhe apropriado ao
usuário (cliente) da informação e que permita a tomada de decisão;
Destaque às execuções: destaca informações relevantes.
A documentação de um sistema visa oferecer aos seus usuários, sejam eles
desenvolvedores, do ambiente de produção ou cliente/usuário, informações precisas e
confiáveis que forneçam suporte no momento de manutenção e na entrega do produto,
com a certeza de sua qualidade.
A documentação faz com que os sistemas sejam da organização e não
dependam das pessoas que nela trabalham [MONTÓN, 1979].
4
Para os clientes é um complemento que agrega maior qualidade ao produto,
demonstrando como utilizar todas as potencialidades oferecidas pelo sistema. Além
disto, a documentação é um dos elementos exigidos para certificação ISO 9001 para
garantir a qualidade no que se refere a projetos, desenvolvimento, produção, instalação
e assistência técnica de sistemas de informação.
As empresas vivem novos e diferentes desafios em função da rapidez das
mudanças e da necessidade de conquistar mercados. Precisam ser ágeis e por esta
razão, em muitos casos, a documentação de sistemas fique relegada a um segundo
plano.
Pelo acima exposto e com atuação profissional na área de Documentação de
Sistemas da CELEPAR, percebe-se a documentação como um assunto realmente
importante e preocupante, mas que encontra resistências dentro das organizações.
Desta forma, a motivação para a realizar este trabalho é a analise do processo de
documentação atualmente utilizado pela CELEPAR, identificação de possíveis
deficiências e busca de subsídios, através de literatura e de pesquisas de campo, que
possibilitem analisar e, se necessário, aprimorar o método atualmente utilizado.
Há que se considerar um desafio o fato de não podermos contar com
bibliografia em quantidade adequada sobre o tema, haja vista a dificuldade para
encontrar material científico que referencie especificamente o assunto.
1.4 OBJETIVOS
1.4.1 Geral
Analisar o processo de documentação de sistemas utilizado pela CELEPAR,
verificando o grau de satisfação dos técnicos que o utilizam, comparando este processo
ao de outras empresas similares que possuem área interna de desenvolvimento em
Curitiba, e que mantenham também, nestas áreas, estruturas de documentação.
5
1.4.2 Específicos
Diagnosticar, através de pesquisa de campo, o nível de preocupação atual de
empresas que desenvolvem software em Curitiba, quanto à necessidade de se
produzir documentação.
Diagnosticar, através de pesquisas de campo, como as empresas que possuem área
interna de desenvolvimento de sistemas em Curitiba armazenam sua
documentação, para resguardá-la, mantê-la íntegra e confiável, ao mesmo tempo
oferecendo rápido e fácil acesso aos usuários envolvidos.
Diagnosticar, através de pesquisa de campo, pela aplicação de um questionário
dirigido aos técnicos que desenvolvem sistemas na CELEPAR, o grau de satisfação
quanto ao processo de documentação atualmente utilizado pela empresa, bem como
coletar sugestões que possam vir a contribuir para melhoria do referido processo.
1.5 HIPÓTESES
Não existe preocupação por parte das empresas com uma estrutura de
armazenamento única da documentação para permitir acesso de todos os usuários
que dela necessitam;
O foco dos desenvolvedores de sistemas não é a documentação, mas sim o
resultado dos seus projetos;
Os técnicos da CELEPAR estão descontentes com o processo de documentação
atualmente utilizado pela empresa;
Os técnicos da CELEPAR têm sugestões que podem contribuir para a melhoria do
processo de documentação atualmente utilizado;
Desconhecimento, por parte dos desenvolvedores, do processo de documentação
utilizado pela CELEPAR;
Baixa rotatividade do pessoal de desenvolvimento, fazendo com que o
conhecimento da organização fique atrelado ao conhecimento e a experiência de
pessoas.
6
1.6 METODOLOGIA UTILIZADA
Para a realização deste trabalho, inicialmente foi feita uma revisão teórica
sobre o tema, com o objetivo de aprofundar conhecimentos sobre conceitos e
importância da documentação de sistemas. Esta revisão foi elaborada basicamente
através de literaturas que versam sobre desenvolvimento de projetos, qualidade de
software e, metodologias de desenvolvimento de software, face a dificuldade de
encontrar material científico específico sobre o tema. Em função desta dificuldade,
optou-se por realizar também pesquisas de campo para obtenção de dados utilizando o
método de observação direta, através de visitas e ainda pela aplicação de questionário
dirigido, orientados por literaturas na área de metodologia científica.
[MARCONI & LAKATOS,1996] explicam que: “Pesquisa de campo é
aquela utilizada com o objetivo de conseguir informações e/ou conhecimentos acerca
de um problema, para o qual se procura uma resposta, (...) ou, ainda, descobrir novos
fenômenos ou as relações entre eles.”
[OLI, 97] apud [ZOTTO, 2000] define questionários como sendo
instrumentos que servem de apoio aos pesquisadores para os processos de coleta de
dados e apresentam os seguintes aspectos:
São a espinha dorsal de qualquer levantamento;
Precisam reunir todas as informações necessárias, nem mais nem menos;
Devem ter uma linguagem adequada, ou seja, uma certa dose de visão psicológica
introspectiva para apanhar o pensamento das pessoas.
As visitas tiveram como objetivo verificar como as empresas elaboram e
armazenam sua documentação de sistemas, visando diagnosticar o grau de importância
dado a ela e conhecer os meios de armazenamento utilizados.
O critério adotado para selecionar as empresas participantes da pesquisa
prendeu-se ao requisito de realizar atividade de desenvolvimento de sistemas em
Curitiba e possuir metodologia de desenvolvimento para elaborar documentação.
Foram contatadas oito empresas, através de telefonemas, objetivando
agendar visitas. Porém, foram efetivadas apenas três. Dos contatos efetuados, duas das
empresas terceirizavam o desenvolvimento, duas centralizavam o desenvolvimento
7
em suas matrizes localizadas em outras capitais e uma não possuía metodologia de
desenvolvimento e também não elaborava documentação de sistemas.
O nomes da empresas visitadas foram omitidos, a pedido das mesmas, e,
portanto, são denominadas: empresa A (visitada no dia 24 de setembro de 2001);
empresa B (visitada no dia 04 de outubro de 2001) e empresa C (visitada no dia 06 de
novembro de 2001).
Durante as visitas foram anotados os principais pontos observados em
relação ao processo de documentação utilizado, coletados os dados considerados
relevantes das informações fornecidas pelo funcionário responsável da área onde a
documentação dos sistemas é inserida na empresa, e um breve histórico para
identificar a natureza das operações desenvolvidas. Após cada visita foi elaborado um
relatório com base nestas anotações.
Para a coleta de informações de opinião sobre o processo de documentação
atualmente utilizado pela CELEPAR, foi elaborado um questionário posteriormente,
aplicado através de uma base de dados desenvolvida em Lotus Notes (software da
Lotus Development Corporation), buscando unificar o meio de armazenamento das
respostas e facilitar sua tabulação.
Este questionário foi estruturado com perguntas abertas, onde os
respondentes ficaram livres para compor respostas com suas próprias palavras, sem se
limitarem a um rol de alternativas, com o objetivo de estimular e facilitar a
cooperação. Também foram aplicadas perguntas de múltipla escolha, onde os
respondentes optam por uma alternativa, ou por determinado número de alternativas e
perguntas dicotômicas onde são apresentadas repostas de caráter bipolar, do tipo
“sim/não”.
As perguntas foram formuladas de maneira simples e com o cuidado de não
gerar dúvidas, nem parecerem tendenciosas. O objetivo foi traçar a opinião,
conhecimento e sugestões sobre o processo de documentação utilizado na empresa.
[LAKATOS, 1991], afirma que:
“Questionário, também chamado questionário autopreenchido por alguns autores - deve ser constituído por uma série ordenada de perguntas, que devem ser respondidas por mecanismos de escrita diretamente pelos pesquisados, sem a presença do entrevistador. Há
8
várias formas para enviar um questionário: isto vai ser determinado pela natureza da pesquisa. Junto com o documento, deve-se enviar uma nota ou carta explicando os objetivos da enquete, sua importância e a necessidade de obter respostas, tentando despertar o interesse do recebedor, a fim de que ele preencha e devolva o questionário dentro de um prazo razoável. Em geral, o pesquisador envia o questionário ao respondente, pelo correio ou por um portador; depois de preenchido, o pesquisado devolve-o do mesmo modo.”
Antes do envio, o questionário foi verificado pelo orientador deste trabalho
e foram realizados pré-testes de funcionamento, bem como um cálculo aproximado do
tempo a ser dispendido no preenchimento.
[GOODE & HATT, 1972], afirmam que nenhuma quantidade de
pensamento, não importa quão lógica seja a mente e brilhante a compreensão, pode
substituir uma cuidadosa verificação empírica. Daí a importância em se saber como o
instrumento de coleta de dados se comporta numa situação real através do pré-teste.
A coleta dos dados se iniciou no dia 03 de dezembro de 2001, tendo sido o
questionário enviado através de correio eletrônico, direcionado aos funcionários que
atuam na área de desenvolvimento de sistemas, composta de 120 técnicos.
O questionário foi acompanhado de mensagem explicativa sobre o propósito
da pesquisa, compromisso de não identificação do autor e manutenção da integridade
das respostas. Foi informado também o tempo aproximado para preenchimento, sendo
possível ao receptor ler a mensagem sem necessariamente ter que responder ao
questionário.
As respostas eram armazenadas na base de dados a medida em que eram
registradas, o que permitia um acompanhamento progressivo da receptividade e
consulta.
No dia 17 de dezembro foi enviada uma mensagem de agradecimento a todas
as pessoas que colaboraram respondendo ao questionário e na oportunidade o link que
possibilitava o acesso à base de dados foi enviado novamente, solicitando a
colaboração das pessoas que até aquele momento não tinham registrado sua resposta.
A base de dados ficou disponível para o recebimento de respostas até o dia 28 de
dezembro, data em que foi encerrada a coleta dos dados.
9
Após a coleta, foi iniciada a tabulação das respostas. Buscou-se reuní-las de
forma organizada e preservá-las na íntegra. As perguntas fechadas foram tabuladas
com o auxílio de facilidades oferecidas pelo software Lotus Notes, através da criação
de visões ordenadas de maneira a mostrar campos dos dados associados às respostas
obtidas. Para as respostas abertas com questões descritivas optou-se pela análise
individual de conteúdo e pela observação da freqüência das respostas.
Para possibilitar a análise comparativa e demonstrar o processo de
elaboração de documentação utilizado pela CELEPAR, foram coletados dados e
elaborado um relatório sobre este processo, bem como foram apresentados dados
gerais sobre a natureza das operações e metodologia de desenvolvimento utilizada
atualmente na empresa.
De posse das análises do questionário e dos dados registrados nos relatórios
feitos após as visitas, foi realizada a validação dos dados coletados com as hipóteses
formuladas. Foram registradas as sugestões possíveis para a melhoria do processo e
por fim foi elaborada a conclusão do trabalho.
CAPÍTULO 2
REVISÃO DA LITERATURA
2.1 DOCUMENTAÇÃO DE SISTEMAS
2.1.1 Introdução
2.1.2 Importância da Documentação de Sistemas
11
2 REVISÃO DA LITERATURA
2.1 DOCUMENTAÇÃO DE SISTEMAS
2.1.1 Introdução
Documento, segundo [TRUJILLO, 2001], é toda a informação contida em
um suporte material que contenha a propriedade de ser comunicada.
Documentação, segundo o dicionário da língua portuguesa [FERREIRA,
1987], é o conjunto de conhecimentos e técnicas que tem por fim a pesquisa, reunião,
descrição, produção e utilização de documentos de qualquer natureza.
Sistemas de Informação, segundo [REZENDE, 2000], é o conjunto de várias
partes integradas entre si que produzem informação.
O objetivo da documentação é reunir informações úteis de um determinado
assunto e organizá-las de forma que possam ser recuperadas no momento em que elas
sejam necessárias.
[MONTÓN, 1979], define documentação de sistemas como um conjunto
registrador de evidências que revelam as características de alguma parte – ou de todas
as partes – de um sistema de processamento eletrônico de dados.
Para [VALERIANO, 1998], o projeto enquanto em execução, é “hóspede”
da organização até o seu término. A documentação é “filha” do projeto que a gera,
enquanto ele estiver em execução. Quando o projeto terminar, a documentação
sobreviverá a ele e, como “herdeira”, retém toda a riqueza, todos os resultados, as
virtudes e (por que não?) as deficiências e as carências do projeto.
A documentação, vista como uma ferramenta de auxílio a ser utilizada no
momento de sua necessidade por todas as pessoas envolvidas com o sistema, precisa,
para cumprir este papel, ser elaborada ao final de cada fase determinada pela
metodologia adotada na organização para desenvolver seu sistema, bem como
necessita ser atualizada sempre que houver uma modificação .
Metodologias de trabalho são adotadas, visando coordenar esforços das
equipes de desenvolvimento, estabelecendo ordem, padrões e técnicas.
12
[REZENDE, 2000] explica que:
Metodologia não é uma técnica tão simplesmente, pois pode-se utilizar qualquer técnica para desenvolvimento de projeto, sistema ou software, de acordo com a preferência e competência da equipe multidisciplinar envolvida. Como exemplo de técnicas, podem ser utilizadas a Análise Estruturada, a Análise de Pontos por Função, a Análise Essencial, a Análise Orientada a Objetos, a Unified Modeling Language (UML) entre outras técnicas e suas respectivas ferramentas e processos. Desse modo a metodologia é um roteiro que permite o uso de várias técnicas por opção dos desenvolvedores do Sistema de Informação ou Software.
Existem diferentes soluções e formas de se determinar um modelo de
metodologia a ser seguida. Geralmente ela é dividida em fases ou ciclo de vida e
mesmo considerando a ISO 9000-3 (Normas para a Gestão da Qualidade e Garantia da
Qualidade) que define as diretrizes para aplicação da ISO 9001 (Sistemas de
Qualidade – Modelo para Garantia da Qualidade em Projetos/Desenvolvimento,
Produção, Instalação e Assistência Técnica), não há um padrão universalmente aceito.
[BIO, 1993], descreve como regra geral, que as metodologias procuram definir:
as etapas de um projeto;
as atividades (geralmente pormenorizadas) de cada etapa;
os produtos e pontos de controle das etapas/atividades;
os responsáveis e demais envolvidos nas etapas/atividades;
a documentação associada às atividades.
Assim, os modelos metodológicos costumam agrupar as atividades de
diferentes formas e definir padrões para nomenclatura de programas, definição de
arquivos, apresentação de telas, etc.
A justificativa para desenvolvimento de sistemas com aplicação de
metodologia é assim apontada por [REZENDE, 2000]: “Todo e qualquer projeto,
sistema ou software deve ser engenhado por meio de metodologia moderna e que
ofereça a documentação completa. Toda a empresa deve ter uma metodologia, visando
a efetividade, continuidade, perenidade, segurança e transparência, aceita e
implementada pelos gestores, clientes/usuários e desenvolvedores.”
Além de documentar cada fase é necessário elaborar os manuais durante o
desenvolvimento dos sistemas. Os manuais normalmente sugeridos são:
13
Manual do Sistema/Software (contendo todos as instruções pertinentes ao sistemas
como: entradas, saídas, banco de dados, rotinas, programas, requisitos, etc.);
Manual do Cliente/Usuário (contendo procedimentos de uso, dicas de problemas,
etc.);
Manual de Operação (contendo descrição de procedimentos/rotinas, periodicidade,
dependência de informação, instruções de reprocessamento, retenção de arquivos,
esquema de cópias, etc.). Este Manual tem a característica de ser elaborado quando
o sistema/projeto é desenvolvido para plataforma mainframe.
Nas sugestões mencionadas acima, deve se considerar que o conteúdo e o
tipo de manual a ser elaborado deve ser flexível, atenda a realidade de cada projeto e
a plataforma de desenvolvimento. Projetos desenvolvidos em plataformas como WEB
e Lotus Notes, por exemplo, geralmente não necessitam de um manual de usuário,
sendo suficiente apenas uma cartela ou ainda uma ajuda on-line como
acompanhamento para instruir o cliente/usuário. O desenvolvimento nestas
plataformas também não requer um manual de operação.
[VALERIANO, 1998] refere-se ao conteúdo, redação e guarda dos
documentos, afirmando que:
Os documentos dirigidos aos clientes internos constituem parte da teia de comunicação do projeto, enquanto em execução. Os destinados ao cliente externo (o usuário do projeto) precisam “dar o recado”, isto é, devem ser capazes de transmitir, com precisão e clareza, todas as informações de que o cliente necessita para usufruir o produto do projeto. Por fim os que vão para o acervo (muitos dos quais já foram também para o cliente interno e/ou para o cliente externo) constituem a memória do projeto e devem estar em condições de ser recuperados, consultados e entendidos em épocas posteriores, mesmo pelos que não estiveram direta ou indiretamente envolvidos com o projeto.
Uma evolução no que tange ao estudo da qualidade dos produtos é descrita
por [LOBO, 2002] quando afirma que: ‘...qualidade do produto é algo bom, mas que qualidade do processo de produção é ainda
mais importante. No caso do software (...) diz-se mais sobre a qualidade observando como ele foi
desenvolvido do que analisando o produto final. Afinal não se consegue ter certeza da
manutenibilidade ou fidedignidade apenas usando a ferramenta”.
A ISO/IEC 9126 (Tecnologia de Informação – Avaliação de Produto de
14
Software – Características de Qualidade e Diretrizes para o seu Uso) ou NBR 13596
(tradução publicada em agosto de 1996), lista um conjunto de características que
devem ser verificadas para que um software seja considerado um “software de
qualidade”. Entre estas características está a usabilidade, descrita também por [LOBO,
2002], como o esforço necessário para se utilizar o software, bem como o julgamento
individual desse uso, por um conjunto de usuários implícitos ou explícitos. São
características relacionadas: facilidade de compreensão, qualidade da documentação,
aprendizagem e operabilidade.
Um dos dez princípios da usabilidade, citados por [NIELSEN, 1993] apud
[BAX, 2001] a serem seguidos durante a execução de um projeto para se obter um
produto final usável, é o da Ajuda e Documentação - ” ... é essencial que o sistema de
ajuda e o manual do usuário seja orientado por tarefas, liste passos concretos e use
uma linguagem o mais clara e simples possível.”
A documentação está inserida num contexto de produção de variada gama
de informações relacionadas por pertencer ao processo de desenvolvimento de
software, onde a qualidade e disponibilidade de informação sobre diferentes tipos de
serviços influencia diretamente a qualidade e agilidade do processo e do produto,
acumulando grande quantidade de documentos.
Face ao exposto, torna-se necessário considerar o gerenciamento, guarda, ou
meio de armazenamento e trâmite dessas informações, através da adoção de
instrumentos que permitam um acesso fácil a informação, através de interação simples
e pronta, visível para toda a organização, que esteja de acordo com os perfis e critérios
de segurança desejados. Isto garantirá que a informação seja confiável, atualizada e
facilmente extraída. Estes instrumentos devem permitir não só o registro da
informação, mas também a sua classificação de forma dinâmica e ajustada à realidade
de cada organização. É também necessário que a informação armazenada seja
estruturada de maneira a possibilitar diferentes formas de pesquisas e que o meio onde
é acondicionada admita diferentes formatos de representação.
15
2.12 Importância da Documentação de Sistemas
A importância da documentação de sistemas pode ser verificada através da
literatura produzida por diversos autores sobre assuntos relacionados ao
desenvolvimento dos projetos.
Para [VALERIANO, 1998], “ os documentos registram a gênese, a evolução
e a conclusão das partes do projeto e das interfaces entre elas. Espelham tudo o que foi
planejado, realizado, ensaiado e obtido em cada período e fase dos trabalhos, tanto os
acertos como os erros.”
Dentro do ciclo de vida dos sistemas está a manutenção, definida como o
processo de modificação de um produto de software, componente ou sistema após a
sua instalação, de forma a corrigí-lo, melhorá-lo ou adaptá-lo para uma mudança no
ambiente operacional. Manutenibilidade de software é o atributo que caracteriza a
facilidade de modificação ou adaptação de um software. É muitas vezes quantificada
em termos de tempo médio requerido para efetivar a revisão do software para eliminar
um erro. Esse atributo é muito significativo para um software, na medida que a etapa
de manutenção pode consumir até 65% do custo total de um produto [BEHFOROOZ,
1996] [SCHACH, 1992] apud [CORDEIRO, 2000].
O ambiente complexo e rapidamente mutável em que está inserido o
desenvolvimento de software é agravado segundo, [FURLAN, 1994] “..pelas
inconsistências, falta de documentação, redundâncias, dificuldades de acesso (...)
bilhões de dólares são gastos anualmente em manutenção de sistemas no mundo
inteiro.”
[KETIS, 1999], afirma que :
“Dados estatísticos demonstram que de 47% a 62% do tempo gasto em manutenção de sistemas é dispendido na tentativa de entender o programa, e que ler o código fonte custa 3,5 vezes mais do que ler a documentação. Além disso, 53% dos defeitos são descobertos em trechos tidos como corretos e 10% são introduzidos durante as alterações. Outros 64% dos defeitos são de lógica, enquanto 79% são causados por entendimento incorreto do problema.”
Ainda segundo [KETIS, 1999], ” o novo modelo organizacional (analista de
informação, pool de analistas lógicos, pool de analistas físicos e programação interna
ou terceirizada) implica na necessidade de fazer perfeita e completa documentação”.
16
Cabe ressaltar que não basta apenas elaborar uma documentação inicial perfeita, é
preciso também que a documentação elaborada inicialmente acompanhe
cuidadosamente as manutenções e alterações efetuadas nos sistemas, para que seja
mantida a integridade e confiança da informação contida na documentação. Não foram
encontrados dados estimados de quanto dos sistemas são alterados e não
documentados.
[SOWEK, 1999], cita o problema do bug do ano 2000, como um exemplo da
problemática gerada pela falta de documentação apropriada ou inexistência da mesma,
afirmando que as empresas gastaram bilhões de dólares na solução deste problema,
quando poderiam ter gasto apenas um ou dois milhões. A documentação poderia ter
diminuído o esforço e o tempo gasto para a conversão dos sistemas.
Ao analisar o lado do profissional em relação a falta de documentação,
[CORDEIRO, 2000] afirma que a inexistência de documentação, faz com que pessoas
que desenvolvem um único projeto e ficam permanentemente na fase de manutenção
deste produto, tornem-se impossibilitadas de atuar em novos projetos, porque não
podem repassar os serviços de manutenção nem contar com ajuda de outros técnicos.
Isto faz com que o técnico não possa planejar crescimento profissional e partir para
novos desafios.
Já [MONTÓN, 1979] afirma que a inexistência de documentação faz com
que os profissionais se tornem ‘donos do serviços’. Definindo este termo como:
“profissionais que se julgam donos de todos os seus sistemas, no quais colocam
inclusive “gatilhos” para que ninguém sem o conhecimento dos mesmos, consiga
operá-los – são profissionais que normalmente têm toda a documentação em seu poder
– em alguns casos na própria cabeça”. Afirma ainda que já houve casos em que estes
profissionais, ao saírem das empresas onde trabalhavam, tiveram que ser recontratados
por salários astronômicos dada a importância dos projetos em que atuavam.
Considerando a proteção do software, que, embora não seja patenteável, um
programa de computador é protegido pelo Direito Autoral e para tal deve ser
registrado no INPI. O registro é a única forma de proteção contra a utilização não
autorizada por terceiros. Para que o registro ocorra é necessária a documentação
técnica relativa ao programa, que é arquivada sob guarda sigilosa, em envelope
17
lacrado, e o INPI torna-se seu fiel depositário. A abrangência da proteção é
internacional e o título é protegido juntamente com o programa em si por 50 anos.
Outros fatores que demonstram a importância da documentação de sistemas
apontados por [KETIS, 1999] são:
a legislação brasileira (Lei 9.430/96, de 27 de dezembro de 1996) obriga as pessoas
jurídicas a manterem documentação atualizada de seus sistemas, para fins de
auditoria por parte de organismos oficiais. A lei reproduz preceitos, antes esparsos
na Legislação Federal, referentes ao acesso, retenção e guarda de documentação
para efeito de fiscalização. Hoje ela estabelece que o sujeito passivo de Imposto de
Renda (Pessoa Jurídica), Contribuição Social e IPI (usuário de sistemas de
processamento de dados) deverá manter documentação técnica completa e
atualizada do sistema, suficiente para possibilitar sua auditoria;
resgate do ´know-how´ da organização: muitos sistemas podem e devem ser
considerados ativos da organização, e como tal devem ter uma documentação
confiável e segura;
detecção de falhas eventualmente existentes nos sistemas: na atividade de
documentação de sistemas, é possível encontrar erros de lógica que podem
provocar resultados inesperados;
liberação de recursos computacionais: a atividade de documentação de sistemas
também permite reportar programas e trechos de código que não estão sendo
utilizados;
padronização para a certificação de qualidade: quando um sistema faz parte de um
processo que está sendo preparado para uma certificação, torna-se necessário que
este sistema tenha suas funções documentadas para efeito de auditoria;
maior facilidade de entendimento do sistema: mesmo um profissional de
informática que não conheça o sistema terá maior facilidade de entendimento pela
utilização da documentação no lugar da utilização dos fontes dos programas;
comunicação eficaz das informações entre as áreas envolvidas: quando a
comunicação entre as área acontece formalmente e apoiada em documentos
padronizados, a possibilidade de falha no entendimento fica reduzida. A
18
formalização auxilia não só o destinatário mas o próprio remetente, visto que sua
demanda será melhor explicitada.
Outro benefício a ser citado é o de que a documentação de sistemas figura
como importante material de pesquisa para que seja possível utilizar certas técnicas de
Reegenharia de Informação, definida por [FURLAN, 1994], como “Conjunto de
ferramentas orientadas à avaliação, reposicionamento e transformação de sistemas de
informação existentes, com o objetivo de estender-lhes a vida útil e ao mesmo tempo,
proporcionar-lhes uma melhor qualidade técnica e funcional.”
As áreas de atuação da Reengenharia de Informação, são: Reestruturação,
Engenharia Reversa, Reutilização, Migração e Engenharia de Redesenvolvimento.
Nestas áreas, pode-se citar um maior envolvimento do elemento da
documentação nos processo de Reutilização e Engenharia Reversa, assim definidas por
[FURLAN, 1994]:
“A Reutilização/Reuso, denominada como o múltiplo uso de uma dada função da aplicação, é utilizada com o objetivo de acelerar e simplificar o processo de desenvolvimento, melhorar a confiabilidade do software e reduzir custos. Para a utilização desta técnica, a documentação figura como fator importante na pesquisa de funções do sistema , na medida em que produz informações de funções já existentes, proporcionando auxílio e base para a criação de novas funções.
A Engenharia Reversa, descrita como processo de derivar especificações lógicas dos componentes do sistema a partir da sua descrição física, é vista como uma atividade trabalhosa, mas que visa recuperar o conhecimento e melhorar compreensão dos sistemas. Usualmente tem que ser empregada quando a documentação do sistema não foi atualizada ou elaborada.”
CAPÍTULO 3
CELEPAR – COMPANHIA DE INFORMÁTICA DO PARANÁ
3.1 HISTÓRICO
3.2 ACIONISTAS
3.3 ATIVIDADES
3.4 ESTRUTURA ORGANIZACIONAL
3.5 METODOLOGIA DE DESENVOLVIMENTO DE SERVIÇOS – MDS
3.5.1 Composição da Metodologia
3.6 DOCUMENTAÇÃO DE SISTEMAS
3.6.1 Evolução do Processo
3.6.2 O Processo Atual
3.6.3 Estrutura da Base Notes de Documentação de Sistemas
3.6.4 Descrição da Função Documentador de Sistemas
20
3 CELEPAR – COMPANHIA DE INFORMÁTICA DO PARANÁ
3.1 HISTÓRICO
Primeira empresa de informática pública no Brasil – a CELEPAR nasceu em
24 de novembro de 1964, com o nome original de Centro Eletrônico de Processamento
de Dados do Paraná. Tinha como missão principal processar a folha de pagamento dos
funcionários públicos do Estado.
Gradativamente, foi ampliando seu raio de ação junto a administração
pública do Estado. Em 1975 a empresa passou a se chamar Companhia de
Processamento de Dados do Paraná e em 1994, transformou-se na Companhia de
Informática do Paraná.
Essa mudança de razão social, decorre do planejamento estratégico que
redefiniu o negócio: soluções para a gestão na administração pública, e a missão:
promover soluções de melhoria da administração pública do Paraná e dos serviços
prestados ao cidadão, utilizando tecnologias da informação e de gestão.
A CELEPAR é uma sociedade de Economia Mista, de capital fechado, cujo
acionista majoritário é o Estado do Paraná. O quadro funcional atualmente é composto
por 568 empregados.
3.2 ACIONISTAS
Banco Banestado S.A;
Companhia de Desenvolvimento Agropecuário do Paraná – CODAPAR;
Companhia de Energia do Paraná – COPEL;
Companhia de Saneamento do Paraná – SANEPAR;
Fundação CELEPAR – FUNCEL;
Fundo de Desenvolvimento Econômico – FDE;
Prefeitura Municipal de Curitiba;
Procuradoria Geral do Estado – PGE.
21
3.3 ATIVIDADES
Seu objetivo é fornecer soluções em Tecnologia da Informação no âmbito do
Governo do Estado Paraná. Para isto desenvolve atividades prestando serviços de
planejamento e soluções de tecnologia da informação através de ambiente integrado
para os sistemas do Governo, planejamento de soluções de Tecnologia da Informação,
apoio nos processos de compra de produtos e serviços de informática, garantia de
continuidade para serviços corporativos do Estado.
Promove programa de voluntariado – Celepar na Comunidade - iniciado em
1999, buscando a disseminação da informática e do seu potencial de uso no dia a dia
aos alunos de algumas escolas públicas da rede estadual de ensino fundamental e
médio.
Tem participação através de empregados em diversas comissões de estudo,
sedia e patrocina um subcomitê da Associação Brasileira de Normas Técnicas – ABNT
( SCB 21:10 Subcomitê de Software). Incentiva apresentações de trabalhos científicos
em congressos técnicos/científicos nacionais e internacionais. Veicula o jornal
institucional de caráter técnico (Bate Byte), visando a publicação de artigos técnicos
elaborados pelos empregados e colaboradores e dirigido à comunidade de informática.
Atua como co-agente de ensino-aprendizagem, oferecendo oportunidades de estágio
para a comunidade acadêmica, através de convênios mantidos com o Centro de
Integração Empresa-Escola (CIEE).
Mantém programas de incentivo à educação e investe em treinamento e
desenvolvimento de pessoal, através de programas voltados a conhecimentos técnicos,
de gestão, organizacionais e humanos.
22
3.4 ESTRUTURA ORGANIZACIONAL
FIGURA 01 – ESTRUTURAL ORGANIZACIONAL DA CELEPAR
Fonte: Base Notes em CELEPAR2_CTA_M/CELEPAR/PR.GOV.BR. Jun. 2001
CONSELHOFISCAL
FUNDAÇÃOCELEPAR
PREVICEL
ASJUR ASINF
ASCOM ASINT
ASPLA
ASAFI
DIARE
DIEFI
DIPLA
DICON
GFI
DIPRH
DIPES
GRH
DISUP
DIFRA
DISAD
GAD
DAF
GPA
ASTEC
DIRED
DISER
GSR
DISOP
DIPRO-FEC - lDIPRO-FEC -DIPRO-FEC -DIPRO-FEC -
DIPRO
DIADI-D -DIADI-D -DIADI-D -
DIADI
DIOPE-OAC -DIOPE-OAC -
DIOPE
GSO
DITED
GPT
DITEC-A
DITEC-B
DITEC-C
DITEC-D
DITEC-E
DITEC-F
DITEC-G
GPS
DISAT
DETRAN/BPTRAN/ABNCPR-PREVIDÊNCIA/BPPSEID/SEDU/PR-CIDADE/SEOP/DECOM/MINEROPAR/IPEM/PGE/PROCON/OUVIDORIA/CCTG/CCC/PR-ESP/PR-TURSEMA/IAP/SUDERHSA/SECR/IASP/PROVOPARSEAP/DETO/DEAPSEFA/CAFE SEFA/CRESECS/AFPR/AL/BADEP/BANESTADO/CREA-PR/CMC/CITPAR/CASA MILITAR/FENABRAVE/DEAM/MTM/COMURB/UFPR/TRT/TJ/TC/TA/SERLOPAR/MIN.PUBL./URBS/SANEPAR/COPEL/FOZTRANS/PUC/ICI/PRT/PMCSEAB/CODAPAR/CEASA/CLASPAR/SEPH/EMATER/UNIV.CAMPO/COHAPAR/IAPARFAC.EST./SETI/TECPAR/UNIV.EST./SERT/SINESESP/POLÍCIA CIVILSEED/FUNDEPAR SEED/FUNDEPARSETR/DER/APPA/FERROESTE/JUCEPAR/DSTC/DIOEISEPR/SESAC.CIVIL/SCGG/SEEG/VICE-GOV/ESC.BRASÍLIA/CEI/SEAE/JMNSEPL/IPARDES/COMEC/SEEC/TVE/MUSEUS/SEJU/DEPEN/DEFENSORIA/PMPR
N.INFORMÁTICA
GAC
DT
PRESIDÊNCIA
DIRETORIAEXECUTIVA
CONSELHO DEADMINISTRAÇÃO
ASSEMBLÉIAGERAL
23
3.5 METODOLOGIA DE DESENVOLVIMENTO DE SERVIÇOS - MDS
A metodologia para desenvolvimento de projetos adotada pela CELEPAR,
tem por objetivo estabelecer um processo de desenvolvimento de serviços, onde:
as necessidades do cliente sejam atendidas de acordo com os requisitos levantados
e no tempo requerido;
a participação do cliente seja garantida, principalmente nos pontos decisivos do
projeto;
a qualidade dos produtos ou serviços seja assegurada;
o planejamento e o acompanhamento dos projetos sejam executados de uma forma
natural; e
a documentação gerada, seja preservada.
A Metodologia de Desenvolvimento de Serviços foi criada e implantada em
1991. A partir deste momento, ocorreram vários processos de discussão e
aprimoramento da MDS, que tiveram como resultado a proposição de sugestões para
sua alteração e melhoria. Encontra-se atualmente na sua segunda versão e é organizada
por roteiros, guias e técnicas, baseadas em princípios e procedimentos observados na
engenharia de software e de acordo com a cultura da empresa. A idéia principal é que
a equipe utilize os produtos descritos, levando em conta principalmente os requisitos e
restrições do serviço a ser desenvolvido, adaptando-os na geração de um plano de
trabalho específico.
3.5.1 Composição da Metodologia
A metodologia é composta por uma série de roteiros:
Roteiro de Projeto Preliminar (RPRE): é um roteiro de caráter genérico, destinado
a orientar e planejar a abordagem. Possibilita a identificação da situação-problema
e a associação da solução ao problema. É um roteiro flexível e que se adapta aos
mais variados serviços.
24
Roteiro de Atividade Contínua (RCON): tem por objetivo orientar a execução das
tarefas relativas aos sistemas já implantados, que correspondem a uma parcela
significativa dos trabalhos desenvolvidos na empresa.
Roteiro para Acompanhamento (RPAC): tem por objetivo apoiar o gerenciamento
de projetos e estabelecer um acompanhamento formal sobre os projetos em
andamento, com a apuração de indicadores de qualidade do processo de
desenvolvimento.
Roteiro de Documentação (RDOC): que visa a organização e preservação da
documentação gerada nos projetos desenvolvidos pela empresa, além de um fácil
acesso pelos técnicos e a garantia de repasse de informações. (ANEXO I)
Roteiro de Revisão (RREV): que tem como objetivo orientar a realização das
revisões, que atuam como meio de garantia de qualidade dos produtos gerados,
apoiadas em formulários pré-definidos e check-list's. Outro aspecto considerado
neste roteiro é a agregação de conhecimentos diferenciados com a participação dos
revisores e seu comprometimento com o sucesso do projeto.
É composta ainda por:
Guias Técnicos que visam auxiliar na aplicação das técnicas que estão definidas
dentro do roteiro;
Ferramentas de aumento de produtividade (ER-WIN, BP-WIN, RATIONAL
ROSE);
Padrões que garantem uma uniformidade de enfoque e permitem uma base comum.
3.6 DOCUMENTAÇÃO DE SISTEMAS
3.6.1. Evolução do Processo
A CELEPAR tem mantido, ao longo dos anos, processos de documentação
de sistemas que passaram por diversas fases e foram evoluindo com o passar do
tempo, adaptando-se à evolução das tecnologias.
Houve tempo em que as documentações referentes a usuário, operacional e
análise, eram datilografadas exigindo grande trabalho para se fazer alterações. Em um
25
outro momento os textos passaram a ser editados no software DCF (Document
Composition Facility) da IBM e VENTURA PUBLISHER INC. da Xerox Company.
Os modelos de documentos e relatórios eram anexados através de colagem,
necessitando manter Pastas de Originais para fazer substituições e tirar cópias que se
fizessem necessárias.
Atualmente o processo de documentação está previsto na MDS
(Metodologia de Desenvolvimento de Serviços) e utiliza meios de desenvolvimento e
armazenamento com a finalidade de preservar o histórico, permitir consultas, e servir
como material de apoio e referência aos projetos.
3.6.2 O Processo Atual
A CELEPAR conta atualmente com o software Lotus Notes (Lotus
Development Corporation) e através dele desenvolve bases de dados que armazenam e
interligam informações.
A partir do segundo semestre do ano de 1999, foi implantada a base de dados
Notes denominada DOCUMENTAÇÃO DE SISTEMAS, possibilitando o
armazenamento, consulta e trâmite dos manuais. Em setembro de 2001, foi
incorporado a esta base o armazenamento dos projetos, visando centralizar o processo
e resgatar todas as informações pertinentes aos sistemas desenvolvidos pela empresa .
Os modelos a serem seguidos no início da documentação dos projetos são
encontrados nos roteiros (Roteiro para Projeto Preliminar - RPRE), para
desenvolvimento (Roteiro para Análise Estruturada - RAES), para manutenção
(Roteiro para Atividade Contínua - RCON), assim como para gestão (Roteiro para
Acompanhamento - RPAC) e de apoio (Roteiro para Revisão Técnica - RREV e
Roteiro para Documentação - RDOC) e podem ser acessados através de uma base
Notes denominada PORTFÓLIO DE TECNOLOGIAS.
Os projetos e manuais elaborados, os modelos para confecção de manuais e
solicitações de serviços para confecção de manuais e pastas, são armazenados na base
Notes denominada DOCUMENTAÇÃO DE SISTEMAS.
26
O software para a produção de textos normalmente utilizado é o MS-WORD
(software de uso geral da empresa), tendo como objetivo padronizar e facilitar o
acesso a todos os que fazem uso da documentação. Os documentos produzidos são
armazenados na base Notes - DOCUMENTAÇÃO DE SISTEMAS, através de
formulários e documentos anexados, o que possibilita:
aos analistas, efetuar solicitação de confecção ou alteração das documentações,
bem como agilizar o processo fornecendo um material prévio para ao grupo
responsável pela documentação;
trâmite do material em desenvolvimento, vinculado a memorandos e histórico do
processo, até o momento do término;
armazenamento em local único, centralizando toda a documentação produzida
oficialmente na CELEPAR desde o início do desenvolvimento do sistema;
aos setores da produção, o acesso imediato a informações de alterações efetuadas
pelos analistas;
aos clientes, consultar suas respectivas documentações;
acesso aos modelos dos manuais a serem elaborados para o usuário e manuais
operacionais (manuais da produção).
Quanto aos modelos utilizados, são apenas básicos e têm o objetivo de
apresentar o mesmo layout para todas as documentações elaboradas na CELEPAR.
Eles são adaptáveis e independem da plataforma tecnológica em que o sistema está
sendo desenvolvido, ou seja, podem ser utilizados para aplicativos Mainframe
(processados em computadores de grande porte), Lotus Notes (bases de dados
processadas através do software da Lotus Development Corporation), Internet
(aplicações disponíveis na WEB – World Wide Web - rede de alcance mundial),
Windows (sistema operacional para aplicações de pequeno porte), WAP (Wireless
Application Protocol - comunicação sem fio), etc. Os modelos de documentos e
relatórios a serem inseridos nos manuais estão sendo digitalizados, tornando
desnecessária a manutenção de Pastas de Originais.
27
3.6.3 Estrutura da Base Notes de Documentação de Sistemas
Solicitação de Documentação: O solicitante envia dados básicos do serviço
pretendido e pode anexar algum material que sirva de apoio e agilize o trabalho dos
documentadores. (ANEXO II)
Solicitação de Pastas: Solicitar pastas de Manual de Arquitetura e Documentário.
Ao preencher esta solicitação ocorre um registro na base de dados, que possibilita
saber quem é o analista responsável pelo aplicativo e localização das pastas
referentes às informações técnicas e históricas do sistema. (ANEXO III)
Solicitação de Armazenamento de Projetos: Armazenar toda a documentação
gerada desde o início do projeto. (ANEXO IV)
Modelos de Documentação: Permite o acesso a modelos utilizados para a
confecção de Manual da Produção e Manuais de Cliente, como: Cartelas, Help,
Guias de Usuário (usados em aplicativos de pequeno porte e que requerem pouca
descrição) e Manuais de Usuário (usados em aplicativos de grande porte e que
requerem maior quantidade de informações).
3.6.4 Descrição da Função Documentador de Sistemas
Elaborar padrões para documentação convencional (manuais, cartelas, help, etc.);
Analisar as solicitações e formular as alternativas da forma de documentar,
conforme o padrão estabelecido;
Verificar nas alterações enviadas pelos analistas diretamente para os setores da
produção, qual o impacto produzido nas diversas seções do manual, revisar,
providenciar atualizações e, quando for o caso, elaborar os fluxogramas
(diagramas que fornecem instruções para processamento dos programas);
Elaborar memorando para os setores da produção e providenciar a atualização do
sistema na base;
Planejar a execução das tarefas, verificando prazos estabelecidos nas solicitações;
Coletar informações junto aos analistas, usuários, ou através da simulação de uso
do sistema;
28
Elaborar documentação necessária baseando-se nas informações coletadas, de
acordo com as necessidades dos órgãos usuários e de acordo com a plataforma de
desenvolvimento do sistema;
Revisar versão preliminar junto com o analista responsável pelo sistema;
Preparar versão final, providenciando cópias necessárias, memorandos e
apresentação do sistema para os setores da produção, quando estes estiverem
envolvidos, e a publicação final atualizando a base;
Avaliar os recursos utilizados na documentação, sugerindo novas técnicas,
ferramentas e melhoria na forma de organização do trabalho;
Participar na definição de metodologia aplicada a documentação de sistemas;
Prestar apoio aos analistas no que se refere a elaboração de documentos, sugestões
de alternativas para a forma de documentação, padronização e utilização da base
documentação;
Prestar apoio aos técnicos dos setores da produção no que se refere a base de
documentação e alterações enviadas pelos analistas;
Gerenciar a base de Documentação de Sistemas.
CAPÍTULO 4
EMPRESAS VISITADAS
4.1 VISITAS
4.1.1 Empresa A
4.1.2 Empresa B
4.1.3 Empresa C
30
4 EMPRESAS VISITADAS
4.1 VISITAS
4.1.1. Empresa A
Breve Histórico:
A empresa A, tem sua matriz brasileira em Curitiba.
É especialista em serviços financeiros, com 6.500 escritórios e agências em
todo o mundo, que empregam aproximadamente 165 mil funcionários e atendem a 29
milhões de clientes. As ações da corporação são cotadas nas Bolsas de Londres, Paris,
Hong Kong e Nova Iorque e contam com 190 mil acionistas.
O Grupo da qual a empresa é participante tem sede na Inglaterra, está
presente em 78 países e territórios, tendo 136 anos de tradição.
Data da visita: 24/09/2001.
Visita ao Centro de Documentação (CDO) no dia 24/09/2001.
O Centro de Documentação é responsável pela biblioteca e controle de
armazenamento de documentos.
A empresa possui Metodologia de Desenvolvimento de Sistemas e os
estágios vão desde a fase de definição do projeto que abrangem seu contrato inicial e
estudo da viabilidade, fase de instalação e fase de suporte, que compreende a revisão
para a implementação e o suporte ao produto gerado.
Nesta metodologia a documentação dos sistemas está prevista para ser
elaborada ao final de cada fase, produzindo documentos, entre eles manuais de
sistemas, com base em modelos padrão.
Os manuais de sistema previstos para serem elaborados são:
Manual de Operação;
Manual de Usuário;
Manual de Treinamento.
A responsabilidade pela produção da documentação é dos Analistas de
31
Sistemas que, após sua elaboração devem enviá-las ao CDO, através de um sistema
disponibilizado através de uma Intranet. Este sistema foi desenvolvido internamente,
em plataforma Lotus Notes (software da Lotus Development Corporation) e permite a
definição de acesso de grupos de pessoas e liberações de ações a serem realizadas com
o documento. Está em funcionamento desde Abril/2001.
As documentações são anexadas em software da ADOBE, formato PDF -
Portable Document Format (formato que disponibiliza o documento como uma
imagem, não permitindo alterações) a um formulário de cadastro do sistema. Este
formulário contém campos como título, assunto, resumo, notas, autor principal, editor,
fornecedor, grupo de acesso, responsável, etc., que permitem verificar de forma
resumida dados sobre os documentos anexados, facilitando a consulta.
Como forma de segurança da integridade das informações, as alterações
destas documentações são feitas pelo analista responsável pelo sistema e somente ele e
uma pessoa indicada por ele tem acesso ao documento-fonte (documento original),
elaborado geralmente em formado ´DOC´ (documento em formato texto). Há também
no formulário de cadastro a indicação do nome das pessoas autorizadas para efetuar
estas alterações.
Após o recebimento das documentações anexadas através do sistema , os
bibliotecários do CDO – Centro de Documentação, fazem verificações para evitar
duplicidade de cadastros e documentos e efetuam sua publicação (repasse do
documento a um servidor – máquina que armazena e compartilha informações).
Após a publicação, a documentação fica disponível para consulta geralmente
sem restrição de acesso, através da Intranet.
32
4.1.2 Empresa B
Breve Histórico:
Empresa pública de prestação de serviços em Tecnologia da Informação,
criada em 1964, com o objetivo de modernizar e dar agilidade a setores estratégicos da
administração pública. É uma empresa vinculada ao Governo Federal e consolidou-se
aprimorando tecnologias adotadas para diversos órgãos públicos federais, estaduais e
municipais.
Distribui-se fisicamente na Capital Federal e em outras dez capitais do
território nacional. São 8.739 empregados alocados em mais de 330 municípios
brasileiros. Seu mercado de atuação está no segmento de finanças públicas na esfera
federal o que corresponde 85,2% do volume de negócios da Empresa. Atua também no
segmento das ações estruturadas e Planejamento, Orçamento e Gestão e estende-se a
outros órgão governamentais que venham a constituir ações nesse segmento e que
demandem serviços de tecnologia de informação.
Data da visita: 04/10/2001.
Primeiramente foi visitada a área responsável pelo atendimento aos órgãos
federais que tratam do Planejamento, Orçamento e Gestão. Em seguida foi visitada a
área responsável pelo atendimento ao órgão correspondente a Administração
Tributária
Na primeira área observou-se que os analistas elaboram as documentações e
as informações referentes a manutenção do Banco de Dados (inclusão, alteração,
exclusão de campo, descrição do conteúdo dos campos e tabelas). É utilizado o
software PREDICT do mesmo fornecedor do Banco de Dados ADABAS (Consist).
O conteúdo dos manuais de usuários é também elaborado pelo analista que
envia o material para um grupo de técnicos (Documentadores). Estes cuidam da
editoração utilizando o software MS-WORD, impressão e publicação, tornando
disponível para consulta em um sistema interno disponibilizado na Intranet.
Na Segunda área visitada, observou-se que os sistemas lá desenvolvidos são
processados na região de São Paulo. As documentações de produção (operacionais),
33
são elaboradas por documentadores, utilizando formulários padronizados, editados no
software MS-WORD, anexadas em memorandos e enviadas através de correio
eletrônico.
O armazenamento das documentações produzidas por esta área encontram-se
num sistema disponível na Intranet. Este sistema visa armazenar a documentação em
local único, melhorar o suporte ao serviço, reduzir o tempo de resposta oferecido pela
máquina em caso de consulta, agilizar procedimentos de alterações, facilitar o acesso
às informações e manter o histórico dos produtos e serviços.
Os manuais do usuário são elaborados pelo próprio usuário.
A empresa possui diversos pontos de atendimento, situados em diferentes
capitais do país e cada ponto de atendimento é responsável por fornecer soluções a um
determinado órgão do governo. O técnico que guiou a visita informou que em função
desta multiplicidade de locais de atuação e da divisão de serviços existente, torna-se
necessária uma redefinição funcional de papéis dos empregados e de unificação no
sistema de construção e trâmite de informações. Para isso a empresa está buscando
implantar o Rational Unified Process (RUP), software de apoio aos processos de
desenvolvimento que visa integração e padronização em todas as suas unidades,
promovendo assim, a reestruturação de todos os procedimentos atualmente adotados
no desenvolvimento de sistemas.
34
4.1.3 Empresa C
Hístórico:
Com 25 anos de atividade, é uma empresa com vasta experiência no
provimento de soluções de negócios baseadas em Tecnologia da Informação,
destinadas principalmente aos mercados corporativo e institucional, em especial às
empresas públicas e privadas que sejam grandes consumidoras de TI, e cuja
performance das atividades dependa também de uma boa performance nessa área.
A partir da matriz em Curitiba (PR), com 200 colaboradores, a empresa atua
nos principais mercados do Centro-Sul do Brasil e mantém especial interesse no
desenvolvimento de negócios nos principais centros dos EUA, da União Européia e do
Mercosul.
Parcerias:
A empresa busca incessantemente o estabelecimento de parcerias e acordos
de transferência de tecnologia junto às principais empresas do setor. Nos últimos anos,
procurou parcerias para a sua nova linha de soluções de negócios, além de estabelecer
parcerias estratégicas para o desenvolvimento de negócios no mercado externo com
empresas nos EUA, na França e na Colômbia. Além disso, mantém acordos com
importantes empresas do mercado, visando o repasse de tecnologias e a capacitação
tecnológica
Foco na qualidade:
O conceito de qualidade tem sido aplicado ao longo dos últimos anos, de
forma que o processo produtivo de desenvolvimento de software tem evoluído de
artesanal para sistematizado e documentado. Com a contribuição de seus
colaboradores, são definidas e utilizadas metodologias e padrões de desenvolvimento
que implementam os conceitos da Engenharia de Software, adequando-os à realidade
do mercado atual de Tecnologia da Informação, para evitar a burocracia excessiva e o
retrabalho.
É uma das poucas empresas brasileiras de software com certificação ISO
35
9001 (Sistema de Qualidade – Modelo para Garantir a Qualidade em
Projeto/Desenvolvimento, Produção, Instalação e Assitência Técnica). A série ISO
9001 a 9003 especificam os requisitos do Sistema de Qualidade. A certificação é
fornecida quando existe um sistema de qualidade em uma organização, e se esta reúne
os requisitos mínimos para a certificação de qualidade da ISO (International for
Standardization Organization). A principal vantagem de ter uma certificação deste tipo
é que, com a globalização da economia, os potenciais clientes exigem cada dia mais e
melhores produtos e/ou serviços, o qual deve estar correlacionado com o preço que
estão dispostos a pagar. Um sistema de qualidade bem definido garante uma qualidade
constante no produto e/ou serviço a ser adquirido pelo cliente.
Data da visita: 06/11/2001.
A empresa possui metodologia e padrões de desenvolvimento. A primeira
versão foi implantada em 1997 e em 1998 recebeu certificação ISO 9001.
A metodologia é dividida em fases do ciclo de vida, gerando documentação
em todas as fases. Existem alguns produtos obrigatórios e outros opcionais,
dependendo da característica do projeto. Os produtos gerados são elaborados através
de modelos disponibilizados na Intranet.
No início do projeto é formalizado um gerente e sua equipe técnica, bem
como é criada uma área específica e configuradas as restrições de acesso, onde são
armazenadas todas as documentações geradas desde a elaboração da proposta até a
manutenção.
A empresa possui um grupo de documentação de sistemas que elabora a
documentação de usuário e operacional a partir das informações contidas na área
destinada ao projeto e ainda de informações repassadas pela equipe técnica. A equipe
técnica faz a revisão final dos manuais que são parte integrante de uma das fases da
metodologia. Os produtos gerados variam de acordo com a necessidade do projeto.
O software utilizado para armazenamento é o Source Safe (Microsoft). É um
software de gestão de configuração que controla o acesso a todos os dados. O usuário
acessa o arquivo que deseja trabalhar e enquanto isto outra pessoa só pode consultá-lo,
não podendo fazer atualizações. As atualizações só poderão ser feitas por um outro
36
usuário autorizado quando o arquivo for devolvido à área destinada ao projeto.
O acompanhamento do projeto é feito através de um programa
disponibilizado no site da empresa que permite ao cliente saber de todo o andamento
do seu projeto e possibilita ainda o trâmite de informações, aprovações, etc.
A empresa possui auditoria interna e auditoria anual de certificação, o que
faz com que haja um esforço de toda a equipe de trabalho para que todas as fases da
metodologia sejam seguidas.
CAPÍTULO 5
ANÁLISE DAS PESQUISAS
5.1 PRINCIPAIS PONTOS OBSERVADOS DURANTE ÀS VISISTAS
5.1.1 Análise dos Principais Pontos observados durante às Visitas
5.2 ANÁLISE DO QUESTIONÁRIO ENVIADO AOS TÉCNICOS DA CELEPAR
5.2.1 Apresentação dos Dados Coletados
5.2.2 Análise dos Dados Coletados
38
5 ANÁLISE DAS PESQUISAS
5.1 PRINCIPAIS PONTOS OBSERVADOS NAS VISITAS
TABELA 01 – DADOS GERAIS DAS EMPRESAS
ITens Empresa A Empresa B Empresa C
Características Integrante de um grupo multinacional
Unidade Regional Mantem parcerias
Atividade Serviços Financeiros Soluções em Tecnologia da Informação
Soluções em Tecnologia da Informação
Tempo de atividade 136 anos 37 anos 25 anos
Número total de empregados
165.000 8.739 200
Certificação ISO 9001 Não Não Sim TABELA 02 – DOCUMENTAÇÃO DE SISTEMAS - ELABORAÇÃO
ITENS ENPRESA A EMPRESA B EMPRESA C
Metodologia de Desenvolvimento de Sistemas
Possui Possui Possui
Utilização da metodologia
Alguns técnicos utilizam
Alguns técnicos utilizam
Todos os técnicos utilizam
Padrão para elaboração de documentação de projetos
Possui Não possui Possui
Elaboração da documentação dos projetos
Alguns técnicos elaboram
Alguns técnicos elaboram
Todos os técnicos elaboram
Padrão para elaboração de Manuais
Possui Não possui Possui
Elaboração de Manuais de Sistemas
Nem sempre são elaborado
Nem sempre são elaborado
Sempre são elaborados
Quem elabora os manuais de sistemas
Analista responsável pelo sistema
Analista/Usuário/ Técnicos Documentadores
Técnicos Documentadores
continua
39
TABELA 02 – DOCUMENTAÇÃO DE SISTEMAS - ELABORAÇÃO
continuação
ITENS EmpreSA A EMPRESA B EMPRESA C
Software padrão para elaboração de documentação
Possui Possui Possui
Utilização de software padrão para elaboração de documentação de sistemas
Utilizam Nem todos utilizam Utilizam
TABELA 03 – DOCUMENTAÇÃO DE SISTEMAS – ARMAZENAMENTO E CONTROLE
ITENS EMPRESA A EMPRESA B EMPRESA C
Local de armazenamento de toda a documentação produzida
Servidores Web Meios Diversos Servidores Web
Meio de disponibilização das documentações produzidas
Intranet Meios Diversos Intranet
Responsável pelo controle e disponibilização das documentações produzidas
Técnicos do Centro de Documentação
Em cada área existe um responsável
Técnicos envolvidos com o processo
5.1.1 Análise dos Principais Pontos Observados Durante às Visitas
Do exposto na tabela 01, verificou-se que todas as empresas são de grande
porte e que apenas a empresa ‘C’, possui certificação ISO 9001.
No que se refere a elaboração de documentação, conforme tabela 02,
verificou-se que todas as empresas possuem metodologia de desenvolvimento. A
empresa ‘A’ segue padrões e possui software específico utilizado pela empresa como
um todo para documentar seus sistemas, porém a elaboração de manuais fica a cargo
dos analistas e nem todos os sistemas possuem documentação completa. A empresa
‘B’ é dividida em áreas e cada área tem seu processo de documentação particular, não
existindo linhas específicas a serem seguidas e nem documentação completa de todos
40
os sistemas produzidos. A empresa ‘C’ demonstrou ter um processo bem definido,
fazendo parte da atividade funcional dos analistas documentar cada fase de seus
projetos, baseados em um software padrão. Também disponibilizam estas
documentações em uma base de dados, fornecendo, assim, informação para todos os
interessados e também para os técnicos documentadores subsídio para a elaboração
dos manuais de sistemas. Esta empresa é auditada periodicamente e para manter sua
certificação ISO 9001, necessita que a documentação seja permanentemente completa
e atualizada para todos os sistemas produzidos.
No que se refere ao armazenamento da documentação, conforme tabela 03,
verificou-se que a empresa ‘A’, possui um local único de armazenamento que
comporta os modelos padrão e toda a documentação produzida. O controle e o
gerenciamento deste documentos é feito por técnicos lotados num setor específico. Na
empresa ‘B’ tanto o local de armazenamento, quanto meio de disponibilização e
responsabilidade pelo controle das documentações ficam a cargo de cada área, com
trabalhos produzidos independentemente, demonstrando não haver comunicação e
reaproveitamento de informações. Quanto à empresa ‘C’, demonstra ter local único
para armazenamento de todos os documentos padrão e documentos produzidos, onde
cada técnico, ao elaborar um documento, tem a responsabilidade de torná-lo disponível
para os demais interessados e autorizados.
41
5.2 QUESTIONÁRIO ENVIADO AOS TÉCNICOS DA CELEPAR (ANEXO V)
5.2.1 Apresentação dos Dados Coletados
Dos 120 questionários enviados 52 retornaram preenchidos, alcançando o
índice de retorno de 43%.
Respondentes em relação aos questionários enviados (120)
Não respondentes
(68)57%
Respondentes (52)43%
FIGURA 02 – GRÁFICO QUANTIDADE DE QUESTIONÁRIOS REMETIDOS/PREENCHIDOS
5.2.2 Análise dos Dados Coletados
Este item apresenta as análises das tabulações do questionário enviado aos
técnicos da CELEPAR.
As respostas para as perguntas de múltipla escolha, onde os respondentes
optaram por uma ou mais alternativas, e as respostas para as perguntas dicotômicas,
onde os respondentes optaram por respostas do tipo ‘sim ou não’, foram analisadas
com o auxílio de representação gráfica, utilizando-se gráficos do tipo: Linhas ou
Curvas (traçados em sistemas de coordenadas cartesianas e que representam com
exclusividade as séries temporais), Setores ou Retangular (traçados em forma circular
e representam com exclusividade séries geográficas e as especificativas) e Barras ou
Colunas (gráficos demonstrativos que podem representar qualquer série estatística).
Os gráficos foram agrupados, visando delimitar cada tópico a ser analisado e
em seguida foi apresentada a análise de cada grupo de respostas.
As respostas fornecidas para as perguntas abertas, onde os respondentes
ficaram livres para apresentar suas idéias, foram demonstradas em tabelas e transcritas
42
na íntegra. Não foram corrigidos erros ortográficos ou gramaticais, com o objetivo de
manter a integridade das idéias.
Visando apresentar os dados de maneira coerente, foi mantida a ordem das
respostas. Cada resposta foi analisada individualmente procurando-se identificar os
principais tópicos apontados e sintetizar as coincidências.
a) Análise do Perfil do analista
1 HÁ QUANTO TEMPO TRABALHA, NA CELEPAR, NA ÁREA DE DESENVOLVIMENTO? FIGURA 03 – GRÁFICO TEMPO DE TRABALHO NA CELEPAR
0
5
10
15
20
25
30
Núm
ero
de a
nos t
raba
lhad
os
1 3 5 7 9 11 13 15 17 19 21 23 25 27 29 31 33 35 37 39 41 43 45 47 49 51
Número do respondente
43
2 QUE ATIVIDADE EXERCE? FIGURA 04 – GRÁFICO TIPO DE ATIVIDADE
0
10
20
30
40
50
60
Desenvolvimento de Novos Projetos Manutenção Outros
3 QUAL(IS) A(S) PLATAFORMA(S) DE TRABALHO? FIGURA 05 – GRÁFICO PLATAFORMA DE TRABALHO
2
3
4
9
1
2
4
5
3
2
6
11
0
2
4
6
8
10
12
Notes Windows InternetMainframe Windows/Mainframe Internet/NotesInternet/Windows Internet/Mainframe Notes/Windows/MainframeInternet/Notes/Mainframe Internet/Windows/Mainframe Internet/Notes/Windows/Mainframe
44
Analisando as informações referentes ao perfil dos 52 analistas que
responderam ao questionário, representadas nas figuras 02 a 04, verificou-se que:
61,5 % trabalham na CELEPAR há mais de 10 anos;
57% exercem atividade específica, seja, apenas em desenvolvimento de
novos projetos, ou manutenção, ou ainda em outros onde as respostas apresentadas
apontam para atividades de supervisão e gerenciamento;
43% acumulam atividades de desenvolvimento de novos projetos
manutenção ou desenvolvimento de novos projetos e outras;
34% trabalham com apenas uma plataforma específica;
11,5% trabalham com plataformas voltadas apenas para microcomputadores
53,8% trabalham com plataformas voltadas a microcomputadores e
mainframe simultaneamente.
b) Análise do Conhecimento da Documentação de Sistemas
4 CONHECE A METODOLOGIA DA CELEPAR? FIGURA 06 – GRÁFICO CONHECIMENTO DA METODOLOGIA CELEPAR
50
Sim Não
2
45
5 UTILIZA A METODOLOGIA DA CELEPAR (MDS)? FIGURA 07 – GRÁFICO UTILIZAÇÃO METODOLOGIA CELEPAR
87%
13%
Sim Não
6 CONHECE DOCUMENTAÇÃO DE SISTEMAS? FIGURA 08 – GRÁFICO CONHECIMENTO DA DOCUMENTAÇÃO DE SISTEMAS
96%
4%
Sim Não
Analisando as informações referentes ao conhecimento da documentação de
sistemas, apresentadas pelos 52 analistas que responderam às perguntas, representadas
nas figuras 05, 06 e 07, verificou-se que:
98 % afirmaram conhecer a metodologia da CELEPAR;
87% afirmaram aplicar a metodologia;
96% afirmaram conhecer documentação de sistemas.
Este estudo é complementar e está relacionado a hipótese proposta de que há
desconhecimento por parte dos desenvolvedores, quanto ao processo de documentação
utilizado pela CELEPAR.
46
c) Análise da Importância Demonstrada para a Documentação de Sistemas
7 ACHA NECESSÁRIA A DOCUMENTAÇÃO DE SISTEMAS? FIGURA 09 – GRÁFICO NECESSIDADE DA DOCUMENTAÇÃO DE SISTEMAS 8 ACHA QUE A DOCUMENTAÇÃO DE SISTEMAS AGREGA MAIOR QUALIDADE AO RESULTADO DO PROJETO? FIGURA 10 – GRÁFICO DOCUMENTAÇÃO DE SISTEMAS/QUALIDADE RESULTADO DO PROJETO
100%
0%
Sim Não
100%
0%
Sim Não
9 CONSIDERA O TEMPO EMPREGADO EM DOCUMENTAÇÃO DE SISTEMAS UMA ATIVIDADES SEM IMPORTÂNCIA PARA O RESULTADO FINAL DO TRABALHO? FIGURA 11 – GRÁFICO TEMPO DOCUMENTAÇÃO/IMPORTÂNCIA RESULTADO
17%
83%
Sim Não
10 CONSIDERA QUE O CUSTO DA DOCUMENTAÇÃO DE SISTEMAS ENCARECE O PRODUTO PARA
47
O CLIENTE? FIGURA 12 – GRÁFICO CUSTO/PRODUTO FINAL
35%
65%
Sim Não
Analisando as informações referentes a importância da documentação de
sistemas, demonstrada pelos 52 analistas que responderam às perguntas, representadas
nas figuras 08 a 11, verificou-se que:
100% afirmaram achar a documentação de sistemas necessária e entendê-la
como fator que agrega maior qualidade ao projeto.
83% afirmaram não considerar o tempo gasto na atividade de documentação
de sistemas, sem importância para resultado final do trabalho.
65% afirmaram não considerar que o custo da documentação de sistemas
encarece o produto para o cliente.
Este estudo visa investigar a opinião dos técnicos da CELEPAR em relação
ao assunto Documentação de Sistemas para complemento da análise que propõe
pesquisar o grau de satisfação dos técnicos quanto ao processo utilizado por esta
empresa no momento de elaborar e armazenar as informações geradas na
documentações de sistemas.
48
d) Análise da Utilização do Processo de Documentação Adotado pela CELEPAR
11 CONHECE A BASE DE DOCUMENTAÇÃO DE SISTEMAS FIGURA 13 – GRÁFICO CONHECIMENTO DA BASE DE DOCUMENTAÇÃO DE SISTEMAS
88%
12%
Sim Não
12 QUAL(IS) DOCUMENTO(S) COSTUMA ELABORAR OU SOLICITAR? FIGURA 14- GRÁFICO TIPOS DE DOCUMENTOS ELABORADOS/SOLICITADOS
41 41
30
34
20
14
32
24 24
33
1
0
5
10
15
20
25
30
35
40
45
Projeto PreliminarProjeto LógicoProjeto FísicoModelo de DadosModelo de ProcessosDimensionamentoManual do UsuárioManual da ProduçãoHelpCartelaOutros
49
13 ONDE COSTUMA ARMAZENAR OS DOCUMENTOS GERADOS PARA OS PROJETOS? FIGURA 15 – GRÁFICO LOCAL DE ARMAZENAMENTO DOCUMENTOS
72%
13%
15%
Área da rede
Base de Documentação de SistemasÁrea particular da estação de trabalho
14 QUE FERRAMENTA COSTUMA UTILIZAR NO PROCESSO DE DOCUMENTAÇÃO? FIGURA 16 – GRÁFICO FERRAMENTA UTILIZADAS PARA ELABORAÇÃO
51
1
10
31
9
2 3
0
10
20
30
40
50
60
WORD FRONTPAGE
VISIO ER-WIN BP-WIN RATIONALROSE
OUTROS
50
15 EXISTE ALGUMA OUTRA FERRAMENTA QUE CONSIDERA EFICIENTE NO PROCESSO DE DOCUMENTAÇÃO? QUAL(IS)? FIGURA 17 – GRÁFICO SUGESTÕES DE NOVAS FERRAMENTAS
5
1 1 1
0
1
2
3
4
5
6
Não conhece outras Ferramentas Case SmartDraw, Adobe Acrobat,Scaner, Máquina fotográfica
Digital, Gravador de CD/DVD
Paginas Html
16 COSTUMA ATUALIZAR A DOCUMENTAÇÃO DOS SISTEMAS SOB SUA RESPONSABILIDADE? FIGURA 18 – GRÁFICO ATUALIZAÇÃO DA DOCUMENTAÇÃO
67%
33%
SIM NÃO
51
17 CONHECE OS PRODUTOS ELABORADOS PELA EQUIPE DE DOCUMENTAÇÃO DE SISTEMAS? FIGURA 19 – GRÁFICO CONHECIMENTO DOS PRODUTOS ELABORADOS PELA EQUIPE DE DOCUMENTAÇÃO
69%
31%
SIM NÃO
18 JÁ SOLICITOU SERVIÇOS AO GRUPO DE DOCUMENTAÇÃO, ATRAVÉS DA BASE DE DOCUMENTAÇÃO DE SISTEMA? FIGURA 20 - GRÁFICO SOLICITAÇÃO DE DOCUMENTAÇÃO AO GRUPO DE DOCUMENTAÇÃO
73%
25%
2%
Sim Não Abstenções
19 SE NÃO SOLICITOU, POR QUÊ? FIGURA 21 – GRÁFICO MOTIVO PELO QUAL NÃO FEZ SOLICITAÇÕES AO GRUPO
3
5
2
3
0
1
2
3
4
5
6
Falta deoportunidade
Desconhece oprocesso
Não achounecessário
Abstenções
52
Analisando as informações referentes a utilização do processo de
documentação adotado pela CELEPAR, entre os 52 analistas que responderam ao
questionário, representadas nas figuras 12 a 20, verificou-se que:
88 % afirmaram conhecer a Base de Documentação de Sistemas
Os tipos de documentações elaborados são: 79% Projeto Preliminar e
Lógico, 58% Projeto Físico, 65% Modelo de Dados, 38% Modelo de Processos, 27%
Dimensionamento, 62% Manual do Usuário, 46% Manual da Produção e Help On-
Line, 63% Cartelas e 4% Outros (definidos como Plano Diretor de Informática).
Quanto ao local para o qual os técnicos afirmaram destinar o armazenamento
das documentações elaboradas durante os projetos é: 84% em área da rede, 15% em
área particular da estação de trabalho e 17% na Base de Documentação de Sistemas.
As ferramentas apontadas como utilizadas no momento de documentar os
sistemas são: MS-WORD por 98%, ER-WIM por 60%, BP-WIN por 18%, Visio por
19%, Front Page por 2%, Racional Rose por 3% e ainda 6 % afirmaram utilizar
outras ferramentas, dentre elas foram citadas, PowerPoint, MS-Excel, Aurélio,
Netscape Composer, Outlook Express.
As contribuições com sugestões para novas ferramentas foi de apenas 6%,
apontado ferramentas Case, SmartDraw, Adobe Acrobat, Scaner. Máquina
Fotográfica Digital, Gravador de CD/DVD e páginas HTML, 10 % afirmaram não
conhecer nenhuma outra ferramenta e 84% não deram sugestões.
67% afirmaram atualizar as documentações.
69% afirmaram conhecer os produtos elaborados pelo grupo de
documentação.
73 % afirmaram já ter solicitado os serviços ao grupo de documentação.
25% afirmaram nunca ter solicitado serviços ao grupo de documentação e
destes 23%. apontaram como causa a falta de oportunidade, 15% desconhecimento do
processo, 39% afirmaram não considerar necessário e 23% não informaram o motivo.
53
e) Análise do Atendimento Oferecido pelo Grupo de Documentação de Sistemas
Esta questão foi apresentada quando a resposta dada à pergunta anterior foi
afirmativa, ou seja, àqueles que afirmaram já ter solicitado serviços ao grupo de
documentação.
As considerações solicitadas nesta questão foram prazos, qualidade do
trabalho e atendimento.
TABELA 04 – RESPOSTAS DA QUESTÃO 19 - COMO CONSIDERA O ATENDIMENTO DADO PELO GRUPO DE DOCUMENTAÇÃO DE SISTEMAS?
RESPOSTAS OBTIDAS
Bom.
Muito bom.
Meio demorado.
Nunca solicitou.
Eficiente.
Como o sistema que eu trabalho é de folha de pagamento e como todo mes tem alguma alteração, os prazos para alterar a documentação nem sempre é cumprida. A qualidade é boa e o atendimento também.
Ótimo em relação a prazo, qualidade e atendimento, porém, parece fora da GPS, não agregado aos projetos.
O Serviço e o atendimento é de boa qualidade, em relação a prazos, regular.
Um pouco demorado. Talvez em função do nº de demandas.
Em relação ao Manual de Produção, a parte textual deveria ser de responsabilidade do analista a sua colocação em produção e não utilizar o processo atual em que a documentação vai para o grupo de documentação e este disponibiliza a alteração em produção. Me parece um procedimento desnecessário. Para mim, o grupo de documentação deveria se preocupar em verificar se o que foi colocado em produção pelo Analista está Ok ou não, e se não estiver, aí sim o grupo deveria proceder a alteração e encaminhar para o analista dar seu parecer sobre a alteração e colocá-la em produção. Uma atividade que deve continuar de responsabilidade do grupo é a Elaboração dos Fluxos.
A documentação que conheço e utilizo é o Manual da Produção e um pouco do Projeto Preliminar. Geralmente não existe tempo suficiente para executar todas as etapas da MDS. Atendimento. Muito bom.
Muito burocrático e pouco criativo.
Muito satisfatório.
continua
54
TABELA 04 – RESPOSTAS DA QUESTÃO 19 - COMO CONSIDERA O ATENDIMENTO DADO PELO GRUPO DE DOCUMENTAÇÃO DE SISTEMAS?
continuação
RESPOSTAS OBTIDAS
Eficiente.
Ótimo.
Excelente.
Regular - poderia ser mais utilizada se houvesse um maior comprometimento com prazos, estes prejudicando os prazos dos produtos para o cliente.
Bom.
Prazo muito longo pois, às vezes se tem necessidade de uma nova alteração e a anterior aind não foi implantada. A qualidade do trabalho está bem adequada. O atendimento é bom.
Muito bom.
Satisfatório.
O atendimento para os serviços que já precisei foi muito bom, não tenho reclamação.
Muito bom.
No que se refere ao Manual de Produção, é um tanto quanto lento, o que gera confusões e erros.
Os prazos são longos o que dificulta o trabalho.
O atendimento e qualidade são bons. O prazo para atendimento eventualmente não é o que gostaríamos, portanto deve ser contratado com antecedência.
Acho que o tempo para a documentação demorado. Não pelos técnicos, mas pela quantidade de serviços que eles atendem.
De bom nível.
Considero bom o atendimento.
A solicitação para documentação On-Line está suspensa temporariamente, portanto o parâmentro que tenho para avaliação da equipe é parcial. Até então o atendimento que tive foi excelente.
Bom (só houve uma vez em que eu não fui atendida).
O atendimento e a qualidade do trabalho é bom, quanto a prazos nunca tive problemas.
O atendimento é bom e a qualidade do trabalho também. No item prazos, deve ser melhorado.
Considero o atendimento ótimo.
Eficiente.
Demorado. Esta é uma reclamação constante da equipe.
55
Analisando as informações referentes ao atendimento oferecido pelo Grupo
de Documentação, entre os 39 analistas consultados e que portanto, já utilizaram os
serviços deste grupo, verificou-se que:
52% dos respondentes classificaram genericamente como bom o atendimento
oferecido pelo grupo, demonstrando satisfação em relação ao trabalho desenvolvido.
36% consideraram os prazos de atendimento demorados, demonstrando
descontentamento em relação ao comprometimento com prazos contratados com o
grupo para a execução dos serviços. Dentre estes 13% destacaram a boa qualidade,
15% destacam o bom atendimento e 2% observaram que em alguns casos o trabalho
apresentado não estava de acordo com a necessidade do cliente;
2% consideraram o trabalho como muito burocrático e pouco criativo;
2% discordam da forma de trabalho do grupo;
7% não responderam.
f) Avaliação da Opinião sobre a Utilização da Documentação pelo Cliente
TABELA 05 – RESPOSTAS DA QUESTÃO 20 - COMO VÊ A UTILIZAÇÃO DA DOCUMENTAÇÃO PELO CLIENTE? (HELP, MANUAL DO USUÁRIO, CARTELAS, ETC.)
RESPOSTAS OBTIDAS
Satisfatoriamente.
Infelizmente, ainda muitos usuários não o utilizam. Mas acredito ser pela cultura / costume dos usuários.
Agrega qualidade ao projeto.
Usa pouco.
Boa e útil.
De vez em quando, eles consultam.
Não recebem motivação para consultar documentação. Acabam perguntando para o analista, CAC ou para colegas mais antigos no próprio ambiente de trabalho.
Nula. Com exceção das cartelas, o usuário não utiliza a documentação do sistema por melhor que ela seja.
É pouco utilizado, geralmente o usuário recorre a alguém envolvido no projeto.
Help On-line é pouco utilizado. Já o Manual do Usuário é bastante utilizado.
continua
56
TABELA 05 – RESPOSTAS DA QUESTÃO 20 - COMO VÊ A UTILIZAÇÃO DA DOCUMENTAÇÃO PELO CLIENTE? (HELP, MANUAL DO USUÁRIO, CARTELAS, ETC.)
continuação
RESPOSTAS OBTIDAS
Nas aplicações como Notes e Web a documentação Help e Cartelas são bem utilizada, já nas aplicações que utiliza Manual do usuário acho que não é muita utilizada, fica mais facil o usuario procurar o responsavel pelo sistema.
Mínima. O mais importante são help´s on-line. Documentação em manuais, em comparação com as novas tecnologias disponíveis, já não servem para quase nada e são de difícil manutenção e, principalmente, distribuição aos usuários.
Não se aplica ao meu caso.
O meu usuário não possui Manual, somente help on-line (quando necessário).
Usuário só se interessa e usa Help, quando tem algum problema mais grave. Quando não, prefere perguntar ao analista responsável.
Essencial para a correta operação do sistema.
Pouco empregada.
Referência de aprendizado.
Somente para treinamento. As pessoas se acostumam a operar o sistema e não mais utilizam a documentação.
A documentação voltada ao cliente é fundamental para que ele entenda o sistema e como utilizá-lo. Isto também ajuda a diminuir a demanda do cliente com relação ao analista responsável pelo sistema. Ou seja, em caso de dúvidas, o cliente tem onde procurar sem ser o próprio analista.
Com o crescimento do uso de sistemas via Internet, a necessidade de documentação escrita está em decadência. O usuário pode estar distante, em qualquer lugar, e ao invés de fazermos documentação para nossos clientes, precisamos orientar diretamente os clientes dos nossos clientes.
É importante, pois sempre bastante utilizada.
Muito necessária. A documentação deve sofrer muitas mudanças, principalmente pelo surgimento da Internet e de ferramentas de treinamento a distância.
O cliente não costuma usar a documentação adequadamente (prefere perguntar).
Ela é muito importante no início da utilização do sistema e também para novos usuários. Com o tempo ela acaba sendo pouco utilizada pela cultura adquirida pelo usuário.
Ainda não existe a cultura dos clientes recorrerem a documentação para sanar suas dúvidas. É mais fácil e prático ligar para o responsável e perguntar diretamente como se resolve um problema.
Os clientes preferem os manuais mais simplificado.
continua
57
TABELA 05 – RESPOSTAS DA QUESTÃO 20 - COMO VÊ A UTILIZAÇÃO DA DOCUMENTAÇÃO PELO CLIENTE? (HELP, MANUAL DO USUÁRIO, CARTELAS, ETC.)
continuação
RESPOSTAS OBTIDAS
Acredito que é um recurso muito útil para facilitar o entendimento da aplicação pelo cliente, porém acredito que o cliente não tem o hábito de utilziar estes documentos, sendo sempre mais fácil acionar o analista para tirar dúvidas.
Pouco uso. Prefere perguntar em vez de consultar.
Considero importante.
O cliente usa o help on-line e cartela.
Indispensável para os usuários neófitos e eventuais.
Eles praticamente ignoram.
Alguns usuários não utilizam pq conhecem bem o sistema, mas o manual é sempre um material auxiliar para novos usuários.
Normalmente, o cliente acessa o analista primeiro e depois a documentação impressa.
O uso desta documentação é imprescindível.
Muito utilizados.
A utilização da documentação varia conforme o nível dos clientes. Existem usuários que preferem entrar em contato direto com os analistas responsáveis por sistemas ao invés de pesquisar na documentação.
Alguns clientes tem resistência para consultar.
Eficiente, desde que ele possa atualizar conforme as suas necessidades.
Importante.
Os usuários de mainframe utilizam mais o manual 'Telefone' que qualquer outro tipo de documentação.
O cliente ainda não tem o costume de utilizar estas facilidades, mas acredito que o tempo fará com que ele as use.
O cliente, geralmente, não os utiliza.
Vejo que o Cliente ainda não tem o habito de usar a documentação e, muitas vezes, quando usa tem dificuldades de encontrar o que está procurando.
Só é bem utilizada pelo cliente quando é feito um treinamento pelo Analista.
O cliente não tem o hábito de ler o manual do usuário e acaba sempre ligando para o analista responsável.
O cliente utiliza muito a documentação.
continua
58
TABELA 05 – RESPOSTAS DA QUESTÃO 20 - COMO VÊ A UTILIZAÇÃO DA DOCUMENTAÇÃO PELO CLIENTE? (HELP, MANUAL DO USUÁRIO, CARTELAS, ETC.)
continuação
RESPOSTAS OBTIDAS
A documentação é muito utilizada pelo cliente.
O cliente utiliza a documentação. Tb geramos documentação (cartelas) aqui na equipe.
Analisando as informações referentes a opinião sobre a utilização da
documentação pelo cliente , entre os 52 analistas que responderam ao questionário,
verificou-se que:
35% consideraram que os clientes utilizam a documentação que lhe é
entregue;
40% consideraram existir pouca utilização da documentação por parte do
cliente e apontam como causas a falta de hábito, falta de motivação para consultar a
documentação, preferência do cliente pela pergunta diretamente para o analista, que o
cliente não encontra o que procura na documentação, que o cliente só utiliza durante o
treinamento para a operação do sistema;
7% afirmaram que a documentação agrega maior qualidade ao sistema, é
uma referência de aprendizado e é essencial para a correta utilização do sistema;
11% afirmaram que apenas as formas mais simplificadas como Help on-line
e cartelas são utilizadas;
2% afirmou gerar documentação em sua própria equipe, não utilizando o
processo oficialmente adotado pela empresa;
2% revelou considerar desnecessária a documentação escrita disponibilizada
para cliente de sistemas desenvolvidos em plataformas internet;
3% não responderam.
59
g) Avaliação da Opinião sobre as Dificuldades Encontradas para Documentar
TABELA 06 – RESPOSTAS DA QUESTÃO 21 - QUAIS AS DIFICULDADES QUE VOCÊ COSTUMA ENCONTRAR NO MOMENTO DE DOCUMENTAR UM SISTEMA?
RESPOSTAS OBTIDAS
Falta de tempo.
Tempo.
Explicar situações que são condicionadas a mais de uma alternativa.
A maior dificuldade é o prazo, pois costumeiramente é deixado como a ultima coisa a fazer num projeto, daí o acúmulo de documentação é enorme.
Nenhum.
Não ter os recursos de documentação disponíveis no momento. burocracia para contratação.
Não é um processo normal nem padronizado apesar de toda a MDS. Há pontos, como o Projeto lógico e o físico em que sempre tenho dificuldades. Acabo utilizando como acredito ser correto, podendo estar deixando pontos de lado.
Falta de padrões bem definidos, e a colaboração da equipe para atualização dos documentos.
As Atividades do dia-a-dia atropelam o tempo que poderiam ser gasto para a documentação dos sistemas.
Diria que é o tempo, a parte de elaboração de Manuel ou Cartela existe a preocupação de não deixar texto muito tecnico.
Poucas.
Não tenho tido dificuldade em documentar o manual de produção. Em relação a outros tipos de documentação, acho que o tempo e o custo que se leva para a sua elaboração e manutenção faz com que as empresas se preocupem mais em manter uma baixa rotatividade do pessoal técnico do que atacar a documentação dos sistemas.
Como proceder e o conteúdo da documentação.
Burocracia.
Difícil de achar o que se deseja.
Face ao pouco uso, não percebi dificuldades.
Decidir até que nível de detalhe vale a pena documentar, já que, em alguns sistemas, há um leque muito variado de perfil intelectual de usuário utilizando o sistema.
Falta de conhecimento das nomenclaturas que a empresa utiliza, ou padrões.
Estruturar o documento e escrever o conteúdo.
É um processo trabalhoso e detalhista, portanto demanda tempo.
continua
60
TABELA 06 – RESPOSTAS DA QUESTÃO 21 - QUAIS AS DIFICULDADES QUE VOCÊ COSTUMA ENCONTRAR NO MOMENTO DE DOCUMENTAR UM SISTEMA?
continuação
RESPOSTAS OBTIDAS
O repasse de informações ao técnico documentador.
Geralmente a dificuldade em montar os documentos do projeto - consomem tempo pois tem que ser produzidos do nada. A documentação deve ser montada a partir dos documentos gerados durante o projeto e o desenvolvimento do produto. Há a necessidade de uma mudança da nossa postura.
O prazo. Nem sempre consideramos este item no cronograma.
Como deixar claro para o entendimento do cliente.
Escrever de forma não tão técnica.
Escrever numa linguagem (vocabulário) que o usuário entenda.
A desatualização da metodologia da CELEPAR - MDS, no momento de utilizar nem sermpre o que está se adapta às novas tecnologias.
Só supervisiono
Todas as dificuldades. Falta de uma ferramenta adequada, falta de metodologia, tempo x prioridades, mudanças de escopo constantes.
Não tenho muito tempo para essa atividade.
Tempo, pois geralmente os prazos são bem curtos.
A disponibilidade de tempo para dedicação mais efetiva nesta tarefa.
Tempo.
Explicar o óbvio. Aquilo que é lógico, fica dificil escrever.
Disciplina e Tempo.
Formatação do texto, as vezes se gasta tempo com um desenho mais complexo, há coisas do ER_WIN que não é possível incorporar no doc. word, as vezes me bato com a configuração do word.
Saber quais são as informações relevantes que podem ser de interesse dos futuros usuários. Não adianta muito documentar o óbvio, pois acrescenta pouco valor ao produto.
Na momento de detalhar procedimentos que utilizam novas tecnologias e exista o envolvimento de setores de produção da Celepar.
Deixar de ter a visão técnica do sistema e ver sob a óptica do usuário.
Falta algumas ferramentas para o desenvolvimento de certas partes do sistema.
Nenhuma.
Tempo para gerenciar as mudanças.
61
Analisando as informações referentes às dificuldades encontradas pelos
analistas no momento de documentar, entre as 52 pessoas que responderam ao
questionário apresentado, verificou-se que:
8% afirmaram não encontrar dificuldades no momento de elaborar a
documentação;
2% afirmaram só elaborar documentação de produção e que nesta não
encontram dificuldades;
29% alegaram falta de tempo para executar este serviço e entre estes existe
algumas afirmações de que existe também a falta de disciplina para programar a
execução deste trabalho;
6% consideram que a burocracia no momento de contratar um serviço com o
grupo de documentação e a demanda de serviços atendida pelo grupo são fatores que
dificultam o trabalho de documentar;
4% consideraram que não existe uma padronização bem definida;
6 % afirmaram não conhecer os processos para documentar;
13% afirmaram ter dificuldades em escrever de forma que o cliente entenda;
4% afirmaram ter pouco conhecimento das tarefas desenvolvidas pelos
setores da produção, o que torna difícil saber que informações devem ser repassadas
para estes setores;
4% afirmaram que a dificuldade está em definir até que nível de detalhe deve
documentar e quais as informações que são relevantes e que podem ser de interesse do
usuário da documentação;
6% afirmaram encontrar problemas com as ferramentas utilizadas para
documentar, alegando falta destas ou que são incompatíveis entre si;
2% afirmaram ter dificuldades em repassar as informações necessárias para
que o grupo de documentação possa elaborar o trabalho;
2% afirmaram que a Metodologia de Desenvolvimento de Serviços não se
adapta às necessidades das novas tecnologias;
11% não responderam;
3% apresentaram respostas dúbias ou que fogem ao escopo da pergunta
elaborada.
62
h) Avaliação das Dificuldades Encontradas para Atualizar a Documentação
TABELA 07 – RESPOSTAS DA QUESTÃO 22 - QUAIS AS DIFICULDADES QUE VOCÊ COSTUMA ENCONTRAR PARA ATUALIZAR A DOCUMENTAÇÃO?
RESPOSTAS OBTIDAS
Falta de tempo.
Mais por falta de disciplina e um pouco por falta de tempo.
Tempo.
Manter a numeração de páginas original.
Acho que a lteração é mais tranquilo para fazer, pois não requer muito tempo e aproveita-se do que já existe.
Nenhum.
A rapidez da atualização do sistema não é acompanhada pela elaboração da nova versão da documentação. sistema distribuído com processamento online, não pode ter um manual e uma cartela apenas, deveria estar disponível para o cliente online.
Tempo. Este sempre falta. Com o envolvimento em outras etapas e mesmo outros projetos, dificilmente encontra-se tempo para retornar e atualizar a documentação.
Ferramentas que possam automatizar parte da tarefa.
Normalmente a documentação fica desatualizada pois o sistema já tá implantado e as atualizações já foram executadas e a demanda de serviço é constante.
Como voce conhece o negocio, precisaria de tempo para repassar para outras pessoas.
Maiores que as existentes no processo de documentação original.
Somente o tempo entre a elaboração da alteração e a sua implantação em produção.
Ignorância dos procedimentos e onde e como encontrar o documento a ser atualizado.
Difícil de achar o que se deseja.
Deve ser perseguida a redação correta e sintética, de maneira a não deixar dúvidas por parte de quem interpretará a documentação.
Não percebo grandes dificuldades.
Tempo.
Falta de tempo para documentar as alterações.
As correções/alterações na maioria das vezes são implementadas e somente depois isso é refletido na documentação.
A dificuldade é a mesma da geração da documentação - falta-nos método de trabalho na geração dos documentos.
continua
63
TABELA 07 – RESPOSTAS DA QUESTÃO 22 - QUAIS AS DIFICULDADES QUE VOCÊ COSTUMA ENCONTRAR PARA ATUALIZAR A DOCUMENTAÇÃO?
continuação
RESPOSTAS OBTIDAS
Falta de tempo.
A dificuldade é a mesma da geração da documentação - falta-nos método de trabalho na geração dos documentos.
Falta de tempo.
Nenhuma.
Tempo em função das prioridades e do acumulo de serviço.
Tempo.
A falta de hábito de voltar em documentos que já estão fechados e incluir a atualização no momento que o fato aconteceu, porque depois nem sempre você lembra de atualizar ou se lembra atualiza às vezes com informações parciais, porque muitos detalhes já foram esquecidos.
Todas as dificuldades. Falta de uma ferramenta adequada, falta de metodologia, tempo x prioridades, mudanças de escopo constantes.
Ter a disciplina para implementar imediatamente na documentação o que foi alterado no sistema.
Deixa-se para depois e se esquece até aparecer um usuário crica para nos cobrar.
Nenhuma.
Tempo.
Nenhuma.
Quando o grupo de documentação solicita para que eu faça a atualização e seguindo regras que o grupo cionece bem mas eu conheço quase nada pelo fato de atualizar sazonalmente os manuais dos sistemas sob minha responsabilidade.
Falta de uma política para atualização da documentação. Em geral as atualizações da documentação não acompanham as atualizações das rotinas ou programas.
Tempo.
A disponibilidade de tempo para dedicação mais efetiva nesta tarefa.
Tempo.
Tempo e lembrança da tarefa.
Disciplina e Tempo
Falta de tempo.
continua
64
TABELA 07 – RESPOSTAS DA QUESTÃO 22 - QUAIS AS DIFICULDADES QUE VOCÊ COSTUMA ENCONTRAR PARA ATUALIZAR A DOCUMENTAÇÃO?
continuação
RESPOSTAS OBTIDAS
A mesma citada no item 21, acrescida da dificuldade cultural de manter uma documentação atualizada.
Nenhuma.
Até o momento não encontro dificuldades em atualizar os documentos. Depois que houve a migração da documentação para o notes, a janela de ajuda tem contribuído muito para realização do trabalho.
Tempo.
Nenhuma.
Tempo.
Analisando as informações referentes às dificuldades encontradas pelos
analistas no momento de atualizar a documentação, entre as 52 pessoas que
responderam ao questionário apresentado, verificou-se que:
19% afirmaram não encontrar dificuldades, havendo indicação do uso da
documentação de ajuda, disponível na base de documentação;
39% alegaram falta de tempo e entre estes, houve afirmação de falta de
disciplina;
4% alegaram faltar ferramentas que automatizem o processo;
2% afirmaram que geralmente não atualizam as documentações;
2% afirmaram ter dificuldades em repassar informações;
2% afirmaram ter dificuldade cultural de manter documentações atualizadas
e dificuldades em classificar quais as informações são relevantes para o cliente;
12% das respostas sugeriram mudanças que já fazem parte da realidade atual
do processo, ou afirmaram não entender os procedimentos necessários para alterar a
documentação, demonstrando desconhecimento do processo oferecido pela CELEPAR
para atualização das documentações produzidas;
6% apresentaram respostas dúbias ou que fogem ao escopo da pergunta.
12% não responderam.
65
h) Sugestões para a Melhoria do Processo de Documentação Atualmente Utilizado
TABELA 08 – RESPOSTAS DA QUESTÃO 23 - NA SUA VISÃO, O QUE PODERIA SER FEITO PARA A MELHORAR O PROCESSO ATUALMENTE UTILIZADO NA CELEPAR PARA DOCUMENTAÇÃO DE SISTEMAS?
RESPOSTAS OBTIDAS
Prever este tempo oficialmente na fase de projeto, com respaldo de consumo de recursos.
Divulgação do trabalho de documentação.
Algumas etapas e tarefas de documentação poderia ser delegado aos analistas, quando assim for definido entre o setor de documentação e os analistas, estabelecendo formas, condições de execução destas tarefas, isto tornaria mais ágil a atualização da documentação. Por ex. manual de operação (produção), alteração de algumas partes do manual de usuário. Analisar possibilidade de participação das secretárias das equipes na elaboração da documentação.
Lembrando que, cabe sempre ao técnico de documentação a definição maior do processo de documentação.
Como normalmente é feita uma cópia das páginas que voce quer alterar ou incluir uma nova página, talvez era ideal que quando mandássemos para a documentação, já fosse alterada as páginas, sem ter que o pessoal da documentação entrar no documento e reeditar as páginas.
pesquisar junto aos usuários nos clientes, não nos responsáveis pelos sistemas, quais suas necessidades.
Esclarecimento quanto aos produtos e trabalho efetuados pelo grupo de documentação e talvez uma melhoria na comunicação entre analistas e os técnicos deste grupo.
Ainda não tenho conhecimento suficiente sobre o processo utilizado.
Em cada equipe deveria haver 1 pessoa responsável em checar a documentação, solicitar produtos referentes a documentação e controlar quais as documentações que cada projeto possui.
Para os projetos grandes deveria ter acompanhamento do documentador num ponto do projeto.
Disponibilizar tudo pela WEB.
O analista deveria por em produção o manual e após esta etapa o grupo de documentação deveria verificar se está OK ou não a documentação.
Divulgar e orientar de uma forma clara e sucinta os procedimentos para se fazer a documentação de cada produto quando for solicitado pelo analista.
Adotar nova metodologia.
Incentivar maior contato e integração com o pessoal gerador dos sistemas para desenvolver a documentação no momento em que é gerada cada ferramenta do sistema.
Por ora, o processo me parece suficientemente eficiente
Coordenar esforços de manter gerência de configuração em ambiente único.
continua
66
TABELA 08 – RESPOSTAS DA QUESTÃO 23 - NA SUA VISÃO, O QUE PODERIA SER FEITO PARA A MELHORAR O PROCESSO ATUALMENTE UTILIZADO NA CELEPAR PARA DOCUMENTAÇÃO DE SISTEMAS?
continuação
RESPOSTAS OBTIDAS
Para mim esta faltando conhecimento do que a Celepar já tem padronizado, e entender a padronização.
Maior participação da equipe de documentação durante o desenvolvimento do projeto e não somente quando é necessário elaborar a documentação. Reciclagem constante dos analistas visando a adoção da metodologia de desenvolvimento de sistemas. Cobrança junto aos analistas (não só dos chefes) quando a mudança de postura na adoção de metodologias. Implantação de ferramentas mais ágeis para geração e manutenção dos documentos. Prospecção e implementação de processos e ferramentas mais modernas no treinamento de usuários de sistemas. O setor de Documentação deveria evoluir para um Centro de Geração de Treinamentos a Distância. Agilidade no processo.
Ter disponível um especialista em documentação alocado ao desenvolvimento do projeto.
Usar ferramenta Case, automatizar mais a documentação, melhorar documentação (Help) de aplicativos na Internet.
Atualização da metodologia - MDS, melhor divulgação da forma de trabalho e atividades do grupo de documentação de sistemas, exigência da geração da documentação em cada fase do projeto.
Aqui, há que se destacar os tipos de documentação. Por exemplo, no caso do Manual de Produção, o processo de registro deveria ser mais dinâmico. O analista especifica, encaminha para o setor de produção e PRONTO. O que faz a documentação ? Apenas reescreve o já escrito pelo analista.
Cartela - acho legal como se faz atualmente.
Demais tipos de documentos - nunca os solicitei do setor, portanto não poderia falar.
Primeiramente, acho que a documentação de sistemas poderia ser gerada automaticamente por um software. Mas, a documentação do cliente acho difícil não ser feito por pessoas especializadas. O problema é que temos que repassar muitas informações para os documentadores, pelo menos na época em que fazia documentação o que inviabiliza e até gera um trabalho muito grande para o analista. Acho que envolver o documentador desde o iníco do projeto ajuda, mas sai muito caro. De qualquer forma, facilitaria a contratação e os trabalhos.
Gostaria poder acessar diretamente na base notes o histórico das alterações implementadas num manual.
As vezes recebo memo da Preparação confirmando alterações que não foram efetivadas. Não sei como se dá esse procedimento de alterar Manual, nem como seria possível confirmar que tivesse sido feito.
continua
67
TABELA 08 – RESPOSTAS DA QUESTÃO 23 - NA SUA VISÃO, O QUE PODERIA SER FEITO PARA A MELHORAR O PROCESSO ATUALMENTE UTILIZADO NA CELEPAR PARA DOCUMENTAÇÃO DE SISTEMAS?
continuação
RESPOSTAS OBTIDAS
Não sei.
Conscientizar os analistas da impostância para o cliente e para a empresa de se manter a documentação atualizada.
Poderia haver um processo de avaliação da dita "qualidade em uso" da documentação, ou seja, poderia haver algum mecanismo de avaliação da documentação e do seu uso efetivo pelos usuários finais, nos diversos níveis, para a partir desta avaliação identificar pontos que poderiam ser melhorados. Neste sentido, por exemplo, toda a documentação deveria/poderia ter uma forma simples de feedback por parte dos usuários, onde eles poderiam registrar se encontraram ou não o que estavam procurando, se foi fácil, se faltou alguma coisa, etc.
Estabelecer padrões para documentação de novas tecnologias.
Por enquanto estou satisfeito com os procedimentos de documentação de sistemas da Celepar.
Adquirir alguma ferramenta que ajude no desenvolvimento do sistema.
Deveria ser mais usado pelos técnicos, quanto a melhorias não tenho nada a solicitar.
Analisando as informações referentes a sugestões para a melhoria do
processo de documentação atualmente utilizado na CELEPAR para documentação de
sistemas, entre os 52 analistas que responderam ao questionário apresentado,
verificou-se que:
2% sugeriram que o tempo gasto na documentação deve ser previsto
oficilmente no projeto com respaldo de recursos;
3% sugeriram a participação das secretárias das equipes na elaboração e
atualização das documentações, ou eleger um responsável em cada equipe para fazer o
controle das documentações a serem elaboradas;
7 % sugeriram mudanças nos procedimentos para documentação do manual
da produção, indicando que as atualizações devem ficar a cargo do analista não
havendo envolvimento do grupo de documentação, ou que este apenas deve realizar
revisão final;
3% sugeriram que haja uma pesquisa entre os usuários da documentação
para avaliar as necessidades ou ainda que haja um mecanismo de avaliação para
68
verificar seu uso efetivo pelo usuário final, para que a partir desta avaliação se possa
identificar pontos que poderiam ser melhorados;
5% sugeriram que haja melhoria na comunicação entre o grupo de
documentação e os analistas e que sejam esclarecidos quais são os produtos elaborados
por este grupo, qual sua forma de atuação e esclarecimentos sobre padronização;
2% revelam não ter conhecimento suficiente do processo atualmente
utilizado para poder fazer sugestões;
11% sugeriram o incentivo aos analistas para que as documentações sejam
geradas em cada fase do projeto e que os documentadores devem estar envolvidos
desde o início, buscando maior integração entre o grupo de documentação e os
analistas;
2% sugeriram que haja gerência de configuração de ambiente único;
2% sugeriram reciclagem constante dos analistas visando a adoção de
Metodologia de Desenvolvimento de Sistemas e a evolução do grupo de
documentação para um Centro de Geração de Treinamento à Distância;
3% sugeriram a cobrança junto aos analistas sobre mudança de postura na
adoção de metodologias e conscientização da importância de manter documentação
atualizada;
9% sugeriram a adoção de ferramentas mais ágeis para geração e
manutenção dos documentos;
3% sugeriram que Metodologia de Desenvolvimento de Serviços –MDS
deve ser melhorada ou substituída;
6% sugeriram mudanças que já fazem parte da realidade atual, demonstrando
desconhecimento do processo oferecido pela CELEPAR para a tualização e elaboração
das documentações produzidas;
3% sugeriram que haja agilidade no processo, não indicando solução;
9% Não indicaram sugestões, declarando-se satisfeitos com o processo;
30% não responderam.
CAPÍTULO 6
CONCLUSÃO
70
6 CONCLUSÃO
Após as verificações apresentadas, conclui-se que a CELEPAR possui um
processo de documentação semelhante ao das empresas visitadas no que se refere ao
uso de metodologia para desenvolvimento de sistemas e uso de padrões pré-elaborados
que objetivam compor a documentação de forma completa e confiável. Destaca-se das
demais empresas por possuir grupo técnico atuando especificamente na elaboração de
manuais, controle dos documentos, elaboração de padrões, sugestão de inovações
técnicas que produzam melhoria na forma do trabalho e suporte aos analistas para
produzir, alterar e armazenar manuais.
Quanto à qualidade de seus projetos, a CELEPAR procura freqüentemente
aperfeiçoar meios de avaliação de produtos, objetivando fornecer serviços que
satisfaçam as necessidades dos seus clientes.
No armazenamento e trâmite das informações, a CELEPAR utiliza
ferramentas que produzem efeitos similares ao da empresas visitadas, formando bases
de dados em local único que possibilitam consultas, através do acesso rápido aos
documentos produzidos. Neste ponto, há que se destacar a necessidade da unificação
do local de armazenamento dos modelos utilizados para a elaboração dos projetos que
atualmente não são encontrados na base específica para fins de documentação de
sistemas.
A avaliação apresentada pelos técnicos da CELEPAR, através do
questionário enviado, demonstrou que o processo de documentação de sistemas é
conhecido e que existe consciência da importância da atividade de documentar os
sistemas. Porém observou-se que considerável número de técnicos iniciam a
documentação determinada pela metodologia, mas não complementam todas as fases,
bem como não armazenam toda a documentação produzida na base destinada para este
fim.
No que se refere ao atendimento oferecido pelo grupo de documentação,
observou-se que existe conhecimento e aceitação do trabalho desenvolvido pelos
integrantes, mas que existem pontos a serem melhorados, principalmente quanto aos
71
prazos de atendimento.
Verificou-se também que algumas das sugestões apresentadas pelos técnicos
da CELEPAR ao responder o questionário aplicado, são passíveis de ser
implementadas a curto prazo e que estas poderão contribuir para a melhoria do
processo atualmente utilizado pela CELEPAR.
Confrontando o resultado com as hipóteses inicialmente apresentadas, pode-
se concluir que a afirmação de que não existe preocupação por parte das empresas com
um meio de armazenamento único da documentação, para acesso de todos os usuários
envolvidos com o sistema, não é verdadeira. A pesquisa de campo efetuada
demonstrou que todas as empresas visitadas, incluindo a CELEPAR, possuem
mecanismos que visam coletar, resguardar informações que produzem documentos e
procuram aprimorar seus processos. Isto está ainda mais evidente no relato da empresa
denominada como ‘B’, que apesar de ter processos bastante falhos, está consciente da
necessidade de melhorá-los e pretende adquirir uma ferramenta que visa unificar o
modo de desenvolvimento e meio de armazenamento em todos os seus pontos de
atendimento.
O foco dos desenvolvedores de sistemas não é a documentação, mas sim o
resultado dos seus projetos. Esta afirmativa é vista como verdadeira, observando-se o
alto percentual de respostas dos técnicos, afirmando falta de tempo para elaborar e
atualizar as documentações dos sistemas e afirmando também que o cliente geralmente
não utiliza a documentação que lhe é entregue.
Quanto à idéia inicial de que os técnicos da CELEPAR estão descontentes
com o processo de documentação atualmente utilizado pela empresa, considera-se
afirmativa falsa, face a pesquisa apontar que considerável número de técncios está
satisfeito com o atendimento oferecido pelo grupo de documentadores de sistemas,
bem como com os produtos elaborados pelo grupo. A pesquisa demonstrou também
que os técnicos conhecem a base de dados destinada ao armazenamento dos
documentos e que as dificuldades apontadas para elaborar e alterar as documentações,
na maioria dos casos não apresentam vínculo com o processo adotado pela empresa.
Outro ponto a ser considerado nesta análise foi o representativo percentual de técnicos
que não ofereceram sugestões com o objetivo de propor melhorias.
72
Os técnicos da CELEPAR têm sugestões que podem contribuir para a
melhoria do processo de documentação atualmente utilizado pela empresa. Considera-
se esta afirmativa verdadeira, visto que foram apresentadas algumas propostas viáveis
e passíveis de ser implantadas a curto prazo.
Desconhecimento por parte dos desenvolvedores, do processo de
documentação utilizado pela CELEPAR. Considera-se esta afirmativa falsa, em função
do considerável número de técnicos que afirmaram conhecer e utilizar a metodologia
adotada pela empresa, conhecer a base de dados destinada a armazenar e tramitar
informações referentes a documentação, atualizar documentações, conhecer os
produtos elaborados pelo grupo de documentação e que já solicitaram serviços ao
grupo.
Quanto à afirmativa de que a baixa rotatividade do pessoal de
desenvolvimento, faz com que o conhecimento da organização fique atrelado ao
conhecimento de pessoas, pode-se apenas constatar que a baixa rotatividade é
confirmada pelo grande percentual de técnicos que trabalham na empresa há mais de
10 anos. Porém, não existem dados para afirmar que estas pessoas retêm conhecimento
propositadamente, não os registrando de forma que outras pessoas da empresa tenham
acesso.
Dos pontos de vista literário e prático, esta pesquisa, contribuiu para
enriquecimento profissional, respaldando a importância de documentar sistemas.
Verifica-se isto principalmente quando se expõe razões que evidenciam que, manter o
histórico dos projetos desenvolvidos e documentação atualizada, proporcionam às
empresas uma maneira de assegurar que o conhecimento auferido pelos técnicos
durante a execução de seus projetos seja repassado aos demais, objetivando auxiliar,
informar e agilizar os processos. A cooperação dos técnicos pode constituir-se em uma
das formas de contribuição para que a empresa seja mais produtiva, competitiva e
ofereça serviços com melhor qualidade.
Quanto à aplicação dos efeitos produzidos em função da realização deste
trabalho, verificou-se que durante a sua confecção já foram efetuadas algumas
mudanças que contribuíram para melhorar o processo atualmente utilizado e que
outras contribuições poderão vir a ser implementadas.
73
Finalmente conclui-se que a participação das empresas visitadas, bem como
a contribuição dada pelos técncicos da CELEPAR, através do questionário teve um
aspecto positivo no sentido de verificar que, apesar das dificuldades em se fazer o
registro da documentação de um sistema desde o início da sua confecção, o
acompanhamento de toda sua vida útil, e de praticamente não haver literatura
científica específica que aborde o tema ´Documentação de Sistemas´, constata-se que o
assunto tem importância relevante tanto no âmbito das empresas, quanto para os
técnicos que atuam construindo sistemas de apoio à informação e que esta
complementação de serviços permite que as organizações possam desempenhar suas
atividades de forma mais eficaz e produtiva. Os meios utilizados para que estas
documentações sejam registradas é que precisam constantemente ser reavalidados e
adaptados visto estarem inseridos num ambiente totalmente mutável como o da
tecnologia da informação. Isto faz com que não se possa esperar que os meios hoje
utilizados sejam compatíveis com a tecnologia disponível daqui a certo período de
tempo. Desta forma como recomendação final, fica também a sugestão de que haja
uma contínua reavaliação do processo e dos meios de armazenamento e a adequação
necessária à tecnologia vigente.
ANEXOS
74
ANEXO I - CONTEÚDO DO RDOC (ROTEIRO DE DOCUMENTAÇÃO)
1
1 INTRODUÇÃO
O RDOC - Roteiro de Documentação, utilizado juntamente com os demais da Metodologia de Desenvolvimento de Serviços, é responsável por definir de que forma a documentação, gerada nas fases de desenvolvimento de serviços, deve ser armazenada.
Ao se ter uma documentação naturalmente gerada a cada passo e determinando-se padrões de arquivamento, minimizam-se os problemas decorrentes de ausência e rotatividade de pessoal, pois a empresa passa a operar dentro de um conjunto de procedimentos idênticos. As informações assim armazenadas constituem-se em fonte de consulta, permitindo que a experiência de alguns seja repassada para todos e, desta maneira, evitando redundância de esforços.
2 ESTRUTURA DA DOCUMENTAÇÃO
A documentação está dividida nas seguintes pastas:
Documentário
Manual de Arquitetura do Sistema
Manual do Usuário e Manual da Produção
RDOC - Roteiro de Documentação
•• Documentos• Material de Apresentação• Plano de Evolução• Avaliação do Sistema• Projeto de Informática• Projeto Preliminar
Levantamento de Dados• Projeto Lógico• Projeto Físico•• Teste• Implantação
Solicitação do Serviço Manual do Usuário
Construção
Manual de Produção•
DOCUMENTÁRIO
MANUAL DEARQUITETURADO SISTEMA MANUAL DO USUÁRIO MANUAL DA PRODUÇÃ
2
3 PROCESSO DE DOCUMENTAÇÃO
O processo de documentação é apoiado por um aplicativo Notes – Documentação de Sistemas, que disponibiliza:
Solicitação de documentação (manuais).
Solicitação de pastas.
Consulta aos manuais existentes - por todos os usuários envolvidos pelo sistema (cliente, analista, setores da Produção), podendo ser através da sigla do sistema ou cliente.
Consulta às solicitações por: sistema, situação, solicitante ou documentador responsável pela elaboração.
Consulta às pastas de sistemas por: palavra-chave, sigla do sistema ou documentador responsável pela elaboração.
Modelos de documentação de manuais (elaborados em WORD), visando a padronização dos manuais elaborados pela CELEPAR.
Ao acessar o aplicativo é apresentada a tela que possibilita as seguintes visões:
3
4 DESCRIÇÃO DA DOCUMENTAÇÃO
4.1 DOCUMENTÁRIO
Deve ser solicitado pelo Líder do Projeto ao Grupo de Documentação – DITEC-F, através do formulário Solicitação de Pastas disponível na Base Notes – Documentação de Sistemas, tão logo o projeto se inicie e deve ser devolvido ao Grupo de Documentação – DITEC-F para arquivamento assim que o projeto seja concluído. A responsabilidade por sua confecção é do Líder do Projeto.
Para soluções construídas utilizando-se o Lotus Notes, somente esta pasta servirá para resguardar todos os produtos gerados durante o ciclo de desenvolvimento.
Anexar no Documentário:
Documento Origem
Sol ic i tação de Serviço da demanda.
RPRE/Fase de Ident i f icação do Problema.
Modelos de documentos referentes ao ambiente do problema: Legis lação, Organograma, Regimento Interno, Programa de Governo, e tc .
RPRE/Fase de Ident i f icação do Problema; RAES/Fase de Levantamento de Dados.
mater ia l de apoio para apresentação do proje to aos usuár ios ( t ransparências , d isquetes , e tc . ) .
Qualquer fase onde seja necessár ia apresentação.
Projeto Prel iminar . RPRE;
RNOT/Fase de Especif icação de Requis i tos .
Plano Setor ia l de Informát ica . ROTRPLAN.
Especif icação de Requis i tos GREQ;
RNOT/Fase de Especif icação de Requis i tos ;
RNET/Fase de Especif icação de Requis i tos .
Plano de Evolução referente ao serviço entregue.
RAES/Fase de Implantação.
Aval iação do Sis tema. RAES/Fase de Implantação.
Proje to do Aplicat ivo Notes RNOT/Fase de Proje to .
Especif icação da Aval iação do Aplicat ivo
RAPS/ Fase de Especif icação da Aval iação.
Plano de Aval iação do RAPS/Fase de Proje to da Aval iação.
♦
♦
♦
♦
♦
♦
♦
♦
♦
♦
♦
4
Aplicat ivo.
Manual do usuár io e Car te la do Aplicat ivo
RNOT/Fase de Construção ♦
4.2 MANUAL DE ARQUITETURA DO SISTEMA
Deve ser solicitado pelo Líder do Projeto ao Grupo de Documentação – DITEC-F, através do formulário Solicitação de Pastas disponível na Base Notes – Documentação de Sistemas, com a especificação do roteiro que será utilizado para este desenvolvimento. Sua devolução deve ser efetuada quando o projeto for concluído. Tem por objetivo ser uma fonte de referência técnica, contendo os modelos do sistema. A responsabilidade por sua confecção é do Líder do Projeto.
RAES - ROTEIRO DE ANÁLISE ESTRUTURADA
FASE LEVANTAMENTO DE DADOS
Modelo de Dados prel iminar do s is tema.
Lis ta de Atr ibutos .
Diagrama de Contexto do s is tema.
Lis ta dos Eventos que in terferem no s is tema.
Produto Alternat ivas de Implementação.
FASE PROJETO LÓGICO
Modelo de Dados do s is tema, normalizado a té a 3a . forma normal .
Lis ta de Atr ibutos e Atr ibutos-chave.
Modelo de Processos do s is tema.
Dicionár io de Dados descrevendo:
Descr ição de Processos
Descr ição de Fluxo de Dados
Descr ição das Ent idades Externas
Lis ta de Eventos para fa turamento.
Produto Estra tégia de Implantação.
Produto Est imativa de Pontos de Função.
FASE PROJETO FÍSICO
Modelo f ís ico das bases de dados .
Modelo f ís ico dos processos:
♦
♦
♦
♦
♦
♦
♦
♦
♦
♦
♦
♦
♦
♦
♦
♦
♦
5
♦ Diagrama hierárquico das funções
Fluxograma das rot inas
Procedimentos de controle e segurança
Complementação do dic ionár io de dados .
Modelo de diá logo do s is tema, quando não exis t i r padronização específ ica determinada pela Celepar .
Modelos de te las e re la tór ios do s is tema.
Produto Plano de Conversão.
Produto Plano de Contingência .
FASE CONSTRUÇÃO
Documentação dos programas:
def inição
checkl is t de tes te .
FASE TESTE
Plano de Teste .
Produto Teste do Sis tema.
Produto Teste de Acei tação com o Cl iente .
FASE IMPLANTAÇÃO
Produto Contagem de Pontos de Função.
♦
♦
♦
♦
♦
♦
♦
♦
♦
♦
♦
♦
♦
♦
RNET - ROTEIRO PARA DESENVOLVIMENTO DE APLICATIVOS INTERNET
FASE ESPECIFICAÇÃO DE REQUISITOS
Especif icação de Requis i tos (ut i l izar o GREQ).
FASE PROJETO
Proje to
Arqui te tura da apl icação
Especif icação de hardware e sof tware
Proje to de controle de acesso
Proje to de Banco de Dados
Protot ipação de páginas
Proje to Fís ico de Banco de Dados
♦
♦
♦
♦
♦
♦
♦
♦
6
FASE CONSTRUÇÃO
Projeto de in terface .
Especif icação dos módulos .
Plano de Ins ta lação.
Produto Est imativa de Pontos de Função.
Checkl is t de tes te .
FASE TESTE
Definição das c lasses de Teste .
FASE IMPLANTAÇÃO
Produto Contagem de Pontos de Função.
♦
♦
♦
♦
♦
♦
♦
RNOT - ROTEIRO PARA DESENVOLVIMENTO DE APLICATIVOS EM NOTES
FASE ESPECIFICAÇÃO DE REQUISITOS
Especif icação de Requis i tos (ut i l izar o GREQ).
Protót ipo
FASE PROJETO
Proje to
Proje to de Interface
Proje to de Base de Dados
Proje to de Formulár ios
Proje to de visões
Proje to de workf low
FASE CONSTRUÇÃO
Especif icação dos módulos .
Plano de Ins ta lação.
Produto Est imativa de Pontos de Função.
Checkl is t de tes te .
FASE TESTE
Definição das c lasses de Teste .
FASE IMPLANTAÇÃO
Produto Contagem de Pontos de Função.
♦
♦
♦
♦
♦
♦
♦
♦
♦
♦
♦
♦
♦
♦
7
4.3 MANUAL DO USUÁRIO E MANUAL DA PRODUÇÃO
Na fase Construção do RAES - Roteiro de Análise Estruturada e do RNOT - Roteiro para Desenvolvimento de Aplicativos Notes, paralelamente à atividade de programação, o Líder do Projeto deve acessar a Base Notes – Documentação de Sistemas para consultar os modelos de documentação disponíveis e, identificar os manuais que contém os procedimentos necessários para que os agentes envolvidos com o sistema possam executá-lo. Em seguida preencher o formulário Solicitação de Documentação, disponível na Base, definindo o tipo de serviço que deverá ser executado:
Publicação ♦
♦
♦
O analista elabora um novo manual de acordo com os modelos disponíveis na base e deseja apenas que a Documentação revise o documento.
Em se tratando do Manual da Produção, no momento da solicitação os setores envolvidos com o sistema receberão uma cópia do manual.
Confecção
O analista deseja que a Documentação elabore um novo manual.
Esta solicitação será enviada apenas para a Documentação.
Caso o analista já tenha algum material elaborado em WORD ele poderá enviar juntamente com a solicitação.
Alteração
O analista está enviando alterações em um manual já existente.
Para o Manual da Produção é necessário que o analista envie as alterações corretamente pois no momento da solicitação os setores envolvidos com o sistema receberão uma cópia da alteração
O conteúdo dos manuais pode ser disposto da seguinte maneira: editorado em WORD (Manual, cartela de referência); na forma de help on-line.
Para elaboração, os manuais devem conter no mínimo as seguintes informações:
Visão geral do sistema - com objetivos, t ipo de processamento, necessidades do cliente que o sistema visa a suprir, benefícios e melhorias proporcionadas pelo sistema e inter-relacionamentos com outros sistemas.
♦
♦
♦
Identificação das etapas do sistema - com função, origem dos dados, processamento executado e produtos gerados, além de periodicidade, pré-requisitos para execução e como o cliente deve acionar a execução dos sistema (Remessa de Serviços, automaticamente, etc.).
O modelo oficial de relatórios gerados, com a descrição de campos que necessitem esclarecimentos.
8
O modelo oficial de documentos-fonte, com os campos numerados de acordo com as instruções de preenchimento e de digitação para o cliente. Devem ser informados, também, instruções para transcrição dos dados e procedimentos de exceção.
♦
♦
♦
♦
♦
♦
♦
♦
♦
♦
♦
Cópia de todas as telas do sistema - com informações sobre os campos que geram dúvidas quanto ao seu conteúdo e sobre a navegação entre as telas. Neste caso, um fluxograma com as funções do sistema - de preferência no formato linear - poderá ajudar.
A existência do Manual da Produção está condicionada à necessidade específica de cada projeto. Porém,
quando envolver a Produção o manual deve conter:
Fluxograma do Processamento - para visualização de programas dentro das etapas.
A ordem de processamento dos programas e instruções para JCL.
Prazo de retenção de arquivos.
Os dados para a execução de utili tários e de reprocessamento de programas.
Instruções para transmissão de arquivo.
Instruções para retomada de relatório.
No caso de microfichas, será solicitado o formulário “Instruções para Formatação de Microfichas”.
Procedimentos para a expedição e verificação dos resultados do processamento.
Informações sobre os procedimentos de execução de microfilmagem convencional.
83
ANEXO II – SOLICITAÇÃO DE DOCUMENTAÇÃO
84
84
ANEXO III – SOLICITAÇÃO DE PASTAS
85
ANEXO IV – ARMAZENAMENTO DE PROJETOS
86
86
ANEXO V – QUESTIONÁRIO ENVIADO AOS TÉCNICOS DA CELEPAR
87
GLOSSÁRIO
TERMO DEFINIÇÃO
Análise Estruturada Estabelece sucessivos detalhamentos dos processos desde o nível macro até o detalhe de mais baixo nível.
Análise Orientada a Objetos Encara cada processo como uma coleção de objetos.
Aplicação Lotus Notes É uma implementação de dados e programas que suporta uma função ou propósito de negócios.
Utilizada para criar e tramitar informações através de redes e linhas discadas.
Servidor de acesso Remoto Hardware utilizado para conectar os usuários remotos à rede do provedor. Acesso remoto tornou-se sinônimo de acesso à rede por qualquer usuário, sistema ou servidor não diretamente conectado à rede central.
Banco de Dados É uma coleção de registros de tipos diferentes. Os registros em um banco de dados são interligados, de forma que itens de dados relevantes em registros diferentes possam ser recuperados sem dificuldade.
BP-WIM Ferramenta utilizada na modelagem UML
ER-WIN Ferramneta utilizada para a criação de Entidades e Relacionamentos em diversos tipo de Bancos de Dados.
Groupware de Intranet Se refere à tecnologia de Intranet que permite às pessoas de uma corporação colaborarem entre si eletrônicamente. Isto inclui desde as mensagens até complexas aplicações que possibilitam a uma pessoa ver o que está na tela do computador de uma outra.
Hardware Máquinas
Intranet É uma rede privada que fundamenta sua arquitetura na tecnologia Internet e protocolos de comunicação.
ISO (International for Stardization Organization)
Organização Internacional para a Padronização
Lotus Notes Software da Lotus Developmen Corporation
Mainframe Computador de grande porte.
Manuais de Sistemas Documentação que pode ser apresentada como help, manual de usuário, cartela, manual operacional
On-line Aplicativo com acesso em tempo real.
continua
88
continuação
TERMO DEFINIÇÃO
Rational Rose Ferramenta da empresa Rational – utilizada para manipulação de modelos, orientados a objetos de acordo com as notações fornecidas pela UML
Servidor de arquivos de rede local
Hardware que oferece recursos compartilhados, como espaço em disco para os aplicativos e impressoras.
RUP (Rational Unified Process) É um processo de engenharia de software que aborda todo o ciclo de vida de um projeto e guia as equipes de desenvolvimento no gerenciamento e nas atividades práticas de engenharia de software.
Software Programas para computador.
UML(Unified Modeling Language)
É uma linguagem gráfica para vizualização, especificação, construção e documentação dos artefatos de um sistema fundamentado em software.
WAP (Wireless Aplication Protocol)
Comunicação sem fio.
WEB (WWW – World Wide Web)
Rede mundial de comunicação.
89
REFERÊNCIAS
1. ASSOCIAÇÃO BRASILEIRA DE NORMAS TÉCNICAS. NB – 9001 ISO 9001
Sistemas da qualidade – modelo para garantia da qualidade em
projetos/desenvolvimento, produção, instalação e assistência técnica. Rio de Janeiro:
ABNT, 1990. 8p.
2. ASSOCIAÇÃO BRASILEIRA DE NORMAS TÉCNICAS. NBR ISO/IEC 9126
Tecnologia de informação – avaliação de produto de software: características de
qualidade e diretrizes para o seu uso.. Rio de Janeiro: ABNT, 1994. 11p.
3. ASSOCIAÇÃO BRASILEIRA DE NORMAS TÉCNICAS. ISO 9000-3 Normas de
Gestão da qualidade e garantia da qualidade: parte 3 – diretrizes para a aplicação da
NBR 9001 ao desenvolvimento, fornecimento e manutenção de software Rio de Janeiro:
ABNT, 1993. 14 p.
4. ALVES, J. V.; CORREIA P. J. DSMC - documentação de sistemas para mini e
microcomputadores. In: CONGRESSO NACIONAL DE INFORMÁTICA, 18., 1985, São
Paulo. Anais ... São Paulo: Sucesu, 1985. p. 148-152.
5. ASSOCIAÇÃO BRASILEIRA DE NORMAS TÉCNICAS. NBR 14724 - Informação e
documentação – trabalhos acadêmicos – apresentação. Rio de Janeiro, 2001.
6. BAX, M. P. Princípios básicos de usabilidade. Disponível em:
<http.://www.eb.ufmg.br/bax/disciplinas.htm>. Acesso em 22 set. 2001.
7. BIO, S. R. Sistemas de informação: um enforque gerencial. São Paulo: Atlas, 1993.
8. CALSAVARA, A. et al. Aderência do RUP à norma NBR ISO/IEC 1220. Bate Byte,
Curitiba, n. 104, p. 4-12, dez. 2000.
9. COMPANHIA DE INFORMÁTICA DO PARANÁ. Metodologia de Desenvolvimento de
Serviços – RDOC – Roteiro de Documentação de Sistemas. Curitiba, 2001.
90
10. COSTA, R. M. D. Apostila de metodologia do trabalho científico. Curitiba: FESP, 2001.
Curso de Gestão da Informação e Inovações Tecnológicas
11. CORDEIRO, M A. Manutenibilidade de software. Bate Byte, Curitiba, n. 102, p. 8-9, out.
2000.
12. CUERPO, N. ISO 9000 versus MMC. Disponível em:<http://www.les.inf.puc-
rio.br/socinfo/nestor/cuerpo.htm> . Acesso em: 16 nov. 2001.
13. DALAROSSA, D. Guia Internet de conectividade. 4. ed. São Paulo: Cyclades, 1997.
14. D’ANGELO, N. Metodologia de desenvolvimento de sistemas e documentação em CPD.
São Paulo: Sisplan, 1979
15. FERREIRA, A B. H. Pequeno Dicionário Brasileiro da Língua Portuguesa. Rio de
Janeiro. NACIONAL, 1987
16. FURLAN, J. D. Reengenharia da informação: do mito à realidade. São Paulo: Makron
Books, 1994.
17. GOODE, W. J.; HATT, P. K. Métodos em pesquisa social. 4. ed. São Paulo: Nacional,
1972.
18. GRALLA, P. Como funcionam as Intranets. São Paulo: Quark, 1996.
19. KETIS, D. Terceirizando a documentação de sistemas. Developers’ CIO Magazine, Rio
de Janeiro, v. 3, n. 36, p. 32-33, ago. 1999.
20. LAKATOS, E. M.; MARCONI, M. A. Fundamentos de metodologia científica. 3. ed.
São Paulo: Altas, 1996.
21. LOBO, A. Princípios de qualidade total aplicados a software: processo e produto.
Disponível em: <http://pages.udesc.br/~r4al/qt.htm>. Acesso em: 27 mar. 2002.
22. MARCONI, M.; LAKATOS, E. M. Técnicas de pesquisa, 3. ed. São Paulo: Atlas, 1996.
91
23. MONTÓN, G. J. P. Documentação de sistemas, um mal necessário In: CONGRESSO
NACIONAL DE PROCESSAMENTO DE DADOS, 12., 1979, São Paulo. Anais ...São
Paulo: Sucesu, 1979, p. 153-163.
24. OLIVEIRA, L. C. et al. O processo de implantação da metodologia de desenvolvimento
de serviços – versão 2. Bate Byte, Curitiba, n. 48, p. 24-27, nov. 1995.
25. REZENDE, D. A.; ABREU, A. F. Tecnologia da informação aplicada a sistemas de
informação empresariais: o papel estratégico da informação e dos sistemas de informação
na empresas. São Paulo : Atlas, 2000.
26. SETZER, V. W. Banco de Dados – conceitos, modelos, gerenciadores, projeto lógico e
projeto físico. São Paulo: E. Blücher, 1989.
27. SOWEK, C. A. A importância da documentação. Bate Byte, Curitiba, n. 88, p.10-12,
jul.1999.
28. TRUJILLO, E. O Mercosul e a documentação eletrônica. Disponível em:
<http://www.advogado.com/zip/mercosul.htm>. Acesso em: 16 nov. 2001.
29. UNIVERSIDADE FEDERAL DO PARANÁ. Biblioteca Central. Normas para
apresentação de trabalhos. Curitiba: Ed. da UFPR, 2000. v.2: Teses, dissertações,
monografias e trabalhos acadêmicos.
30. -------. -------. Curitiba: Ed. da UFPR, 2000. v.6: Referências.
31. -------. -------. Curitiba: Ed. da UFPR, 2000. v.8: Redação e Editoração.
32. -------. -------. Curitiba: Ed. da UFPR, 2000. v.10: Gráficos.
33. VALERIANO, D. L. Gerência em Projetos – pesquisa, desenvolvimento e engenharia.
São Paulo: Makron Books, 1998.
34. ZOTTO, F. A. Um estudo dos efeitos organizacionais e sociais da utilização da
tecnologia groupware Lotus Notes na administração pública do estado do Paraná.
2000. Dissertação (Mestrado em Ciências da Computação) – Instituto da Informática,
Universidade Federal do Rio Grande do Sul, Porto Alegre. 2000.
92
