Documentação de sistemas computadorizados

(1)

DOCUMENTAÇAO

DE SISTEMAS

COMPUTADORIZADOS

,~.- .,-_.

'=l

EAE~:r-;:) - ". '.

v.

•...••• "f""""_,. ~-"~~I _ """"0 'Cr::

SECRr: ! " ' ",-".,AR D~".~ c.-\,;I .

I .• r'"·•..•1,,..''''''\. ~ Em @ 'O~ / C(IO , ,- ,I'

_~_~:~~iic···k"l~=~··~···~·l

Banca examinadora

Prot. Orientador: Antonio Carlos M. Mattos

Prof. Norberto Torres

(2)

Este trabalho é especialment't?

dedicado a 11se e Roberto, meus

-I' t· ~ d i \

f.HnaLOSp.si.s , pn;?s'H;?n'_e~sVH1CIOS

l.re-t.amente de Deus, d€'~ quem é toda

honra, glória e poder pelos séculos

dD~3 Sf~CUJ.C'Js.

(3)

RENATO ERICH KLEIBER

DOCUMENTAÇAO

DE

SISTEMAS

COMPUTADORIZADOS

Dissertaç~o apresentada ao Curso de

Mes-trado em Administraç~o de Empresas da

EAESP/FGV, Area de Concentraç~o: PSI

(Produç~o e Sistemas de Informaç~o),

como requisito para obtenç~o de titulo

de Mestre em Administraç~o

Orientador: Prof. A. C. M. Mattos

Fundação Getulio Vargas

EscoLa de Adminisb'ação

de Empresas de S;lo Paulo Bihtiofl!'r..a

St<o Paulo

1990

1199000869

(4)

KLEIBER, Renato Erich.

!::.9!.!lPUt_<!d9..!:..~.3~~~s.Sg(o Pau1o , EAESF'/FGV ,

1990. 80 páginas. (Dissertaç.ode Msstrado

apresentada ao Curso de Mestrado em

Administraçg(o de Empresas da EAESP/FGV,

Area de Concentraçg(o: PSI - Produçg(o e

Sistemas de Informaç.o).

f:(~,ê.l-:,~,!Il0,:Tr-ata de uma investigaç.o, a nível

gerencial, sobre os tipos de docu~entaçao

usados na Ciincia da Informática para

documentar os sistemas computadorizados,

em seus diversos níveis. Nào é objetivo

deste trabalho ensinar uma técnica

especifica. Parte-se do pressuposto de que

o leitor já conheça as técnicas citadas.

Os comentários s.o orientados para dar uma

visg(o global do papel da documentaç.o de

sistemas na empresa.

E.~

l,ª,y.r:...C!§-=-çJ)_ª.Y_~,§. :

Administraçg(o de Sistemas

Análise de Sistemas

Computador

Computaç ão

Documentaç.o de Sistemas

Engenharia de Sistemas

Engenharia de Software

Gerincia de Sistemas

Lnfor-rná tí.c a

Manual de Sistemas

Pn:Jgramaç~o

Sistemas de Informaç.o

So'ftw""re

Técnicas de Document.aç~o

(5)

I N D I C E

(3 E R A L

1 - I11d i c e (,3er-("3.1 ti _ ti It a ft Jt :t II C C ZI li ti n ZI 11'ri1:1a ri ri 1:1 11ZI a a a Ir a li a ti a ti 1

1 _. Int.rc)dl.tç~CJnAl:lflaal:lae:alJPQaAc""cAun"ltrrD'uRAcQlI:annaA 3

2 - O modelo de Comunicaç~o ...•..•....•.... 6

3 - Tipos de Documentaç~o ...••..•.••....••.•••.•. 11

4 - 1 - Informaç~o Preliminar ..•••..••..•.•••••..•• 17

6 - 3 - Documentaç~o de Manutenç~o ••.•...••.•....•• 20

7 ..- 1..1 -- lnformaç~o Publicit.kia .•....•.•...•... 21

8 - 1.2 - Descriç~o Funcional .•.•...•... 22

9 - .1.3 - Documentaç~o dos Detalhes Técnicos .•••... 24

9 - 2.1 ~ Documentaç~o de Refer@ncia do Usuário •••. 26

.10 - _{- Documentaç~o} _de _Treinamento _do _Usuário _{••. 30}

1.1. .- _{- DC)CLlm~?l'1taç~o}_da _{OpE~raç2(o•...•.•.••••••.••}

12 - 2.4 - Documentaç~o para Instalaç~o •••....•..•.• 35

13 - 3.1 - Documentaç~o do Sistema e da Programaç~o. 38

14 - -:!" .•.•,

••••~ 11 .1:•• - Docum~~ntaç;.,':(C)ele TE)stes ...••...••.••.•• 41

(6)

DISSERTAçAO DE MESTRADO EAESP/FGV

15 - 3.3 - Documentaç~o do Histórico ••.•••.•••.•.•.• 44

16 - Documentaç~o de Alteraç~es do Manual •.•..••..•. 45

11 - O Inicio das DocumentaçOes numa Metodologia de

Desenvolvimento de Sist.emas..••.••n n ••••• n ••• n. 46

11 - Ferramentas CASE para Documentar Sistemas .•••.. 56

11 - Bibliografia Comentada~ ...••....•.•••...•. 60

11 ... Ar. e>~o'* 11 ~ ti C ti: ti 11 11 rt D ti 11 lf a II Q G 11 ti P ti C ,. ti n 11 I; ti ti Jf li ti r. n 11 ti :z c ti rt:z 8C)

(7)

INTRODUÇAO

'A

documentaç~o de sistemas é uma atividade que tem

crescido de importância. Desde o principio o Homem tem

procut-ê:l.doformê:\S de ar'maZE'~n<::\r

através das mais diversas formas, seja através da

mE~mória n atur-a L, ~:,;eja _meios f.í.~;icos

(pinturas, letras, etc.).

Com a criaç~o dos sistemas de informaç~o, a

corre-ta documencorre-taç~o de seus softwares adquiriu importância

elevada, na medida em que esta aUX1~lava a

sobrevivên-cia (continuidade de uso) d~s softwares, quando n~o a

de'b;:?rminava"

A documentaçàü de software é a

«;:?).( t.f:·?y"n(Js_ou

duas partes isoladas, quando, na realidade, as

necessi-objetivo da documentaçào nào é outro senào o de

comu-nicar informaç~es que interessam aos dois lados: o uso

eficiente do software.

(8)

pr-óprLo E~\/.i. 't.c3.nd(J

chantaguie seu gerente. As chantagens s~o as mais

variadas possíveis, tais como a solicitaçào de aumentos

pode corretamente efetuar as manutençbes no s1stemas.

Com o surgimento cada vez mais destacado dos PCs

na vida da empresa moderna, cresceu um outro problema

PASCAL, os responsáveis pela informática na empresa, em

geral, n~o se preocupam com documentaç~o de programa.

criando seus próprios bancos de dados e escrevendo

programas em linguagens de quarta geraç~o, ou comprando

dOCUffi€'!!nt.,Y:l.dEl:'

os novos computadores pessoais e a 0rganizaç~o at.ual do

Ou an do o u!..::;uár'Lo

transferido para outro departamento,

(9)

pedir demiss~c ou for mandado embora, toda essa

.í.nfDr(n<:.~,ç;3:o"in for'mc:'!l"f:,'st.al~t.'Ip€'!.',~didC:i..1

Com tudo isto n~o queremos afirmar que a empresa

está t<:-?ndo uma

corretamente feita nào é sinSnimo de falta de problemas

com sistemas de informaçào. Convém lembrar a Primeira

Lei do Fracasso, formulada por Wooldridge e London:

na melhor das hipót.eses, muito pouco será

conseguido." :2

.1 _Uma _{bo a}

encClntrad a em "f-ldm.1.n:i,strando Técnicas

E~3trutL\I~é,-'-das",d~? Edward YDURDON, 19BB, Editora

Campus, paginas 185-205

Wcm]. d r idgt-: L(

(10)

O MODELO BASICO DE' COMUNICAÇAO 3

QUEM .•.

DIZ O QUE .••

EM QUE CANAL ...

A QUEM ...

_._---+

._._+

F

E

D

B

A

C

K

--+

_. .._----+

COM QUE EFEITO

3 Para um aprofundamento maior sobre o tema,

consul-tar Ph.i 1ip Kot 1(;-'?r, "Admin istr<aç~o de Marketing:

Análise~ Planejamenttí (;-'? Controle", Editora f.)tlas,

lr_;>f.H, _volume _{I I I,} _{c a p}í t.u Lo 17 ("Deciseles de

(11)

EMITENTE: o remetente ou a fonte da mensagem

MENSAGEM: o con.i unto d~? signi f Lcadoss que est~o sendo

env Lado-s e/ou r!i?Cf.:?bidos pelo público

(n"~c::~?ptor)"

CANAIS e_: as manei r as pe 1. as qu a.í s as mensagens podem

ser 1c-?vadas ou transmi t.idê.1s ao público

(~-eceptor) •

RECEPTOR: o que recebe ou a quem se destina a mensagem.

FEEDBACK: realimentaç~o

Este modE~lo, j á mui to bem c orrhec ido, serv€~ para

nos si tuar"mos. Na maioria dos casos, como veremos, o

emi tente é fornecedor (pl~opriet.ár"iCl/ct-iaclcH"") do soft-·

A mensagem cClstuma ser um conhec.imento de como

usar o sc)·ftWé!ire. Os c:c:il1,,:d.E~,.",m sua maioric:~, s;~o C)S

livros

[!50tJre o sO·ftWê.1r!i?]pub Lí.c adoz por" (~ditcH"",:As, "helps on

line" e nu hí per t e xto 6. Também ac:l.icicme-·se ao canal, o

4- Lí.vr-et.os do t.arnanbo de um bolso de camisa, em

geral, em apresentaç~o sanfonac:la.

5 Pequenos resumos sobre det.erminada funç~o do

soft-ware, que podem ser exibidos no monitor quando uma

tec 1 a f.",spf:.~c:.ia1. for pl'"·E~ssionada (em get-é!d. a tec 1. a

F.1 ) •

(12)

DISSERTAÇAO DE MESTRADO EAESP/FGV

fatores ta1s como a forma redacional, a

didática empregada~ o cuidado na diagramaç~o editorial,

e assim por diante. O receptor geralmente é

caracteri-zado pela pessoa do usuário final, mas que também pode

vir a ser um auditor de sistemas, e demais casos em que

se apresente(m) individuo(s) interessado(s) em usar ou

conhecer o software: O feedback é o item regulador da

qualidade da documentaç~o, pois pode mostrar se o

usuár-ic) está ua ando zcompr-ando !:.1 sO'ftwan?, sua

satis-faç~o, suas críticas, etc.

Sem muito esforço, notamos que a documentaçao é a

ponte entre fornecedores e usuários de produtos de

sof twr.:H-·<='.Se esta ponte se mostrar inadequada e

desmol~on<:.'\r, du a s parb~s pE.?rmanecem isolada!5.

Freqüentemente isto é causado por profissionais da

in formc.'.ttica (not~3damenb? ana l.ú;tas dl:?sú; temas). Eles

s~o excelentes no desenvolvimento do sistema, fase

criativa e desafiadora, na qual há todo uma motivaç~o

6 Pequenos resumos sobre determinada funç~o do

soft-ware, que podem ser exibidos no monitor, após uma

pesquisa, mediante a solicitaç~o por parte do

ope-radcH-, por meio de pa 1avras--chc.'tve~:;introcíuzidias

a1(7~ato r'ic:tmE,WIte.

(13)

pe~~sc)al em se 'fazer" "o mel hor programc."1do mundo".

Passada esta fase estimulante, chega o momento de

sacramentar o so'ftware, ou seja, é preciso preparar a

documentaç~o do usuário. É neste Lnstan t.e que mui tos

bons sistemas podem estar sendo sepultados.

pr-o f.í s s íone í s , em esta "'fase

monótona e desestimulante". A conseqü@ncia básica é uma

documentaç~o doente e inimiga do usuário, que logo se

v@ desmotivado a explorar mais e mais seu so'ftware, o

qual deveria ser, em última análise, a raz~o de ser de

todo so·f"twan:?

Para garantir a perfeita comunicaç~o entre os que

·faz(~mo so'ftwan:~ e os que CJ uaarn , mui tas empl~esas de

software têm dado uma grande ên'fase em trazer o

so'ftware para a realidade do dia a dia do usuário, por

meio de um r.lr()fis~~ionalde r-·E·daç~o.Além se sabet- a

linguagem e a rotina da área de sistemas, esta pessoa

deve principalmente saber ~xpressar-se na linguagem

natural do usuário, conhecer seus problemas diários e

levar, por meio do so'ftware, exemplos de como o sistema

pt")d€-?~3w·:.iJ..i<[:(·""lo.O alvo é tf:!'F"no usuc.'F"ioum aliado,

lE::vandoo softw':ln·",a set- urn S".uceSSD para C) qual foi

pn::)jetado.

(14)

Em b·:wmos de da de~~tes

profissionais de citar.:í.amos os trabalhos

realizados:

a) pela Borland (no caso Paradox 3.0)~ onde há todo um

cuidado notório com a apresentaçâo e redaç~o de seus

manuais. Veja-se o manual que ensina o PPROG, onde o

t-'edator r'esponsável ensin'::i o uso do softwan'? com

bc"":i.senum es.';tudo de caso, o projeto de um sistema

gE:~renciê:\dor de

locadora.

bancos de dados de uma

b) e Micn:lsoft (Word 4·.0, PRO.1ECT e l'1fJ-CHART), onde

além dOf.:i já tradici(Jnais manuais do padrâo

r1ic rosoft, tE?mO~.5cursos auco+d i.dáticos rio próprio

PC, o,::: quais at.ravés de aulas prC)gt'-amada~; levam o

usuár Lo a uma v iagE?m para conhecer e)s recur-sos do

soft.ware. Est.á é sem dúvida a maneira mais agradável

dl-? 2q::)I~E?1ld~"?r-,poí.a o rI-?c!a "t<Jr- do s progl'-amas LEARI'.ls

varia de liç~o pare::I 1. iç~C) a árer] a~.lC)rd.::~(vendas,

pf:SSOé:d, mt~dicina, cDnff:?cçâcl de Lí.vr-o , pesquisa de

e assim por diante). Isto sem dúvida

aproxima em muit.o o software da prática diária dos

usuários.

(15)

TIPOS DE DOCUMENTAÇAO

Ao se ml:?ncionar "documentaç~o", Loqo nos v?m à

mente os tradicionais manuais de sistemas, bem

conheci-dos por diver·s.:.~sPE:'ss;cn-isligC":\dé~StI informf:\t.ic.!l,que

normalmente s~o muito procurados pelos usuários no

começo do use) do sC)'ftwane, mas.;que, com o acúmulo de

experi?ncia adquirida, logo passam a incomodar, vindo a

ocupar 1ugêH'-er:,pro po rc i.ona1men t.e cada vE'~zmaí.or-es nas

pr-ateleir-as (isto quando n~o ficam longos períodos

es-quecidos em alguma gaveta ou arquivo). Nas décadas de

60 e 70, estes manuais eram basicamente o sin8nimo de

documentaç~o~ o que, venhamos e convenhamos, n~o deixa

de ser coerente e até lógico para aquela época. O

pro-blema está em n~o se per"CE~b€;>rque pê,\raC":\n~'alidade a

década de 80 e de 90, em que vivemos, esta definiç~o é

Lnc omp l e t a , querido n~o insuficiente, porque assim

muitos softwares hoje negociados no mercado seriam

c:1.::ISSificaclos como 11se:,'mdoc umen t.aç~o", por' n~o

apre--sent.arem cleter-minadas pastas ou manuais. Como exemplo,

ant.ecipando o que mais adiant.e det.alharemos, existe uma

cat.egoria de doc:umentaç~o entregue ao usuário,

denomi-nada de manual de instalaç~o do software. Numa rápida

()bservaç~o nDE; aplic:a"t:ivof:;;,princip"dmente para os da

1in!-la IB!'1/F'C,notar-emos que o for-necedor- de sof twar&?

(16)

entrega seu produto acompanhado de um disquete chamado

"disco de in5L::\J.éH;;:~O"~ no qual f.mcontr'am05 um pro~'lr'ama

que realiza esta tarefa 7. Ao se rodar este programa,

todo serviço de instalaç~o é gerenciado pelo software,

b2~standD ao operador apena!5 seguir as instruçôes que

forem aparecendo no monitor, o que implicará em apenas

responder algumas perguntas para parametrizar o sistema

ou simplesmente trocar disquetes para o instalador

poder fazer sua tarefa. e

Com todo este avanço tecnológico, estariam o

manuaía caindo em desgraça? Ef~ pr'eciso antes de mais

nada verif.ícar quais pod~?riam sem as vantagens df.:'?se

possuir manuais na empt-'eSé\. Em vamos

7 Como exempl6 teríamos o SETUP.EXE do MS-CHART 3.0

da Microsoft, o CONFIG.EXE do MS-WORD 4.0 [em

por-Compuc en t er , pela

INSTALL.COM do LDTUS--l-'-2-3, dí ss+

tribuído no Brasil pela Datalógica, e outros

soft-8 Com isto n~o queremos anular aqueles típicos

anexos que v~o no final do manual do usuário, com

título~~ similan:?s a "InS'~t,,~I(~mdos~?u software .•'",

pois estes s~o a parte escrita da documentaç~o de

instalaç~o que vai ao usuário.

12 / 80

o

,'

(17)

alguns aI'"guman tos dos de-fensores _dos

manuais, normalmente ligados à Organizaç~o

&

Métodos.

I) Como ponto a favor, os manuais registram em papel

informaçôes, cujas páginas podem ser dispostas

ana1isadas5, faci1it.arido assim as tarefas de

reorganizaç~o dos sistemas, uma vez que constituem

uma importante b í.b Lí.oq r-a fLa técnica e, por't_anto,

fonte pesquisa. Afinal, por melhor que seja o

monitor de video, n~o podemos visualizar, com

facilidad!7? de leitura, vinte páginas

~;;.imulti:ineamente,o que poC"1f?r-ü,\ser feito com a

papelada toda numa mesa comprida. 9

11) Os manuais poderiam ser instrumentos visando o

sadio crescimento da organizaç~o. A empresa assume

uma amplitude tal que já n~o é possivel dar

instruçôes particulares para cada empregado ligado

à área de sistemas, devendo-se condensar cada

tarefa num manual.

/

9 Este alr-gumento mostl~ê\.::~pena~;qUE.'há momentos em

que a tela do moní tor n~o pode abri(;)ar todas as

in -fol'"maçÔes,Ic:mge de .í nva Iide"r o uso de "heI ps ori

1.ine" ou do hipf:?rtf:"?icto,que podem s(:?mimpl'"essosde

acordo com a necessidade.

(18)

ITI) As tarefas operacionais, às vezes, t@m tantos

detalhes que é inevi t~\vel o aparecimento de sobre:? co. _:)'" C" poa sí.b í 1i.dades e

recursos do software. Ao invés de perder-se tempo

buscando explicaç~es individuais em diversas telas

ou pesqLtisas de '·1iperteN"to, ut.iliza··-se o rnanua l ,

onde est~o previstos todos 05 casos, podendo este

ser consultado pelo prÓprio empregado, afinal

IV) A ta xa dc:? I'"otc:~t.ividadf?de pesso.:.ü, às vezes~, é

tanta, em certas áreas de trabalhos ou épocas, que

tCjrnc."'Itorna impraticável o t n·?.in amf:"?nto exaustivo de cada novo funcionário que adentra a

geral do trabalho e orientá-lo no sentido de

pesquisal·-, no manual, as e)·(ceç~es qUE.'?por"ventura

sctr"jarn ,

V) Com o dinamismo do quotidiano na empresa, 05 menus

de "helps em lin(:?" t.er.L:imque constantemente SEU'"

acumulada pelo uso do so·ftt-'llat-e.Ist.o c:er"tamente

implicaria em constantes manutenç~es nos softwares

nada bar-at.::~se ~:.;impl(;?s.É: mui to ma.ís convenienb.~

\

e,dIc .1.ona"'·-5eurna 1'01.hc:t nova no fina 1. da sess~o

(19)

correspondente no manual. "Com i=~to o manual

cr€:>scejunt.o com a E'mpn?Sa."

Independente da forma eleita para realizar sua

que n::~t.er. _tal~ _segundo

Loma x 10, pod€:>mos tipific:ar as dc)cument.açeJes de

softwares em tr~s categorias principais~

1 - Informaç~o Preliminar

2 - Documentaç~o do Usuário

3 - Documentaç~o de Manutenç~o

Os objet.ivos centrais s~o importantes de notarmos,

('. \.

pois é a forma básica para se tipificar a documentaç~o

de softwares. Fundamentalmente, podemos ter dois alvos:

10 Lomax , J. D., "DocLtmentaç~o de Soft.ware"~ Editora

Cê.~mpus:;1977

(20)

1) User's manual: dirigido ao usuário do sistema (representado acima pelas categoria~:;; 1 e 2), "uset- ot"'ienb:",d manual".

2) Technical manual: dirigido ao técnico em computaç.o, dE?Sv.incul<:mdo o au t.or' do sistema de sua obra (representado acima pela categoria "machine tlriented rnanua L'",

Na seqüªncia deste trabalho, pretendemos detalhar as tt-'&s categor'ic:\s ac:Lma, para meI hor indi v idua 1.izar' cada c~'.\tf?g(Jria.

(21)

1 - INFORMAÇAO PRELIMINAR

Também conhecida como informaçao introdutória, ela

é nOlr-malmf,mteoferecida a L\(T'r cLí ent e f=m pc:-'?rspectiva,

quando este começa a pensar na possibilidade de

adquirir o software. Seus dois objetivos 5_0:

a) expor claramente o que o software irá fazer e

qual o equipamento que será necessário.

b) a t.t-ait- oss possiv€-?Ís cli.E:mtE~se encor'ajá--losê\

adquirir o software.

A

documentaç_o preliminar é composta dos seguintes

documL=,mtos:

1 - Informaç~o Publicitária

2 Descriç~o Funcional

3 - Resumo dos Detalhes Técnicos

Na ordem em que se apresentam acima é que costumam

ser apresentados ao cIientl7?, consti t.u Lrrdo+ se ~ por

e:o(cE)l't?ncia,o material de divl.lJ.gaç~c)cios v€mdedores.

Mais adiante, detalharemos seus conteúdos.

(22)

2 - DOCUMENTAÇAO DO USUARIO

Esta é, com certeza, a documentaç~o mais Lmpcir+

tante a ser considerada sob o ponto de vista do

admi-ní str-ador- da área d€~! proc€,!s!!:;cHTlentode dados que está

adquirindo um software de terceiros.

Antes de set- poss Lve I a u tíLí zaçào do f.~oftware,

tr~s etapas devem ser cumpridas. Em primeiro lugar, o

usuário PI'''€:'c:isa saber como usar o software. Neste

caso, pode ser necess,lr- io um treinamf.m to forma 1a Em

uma segunda etapa, a equipe de operaç~o da in5talaç~0

do computador €~mque o software seré utLl I zacío , deve

saber como operar o software. E, por fim, o software

deve ser instalado. A documentaç~o do usuário deve ser

projetada para ajudá-lo nessas etapas, n~o sÓ durante a

instal<:'''Içgco, como também post€H"iormente, c orno fonte de

'

..' \,

<;:

Y

I

(23)

S~o quatro 05 documentos do usuário:

1 - de Refer@ncia

2 - de Treinamento do Usuário

3 - da Operaç~o

4 - para Instalaç~o

Mais tarde detalharemos seus conteúdos.

(24)

3 - DOCUMENTAÇAO DE MANUTENçAO

A document.aç~o de manLlt.enç~o geralmente fica em

poder do fornecedor e é utilizada internamente.

sid~?ra-'se manutenç~c:) também a corTeç~o de el~ros como

modificaç~es feitas para melhorar o software.

S~o quatro os documentos de manutenç~o:

1 - Documentaç~o do Sistema e da Programaç~o

2 - Documentaç~o de Testes

3 - Documentaç~o do Histórico

4 - Documentaç~o de Alteraçôes de Manuais

Mais tarde detalharemos seus conteúdos.

20 / 80

r.

(25)

1.1 - INFORMAÇAO PUBLICITARIA

A publicitária é a

documentaç~o que um cliente em perspectiva irá receber,

logo ela deverá descrever a finalidade do software de

for'ma f.:::\ciJ.ment.ecompr'eE.>nsíveJ..Pode ser' um catáloçjo

ilustrado com as características do software.

CONTEUDO:

1 - Nome do software.

2 Dest:ri(;~(j dos objetivos do soft~"at-·e e das OÇ)çô~::s

disspon Ivei~,;;, vantagens para o

Pode ser vant.ajosa a inclus~o de

palavras-chaves selecionadas para facilitar as

pt.~squisas.

3 - Descriç~o geral do hardware, onde o software será

processado e de quaisquer outros pré-requisit.os.

4 - Relaç~o das áreas de aplicaç~o.

5 - Custo do software (opcional).

6 Contato para maiores (ou mais recentes)

infor-maçôes e para maiores consultas referentes à

at.ua-lidade das informaçôes.

7 - Data da publicaç~o.

(26)

1.2 - DESCRIÇAO FUNCIONAL

A descriç~o funcional oferece mais detalhes sobre

as funç~es do software ao usuário em perspectiva que,

depois de ler a Informaç~o Publicitária, deseja saber

mais a respeito do software, antes de tomar a decis~o

de adquiri-lo.

CONTEUDOg

1 - Nome do software.

2 Os objetivos do software.

3 - Pré-requisitos para o seu uso.

4 - Descriç~o esquematizada, identificando as funç~es

mais importantes e os recursos disponíveis,

indi-cando se s~o padronizadas ou opcionais.

(27)

5 Para cada funç~o~

a) entrada requerida (em termos bem gerais);

b) saída fc)rnec:ida pe 1o ssoftwarE' (em termos bem

g(:?rai~:5);

c) descriç~o de quaisquer regras de processamento

significativas;

d ) 1is;t~" de manuais; e out.ras dCICumen t.açbE?S

disponíveis.

6 - Contato para consult.as.

7 - Data da publicaç~o.

(28)

1u3 - RESUMO DOS DETALHES TÉCNICOS

o

Resumo dos Detalhes Técnicos deve fornecer mais

dl:-'?ta1hes que ~) Informa(;~(J F'ublLcitár ia, ê\ respei to do

hardware, dos requisitos para o software, dos custos e

tempos para processamento.

COI\ITEUDO:

1 Nome do software.

2 Os objetivos do software.

:::;;Os; pn)cessador'e~~ rios quais o software foi utí,«

lizado e aqueles nos quais também poderá vir a ser

usado.

4 Requisitos de memÓria.

c::

~I Equipamen tO~5 utilizados no

desenvolvimento do software.

6 - Todo equipamento (hardware) adicional necessário.

7 Modalidade de processamento (se for iterativo, as

necessidades de terminais e de equipamentos de

comunicaç~o devem ser estabelecidos).

8 - Arquivos mestres necessários (quantidade, tamanho

e meio de armazenagem).

(29)

de tF"ê?balho nl:-1cessár-iDS (quantidade,

tamanhD e meiD de armazenagem).

10 - Sistemas Dperacionais, com os quais o sDftware foi projetado para funcionar.

11 _..Linguaç~em(ns;), cClmpiladClr(es) 1:1outros .itens d(= software necessários.

12 - Ati v idadl::s p~.:u~aa rf.?cupr~ré7lçâDelo pn3Cessamen to e

dos dados, em caSD de defeito (em termos gerais).

13 - Controles para o processamento.

14 Proteçâo e segurança dos dados (em termos gerais).

15 Tt':?mposde uma amoat ra prc::Jcessada E~m uma conf igu--raç~o especifica.

16 ._.Custo e c:ondiçe1(7)s~el€'.:'vr~nda de todas e\S c ori f Lqu+

raçBes disponíveis do software.

17 .- Supo".·tt~e manutf.mçâo fornf.;)cidc:lsdentro do prf.?ço--· b,ase.

18 - Disponibilidade e custos de cursos de treinamento (se existirem), com detalhes sobre o conteúdo.

19 - Contato para consulta.

20 Data da publicaçâo.

(30)

2.1 - DOCUMENTAÇAO DE REFERENCIA DO USUARIO

Esta é, sem dúvida, a prí.ncLp.aI dCJc:um\;;mtaç~o,em

rela(,;~o ao u sau.árLo f í n a l nEla d€NE' contet- todas as

in'forma(;b€~s nf2C€Õ'ssári,,:tspar'a qUE:' todos os r'tr.?cursot".iE'

opÇelE~S pOSSêH!1 SE?r utí 1iza do s , Todas as posssí bi.lid'::-ides

de entrada e saida (inclusive a(s) mensagem(ns) de

erro(s», com exemplos, também devem constat- cessa

documentaç~o. O manual deve chegar às m~os do usuário o

mais cedo possível e, de prefer?ncid, até antes mesmo

do ~:;oi:twar"E?

Com c intuito de apoiar- m~is usuário, garantido a

p o hipertexto, os quais complementam o manual de

s2rem extremamente ricos em explic:aç~es, como é o caso

::~• [J ;'

En tret.i-::tnt:.CJ;1

(31)

hipertexto. Seu funcionamento se baseia em pequenos

resumos sobre determinada funç~o do software, que podem

ser exibidos no monitor, apOs uma pesquisa, mediante a

por parte do operador, por meio de

palavras-chaves introduzidas aleatoriamente.

Na

realidade a documentaç~o de referincia é um disco que

contém o material de pesquisa do hipertexto.

CONTEUDO:

1 - Nome do software e refer@ncia da vers~o.

2 Indice.

3 - Informaç~o introdutória:

a) descriç~o;

b) problemas que o software pode resolver;

c) métodos de soluç~o adotados;

d) descriç~o do sistema, quanto aos programas~

componentes e módulos;

e) requisitos de hardware;

f) requisitos de software (inclusive sistema

operacional);

g) métodos de acesso;

h) rotinas de segurança e técnicas utilizadas.

4 - Relacionamento entre os problemas resolvidos e

seus componentes.

(32)

5 - Os componentes do sistema. Para cada um deve ser

descrito em detalhe~

a) problema(s) que o componente ajuda a resolver;

b) informaçâo de entrada~

I) qual entrada é n~cessária

T '1' v J••t, }

UI) meio

c) processamento

I) efeitos normais esperados;

I!) efeitos colaterais;

111) erros que podem ser detectados~ suas

mensagens saída resultantes impressa (ou

E?;.::i.bidi:."t E?fl1 mon.it.cll''')e como COf"f"iqir-o

E~r"r'o ;

IV) proteçâo e segurança dos dados.

I) 'f_ormato II) m~~iC)

III) E~;.:at.icjâo

1\/)OPÇbE:'S

e) E~>~t:-?(nplr.js p: ....át í.c oe qu e Ln c Lu am an)ost.r'as; ele

(33)

7 - Informaçbes Adminitrativas:

a) contatos para consulta;

b) procedimentos para atualizar a documentaç~o (e

conseqüentemente o software);

c) prc)cE·dimEmto~:; pc:lra n::~latê!U'-E?t"TOS na documen··..

ta(;â!o;

d) procedimentos para informar sobre erros no

softwane;;

e) refer~ncia da possível Documentaç~o de

Treina-mento do Usuário;

f )t"€d:erênc::ic:\da poss.í.vEdo Documen t.aç:~(c)d("-f.

Ope:·ra-g) Dat.a da última publicaçâ!o;

h) 131o~mé.~rio;

i) Indice remissivo.

(34)

2.2 - DOCUMENTAÇAO DE TREINAMENTO DO USUARIO

Esta documentaç~o por objetivo ajudar

usuário a usar o software o mais rapidamente possivel.

A tend@ncia atual é que o manual deixe de ser escrito.

Em seu lugar t@m sido confeccionados cursos

auto-didt.üicCJS no próp r'io PC, os qtiai.s a t.r-avésde au 1as

programadas levam o usuário a conhecer os recursos

básicos do soft.ware. ~ sem dúvida a maneira mais

agl'-iad<.~velde apn:.mder. C<:)lyfonn~?l??mpágina pessacía , o

ideal seria que o profissional redator dos programas de

treinamentos mudasse, de liç~o para liç~o, a área

aborda (vendas, pessoal, medicina, confecç~o de livro,

pE':squilsadf.:?",ibope"f!~ass;,impor' dí.ant.e).

(35)

CClNTEllDO:

As mesmas áreas cobertas pela Documentaç.o de

Refer~ncia do Usuário devem constar na Documentaç~o (ou

proÇJr-é:Hni..q)dt? Tn-:?inamf.?f1te). C,;:~da c ompon ent e do sof twsrc:-:

dF.:VE~ ser- i Lu s tr-ado sE'parac:lamr::>ntf2, in a c iando pe 3.o mais

simp 3.(~s. O ide,r.\1 é que é:~ Doc:umentaç~o de Tr-e í.n arnanto

apresente apenas casos simples, deixando as exp3.icaç~es

mais c omp Lex a s para a Documentc.iç~o d€:? Refel~~ncia do

Usuário. O conceito básico deve ser aumentar os

cc)nhecimentos~

-fundamentais.

bC:'<.sicos a conceitos

(36)

2.3 - DOCUMENTAÇAO -DEOPERAÇAO

Esta doc umentaç ão deve aprE.'sentcu-as i lustr':'içôe~:;

necessárias para a operaç~o normal do software em uma

conf.igur.:.•.ç~() (,~SpE'Cl.fica • Também deve abot-dar a

trans--criç~o dos dados de entrada para meios legíveis para o

sistema, caso tal transcriç~o se faça necessária.

CONTEUDO:

1 - Nome do software e refer~ncia da vers~o.

2 - Informaç~o introdutória:

a) detalhes resumidos sobre a aplicaç~o;

b) sumário dos procedimentos.

3 - Requisitos para cada uma das opçôes:

a) requisitos do computador:

I) tamanho da memóric:' (mínima e

ac:onse--lhável);

II) pet-iféricos;

b) requisitos do software:

.1) sistema operacional;

(37)

c) para cada um dos arquivos usados:

I) objetivo;

Ir) meio;

I I I) t.aman ho •

4 - Dados de entrada:

a) formulário original;

b ) meio df2 leitt.tr"apelo cc){nputc:~dor(f2>:emplos de

meio e formatos);

c) instruç~o para planilhamento;

d) requisito para os lotes;

e) requisitos para a segurança dos dados.

~ ._-Saída:

a) meio e for-mato repetidos conf or-rne a~~

necessi-dades.

6 - Procedimentos para a operaç~o:

a) inter-relacionamento dos programas;

b) carga dos programas;

c) alocaç~o de dispositivos;

d) processamento dos programas;

e) comandos do sistema;

aç~es requeridas);

g) condiç~es de erros no sistema (mensagens e

aç~es requeridas);

(38)

7 - Informaç~es Adminitrativas~

a) contatos para consultas e maiores informaç~es;

b) procedimentos para atualizar a documentaç~o;

c) procedimentos para relatar erros na

documen-d) procedimentos para informar sobre erros no

software;

e) referência da possivel Documentaç~o de

Referên-cia do Usuário;

f) data da última publicaç~o;

g) glossário;

h) indice.

(39)

2.4 - DOCUMENTAÇAO DE INSTALAÇAO

Esta documentaç~o para Instalaç~o é usada quando o

so'ftt",al~eé colocado no sistema do c ompu tador- e deve espec.i ficar', em d€'",talhe, é:\SaçÍ';;esnec:es~5ár'.iaspal'-a a

sua implantaç~o. A tend~nc:.ia atual é que o manual em si deixe de ser escrito. Numa rápida observaç~o nos

apLí c stLvoss , principalmentf:? pc:u"a05 d,,,, linha IBM/PC, notaremos que o fornec:edor de software entrega seu

pr-oduto a cornpan h.arfo df:'~um di!:5qw?tE~ charnacío "disco de

no qual encont:r-.:\mos um programa que

rf:?al.L::aesta té:\I'''e'fa.Ao SE~ rt.::ldareste progl""ama, todo

serviço de instalaç~o é gerenciado pelo software, ba stancío ao Dper"ad(Jr" apenas sf:?guil'''as instruçi':le~~que

forem aparecendo no monitor, o que implicará em apenas

responder algumas perguntas para parametrizar o sistema

ou simplesmente trocar disquetes para o instalador

poder fazer sua tarefa. Como E.'xemplo tf:'~riamos o

SETUP.EXE dD MS-CHART 3.0 da Microsoft, o CONFIG.EXE do

MS-WORD 4.0 [em portugu~s], distribuido no Brasil pela

Compucenter e o INSTALL.COM do LOTUS-1-2-3, vers~o 2.0,

distribuído no Brasil pela Datalógica.

Com isto n~o queremos esquec:er 05 tipicos anexos

que v~';(orio final dos martuaí ss do usuÉ\r"io, com titulos

(40)

similares~:l "In:~talando seu software ..'", po.is estes s~C.)

a parte escrita da documentaç~o de instalaç~o que vai

ao l.lsl.lál~Io , ind acando os pas~::;osa ~:;en=mseguidcJs p.:.u"a

rodar o programa instalador.

o

programa instalador é sem dúvida a maneira mais

prática de se instalar um software~ mas temos que

reconhecer que nem todos os ambientes de computadores

permitem este processo. Alguns programas, devido à sua

própria natureza (linguagem ou aplicaç~o) necessitam de

uma instalaç~o "aF·tesclnal", not-m,,:\lmE~ntesupet-visionadi:\

por um especialista do fornecedor do software.

CONTEUDD::

1 - Nome do software e referªncia da vers~o.

2 H~?quisitos~

a) tipo de computador;

b) sistema operacional;

c) outros softwares necessários;

d) hardware necessário para a implantaç~o;

e) material fornecido para implantaç~o.

(41)

3 Procedimentos:

a) passo a passo,

b) arquivos e/ou biblioteca a serem criados;

c) diretivas de controle para a execuç~o do

serviço ou outras instruç~es para o computador;

d) saidas que devem ser produzidas,

para a Document.aç~o dos test.es

necessários para o processamento, inclusive

re-sultados;

a ) cont at.osspal~i~o caso df.?sur-girem problemas 1:-"1

para vet-ifi.car's€:?as~ informo":'tç~esainda est~(j

atualizadas;

b) procedimentos para relatar os erros encontrados

na documentaç~o;

c) refer~ncia da possivel Documentaç~o de Testes;

d) data da última publicaç~o;

e) glo~3sár-io;

f) _incHce.

(42)

3.1 - DOCUMENTAÇAO DO

SISTEMA

E

DA PROGRAMAÇAO

Esta é a documentaç~o que traz as informaç~es mais imp()t-tantes e deve tot-nc":\r"apto seu (s) n~spon~;éve 1 (is)

de responder a todas as consultas sobre a performance

operacional do software.

CONTEUDO:

1 - Nome do software

2 Vf.?I"'S~O do soft.ware à qual a doc:umentaç~o ~"?m

quest~o se refere.

3 Informaçôes de experi~ncias de todo o sist.ema.

4 ESPf?ci f icaçôe!:-~estruturadas dos pf"(:JCE.'dimentosdo

st:rftwan?, corneç ando por" uma vi~:;~CJgE·t-al do sis ....·

tema, seguida por informaçOes cada vez mais

minu-5 -" Es.pecific:aç~o elas estn.ttur·,,,,,sde dc:~dos ado tad a s , cont.encío dEd:a1l1e~;;~:;otJreos é:u"'quivos, registl'''0!5e

itens de entrada, armazenamento e saidas

estrutu-radas dos dados, Lnc lusíve com "laY-"Dut" dos gabaritos para impressora DU saídas pDr telas.

(43)

6 - Fluxo do processamento dos programas, mostrando o

inter-relacionamento dos programas e dos arquivos

de dados.

7 - Doc:umEmtaç::i(o.í nd íví du a l de cada pr-oqrema do

sis-t€.-?m<:l":

a) sumário do programa;

b) lógica do programa;

c) quadr-o da €;.>s;t.rutUl"-ado pr"ograma, moat.rando C)

relacionamento dos módulos (exemplo~ DHF -

Dia-grama Hierárquico de Funçôes)

d) resumo lógico de cada módulo;

e) definiç::i(o de dados contidos pele) proçjrama

(tabelas!. etc::.);

f) listagens das codific:açôes dos programas-fontes

e, se necessário, dos programas-objeto~

g) tabelas de tempo (para programas em tempo real

e massa de dados especificas);

o pr"OC(?SSD de forma

narrativa ou, preferencialmente, de recursos de

metalinguagem, tais como~

I) gráfico/árvDre de decisôes;

11) tabela de decis~es;

IrI) linguagem estrutura (ingl~s/portugu~s);

IV) pseudoc:ódigo;

V) HIPO detalhado;

VI) diagrama de Nassi-Schdeinerman;

(44)

8 - Consideraçôes sobre a op~raç~o.

9 - Condiçôes de erro.

10 - Informaçôes Adminitrativas:

a) Contatos para consultas;

b) P,r'ocedimen tos para a atual izaç~o da

documen--taç<3:O;

c) Procedimentos para relatar os erros constatados

na documentaç<3:o;

d) Refer@ncia da possivel Documentaç~o de

Referin-c La do Usuário;

d ) Refet-incia d~::\possível Documentaç~rj d(~

Opera--f) Data da última publicaç~o;

g) Glc)ssário;

h) Indice.

(45)

3.2 - DOCUMENTAÇAO DE TESTES

A documentaç~o de testes deve conter os dados

usa-dos para testar o software em todos os seus aspectos~

apf:.,>sc:u-c.1€7.' r'aram€:mte sc~~rpos~5ível testá--lo para cada

c ornb í.o aç ào de ciI"cuns;tâincias pos.sívf":!is.Esta

documen--taç~o também deve conter os resultados a serem obtidos,

quando da utilizaç~o destes mesmos dados de teste.

Ger.::dmE?nteesta docurnent ac ão ser'á us~ada apenas para a

rnanutenç~o POt- ps rte do fornecedor (ou €~quipe in t€.~rna

de desenvolvimento de sistemas da organizaç~o).

CONTEUDO:

.1- Nome do software

2 Vers~cJ do soft.~""a,...·e .à qu e I a dOCLlmentaçg(o (:am

quest~o se refere.

3 Explicaçbes gerais sobre o método usado para

rea-l.izar o teste.

4 - Listagem e explicaç~o de cada teste:

a) dados [de entrada] para o teste:

I) dados do arquivo-mestre e procedimentos

da preparaç~o para o teste;

(46)

11) dados de outros ar"quivos e procedim~~ntos

UI) ent.rada de dados por meio manual

(tecladD) .

IV)

refer~ncia - inclusive de oncle est~o

acima citados

(disquete, fita, etc.).

b) resultados obtidos (esperados) pelo teste:

I) arquivos-mestre;

11) outros arquivos;

(inclusivf:~ 1is'l:agens

gabaritos de telas de salda).

(47)

a) Contatos para consultas;

b) F'1~ocedimer-rtos para a a tua Iizaçào da docurneri-:

c) Refer~r-rcia da Documentaç~o de Sistema e da

d) Data da última publicaç~o;

e) Irrd í.ce ,

11 Not ar a t'jmiss~oproposi t.al da palavra "possivel",

uma vez que partimos do pressuposto que a

Documen-(talvez n~o da forma completa corno defendida nest.e

trabalho, mas pelo menos uma parte minima)~ sen~o

n~o há sequer sentido em fornecer uma Documentaç~o

(48)

3.3 - DOCUMENTAÇAO DO HISTORICO

A documentaç~o do histórico mostra porque o

soft-ware foi desenvolvido deste modo~ o que foi previsto

tendo em vista futuros acréscimos ao sistema e quais os

acréscimos que n~o foram aceitos e porque.

CONTEUDO:

1 Nome do software

2 - Antecedentes e documentaç~o histórica.

3 - Aperfeiçoamentos rejeitados e as razOes pelas

quais foram rejeitados.

4 - Informaç~es obsoletas de outros conjuntos de

docu-mentaç~o.

5 - Procedimentos para a atualizaç~o das informaçOes

do Histórico.

6 - Data da última publicaç~o.

7 - Indice.

(49)

DOCUMENTAÇAO DE ALTERAÇOES DO MANUAL

As alteraç~es feitas em um determinado manual

de-vem ser- enviadas par-a todos os Lt!~uár-ios1'-egistrad(Js

neste manual. Seus nomes e endereços devem ser

regis-trados na Documentaçao de Alteraç~es do Manual.

CONTEUDO:

1 - Para cada tipo de manual editado, as seguintes

in-formaç~es devem ser registradas:

a) nome, cargo e endereço do usuário;

b) quantidade de manuais;

c) Versao do software, ou indicaç~o de que o

soft-ware nao foi fornecido a este usuário;

d) Data da última publicaçao.

(50)

O INICIO DAS DOCUMENTAÇOES NUMA METODOLOGIA DE DENVOLVIMENTO DE SISTEMAS

o

trabalho de desenvolvimento de um sistema pode

ser dividido em parte distintas, independem te do

equipamento, da empresa usuária ou da aplicaç~o, embora

essa divis~o dependa, parcialmente, do objetivo, da

complexidade e do tamanho do sistema.

S~o as seguintes as pat-tE's em que o cí c lo de

desenvolvimento pode ser dividido:

- Definiç~o do Projeto

- Definiç~o dos Requisitos Básicos

- Desenvolvimento

.- Implantaç~o

Cada uma dê:\!:.':;part:f.~sac ima e denominada 'fase, aE;

quais pa!:"Ssamosa detalhar- adiante. NOSf50 pr-oposí tc é

pl~opor apeneIs o i.n.iciodos proc esssos de doc umerrtaç ão

dentro da seqü~ncia cronológica abaixo apresentada.

Partimos do pressuposto que o sistema está sendo

desenvolvido internamente à _empresa.

(51)

DESCRIÇAO DAS FASES 12

100 DEFINIÇAO DO PROJETO

1.10 _Avaliaç~o _preliminar 13

111 Estude preliminar

112 Definiç~o e abrang@ncia dos objetivos

113 Obtenç~o de garantia de envolvimento e

apoio do usuário

120 Estudo do Projeto

121 Organizaç~o e administraç~o

122 Elaboraç~o do programa de trabalho

123 Organizaç~o da equipe

124 Treinamento da equipe

199 Ponto de Revis~o

.1.2 _Para _LIma _mel_1-10_r _discuss~o _das _fases _do

des(~,?nvolvimentode I_Im sistema, consultar- "Ger''ênc:ia

de Projetos de Sistemas"; por A. A. Fernandes

&

J.

L. C. Kugler, Editora LTC, 1989, páginas 22 - 53.

1::::; Iri Lc í.o da "Doc::umentaç~odo I-H~;tóric:o"

(52)

300 DEFINIÇAO DOS REQUISITOSBASICOS

:3.10 _{Esboço das Funç~es} _{do Sistema} 14

31.1 Exame das funç~es do sistema atual

a) Obtenç~o e exame da documentaç~o

do sistema atual

b) Identificaçâo dos fluxos de

da-dos do sistema atual

c) Exame da operaç~o do sistema

~:;1,t.u aI

d) Entrevista com atuais usuários

e) Identificaç~o das interfaces do

sis·tema atual

312 Definiç~o do dominio do problema

313 Identificaç~o dos usuários em potencial

314 Identificaç~o das fontes de dados

315 Definiç~o dos requisitos dos documentos

a) Estudo dos documentos de entrada

f!~sa:í.da

b) Restriç~es/requisitos

relaciona-dos com o manuseio dos

documen-tos

14 Mesmo que 0:1 gnJSSCl modo, a n.i.velde dívu Lqaç ão

.intt~rn~J.,podemos ter o .ini c:_{Lo da} tiDocurneritaç~o da

Descrir;~c:)Furic ín a Iti

(53)

c) Auditoria/procedimentos legais

d) Segurança/confiabilidade dos

dOCUmE?ntos

e) Impactos na infra-estrutura

tc:?c:n()1ógLca

320 Avaliaç~o de Recursos Tecnológicos

321 Definiç~o de Parâmetros para o

1unciona-mento do sistema

322 Definiç~o de critérios operacionais

(infra-estrutura tecnológica)

323 Definiç~o de critérios para seleç~o e

aquisiç~o de tecnologia

,:I) Har'dwan?

b ) Softwan·?

c) Telecomunicaç~es

d) Interface com outros

equipamen-tos elou _{redes de computadores}

324 Verificaç~o dos impactos e

inconsistên-cia com a atual arquitetura de sistemas

da olr'ganizaç7:{o

325 Produç~o de recomendaçôes e

c:onsidera-ç~es sobre possível mudança na

arquite-tura de sistema e impacto no plano

es-tratégico de informática

15 Ln Lcí.o da "DCJcLtmentaç~odOE:; Detalhes Técnico~;"

(54)

326 Elaboraç~o das especificaç~es de

aquisiçâo

327 Recebimento das propostas de

forneci-mento

328 Avaliaçâo das propostas

329 Negociaçâo do contrato

330 Planejamento do Desenvolvimento

331 Detalhamento das atividades de

desen-volvimento

332 Avaliaçâo das qualificaç~es técnicas da

equipe

333 Elaboraçâo de cronogramas de

desenvolvi-mento

340 Análise de Viabilidade EconSmica

341 Estimitiva dos custos de desenvolvimento

e implantaçâo do sistema proposto

342 Estimativa do custo do sistema proposto

343 Estimativa do valor dos beneficios

cau-sados pelo sistema proposto

344 Avaliaçâo de impactos nâo quantitativos

345 Estimativa da relaçâo custo/beneficio do

sistema proposto

350 Revisâo e Aprovaçâo

351 Apresentaçâo e apreciaçâo geral do

pro-Jeto

399 Ponto de Revisâo

50 !80

_t

(55)

500 DESENVOLVIMENTO

510 Organizaç~o e Administraçâo

511 Organizaç~o do projeto

512 Definiç~o técnica e métodos de trabalho

513 Definiç~o da linguagem de programaçâo a

514 Definiçâo das ferramentas de apoio a

serem empregadas

515 Detalhamento do programa de trabalho

516 Treinamento da equipe em técnicas e/ou

ferramentas especificas

Projetos Lógicos 16

521 Projeto conceitual da base de dados

522 Projetos das transaçbes (operaçbes sobre

a base de dados)

523 Projeto de documentos de entrada e de

524 Definiçâo dos algoritmos e estrutura

para tratamento dos dados

525 Desenvolvimento de protótipo para

validaç~o da visâo do usuário

526 Avaliaç~o do protótipo

16 Início d<::i"Documentaçâo do Sist.ema" (r"efen::mt.eti

definiçào da base de dados)

(56)

527 Definiç~o dos critérios de aceitaç~o do

teste integrado de sistema pelo usuários

529 Revis~o e Aprovaç~o do Projeto Lógico

530 Projeto Fisico

531 Revis~o do projeto lógico da base de

da-532 Normali2aç~0 da base de dados

533 Determinaç~o dos métodos de acesso a

534 Definiç~o detalhada dos sub-esquemas,

arquivos e registros

535 Atualizaç~o nas descriçôes no dicionário

de dados

536 Identificaç~o das redundâncias com base

nas descriçôes do dicionário de dados

537 Definiçâo dos procedimentos de segurança

e recuperaç~o da base de dados

538 Especificaçâo da rede de

teleprocessa-mento

539 Definiç~o dos programas

]'.c.... 1.~::~_~ve.1..S

541 Definiç~o das rotinas de iteraç~o com

softwa~es gerenciadores de banco e dados

(57)

542 Codificaç~o de programas e rotinas 17

Documentaç~o de programas e rotinas 16

Criaç~o de arquivos para testes

545 Teste e aprovaç~o individual de

progra-546 Teste integrado do sistema

599 Ponto de Revis~o

700 IMPLANTAÇAO

20 21

711 Revis~o dos requisitos para instalaç~o

712 Encomenda de insumos e equipamentos

713 Preparo de instruç6es e procedimento

714 Identificaç~o das necessidades para

con-vers~o de dados e procedimentos

:J..7 In i.c:.loda IiDoc:u.mf:.~nt.d';;:~O dt·,:, RE:.,f(7~r"~~nc:.i.<::\ do Us;uÉ.!I"·:i.oII

In:Lcic) _do e d€~,

atuar sobre a base de dados)

(58)

715 Gerar check-list par~os procedimentos

716 Treinamento do pessoal de operaç~o

--'<7I .l.. I Planejamento do teste piloto

718 Definiç~o das responsabili~ades

rela-cionadas com o teste piloto e instalaçào

"710

I .1.. '} Ponto de Revisào

720 Teste Piloto

721 Preparo dos locais de instalaç~o de

(,~qu.i.pamen tDS

722 Recebimento e inspecç~o de insumos e

723 Execuç~o do teste piloto

724 Avaliaçào e correç~o de prDblemas

729 Ponto de Revisào

(59)

730 Instalaç~o

731 Transferência dos programas e rotinas

para as bibliotecas de produç~o

732 Execuç~o do primeiro ciclo completo do

sistema sob condiç~es reais

733 Acompanhamento do sistema

734 Compilaç~o de recomendaç~es para

aperfeiçoamento do sistema em fases

futuras

735 Preparaç~o de relatório final

736 Desativaç~o do sistema anterior

737 Liberaçâo da equipe

740 Acompanhamento e Auditoria

(60)

FERRAMENTAS CASE PARA DOCUMENTAR SISTEMAS

[) f.;urgiment.o de C{-iSE's :z:z _vem _mudar"

substancialmente a c~rtef.~ana1

desenvolver sist.emas ainda hoje utilizada pela maioria

das organizaçôes no Brasil.

Definindo um CASE, o professor Ysmar Viana afirma

f:5istf.:?mas,tais como análise e~-;truturada, tnodf?laqem df.:?

projet.o es"t:rutur"ado ou de de

software, com ferramentas de software que dâo suporte

22 Computer Aided Software Engineering,

sotware voltado para o apoio ao processo de

desenvolviment.o de sistemas.

Cit.ado por A. A. Fernandes SI, J. L. KLt<J 1er,

(61)

CASE: pr-opí c í.am os Sf?gL.lintes bE'nefícIose

a) tornar prático o uso das técnicas estruturadas;

b) melhorar a qualidade do software desenvolvido;

c) facilitar a adoç~o da prototipaç~o;

d) simplificar o processo de mahutenç~o dos softwares;

e) acelerar o processo de desenvolvimento;

f) permitir o desenvolvimento incrementaI do software;

g) reutilizar os componentes do software.

Quanto às funç~es típicas desempenhadas por estas

ferramentas, citamos:

I) Diagramaç~o: elaboraç~o de modelos de Entida-'

de-Relacionamento, de

Fluxos de Dados, Diagramas

Hieráqui-coa de mÓdulos, Projeto Estruturado,

etc.

II) f'~'rotDtipa(;~o~atravé~:; de especificaç~o rápida dE:~

telas e relatórios.

(62)

III) Manutençâo do BD~ o Banco de Dados do projeto está

centralizado num Dicionário de

Dados ónico, o qual contém as

estruturas de dados, os

proces-sos e os fluxos de dados.

IV) Verificaç~o de Erros: confer~ncia de erros de

sin-taxe, diagramas

inconsis-tentes ou incompletos, etc.

V) _{Geraç~o de Código: geraç~o} _total _ou _parcial _dos

códigos, a partir das

especifi-VI) Documentaç~o Automática: geraç~o da documentaç~o

do sistema.

Apesar de todos os beneficios acima citados,

existem alguns requisitos para que uma organizaç~o

possa utilizar da maneira mais proveitosa possivel

estas ferramentas:

1) exist~ncia de padr~es de desenvolvimento de

sistemas;

2) exist~ncia de suporte de administraç~o de dados;

3) exist§ncia de suporte de documentaç~o (um serviço de

biblioteca de sistemas e dados);

(63)

4) existªncia de uma metodologia de desenvolvimento de

sistemae. ;

5) exist3ncia de uma gerência central de metodologia;

Dentre as ferramentas CASE disponíveis no mercado

podemos destacar as seguintes~ 24

a) IEW - Information Engineering Workbench 2e

b) 1'1ulti·-Dado·::;

c) Analyst/Designer Toolkit

d) MosáicD

e) F'CS?-)

f) r.::·C··-CASE

24 Um resumo técnico destas ferramentas CASE pode ser

encontardo "Gelrência de ~-::'r-ojf2tosde Sistemaf,;lI;;por'

A. A. Fe'l'Tlandes&. .i , L..

c.

Kugler, Edíto r-a L.TC, 1989, páginas 51 53.

25 Uma excelente vis~o de como funciona e de qual a ~ll::Jral1q~?"l1ciado IEW pode ser· obtida em "Enq~?l1haria

MetodoJ.fJgia, Técn .íc a s e

Ferr-ament~ls"; de A. Feliciano Net(:),J. D. FLlrlan &

(64)

BIBLIOGRAFIA COMENTADA

.1- Administraç~o X Informática: Compativeis

Jo~o de OLIVEIRA JÚnior

Cartgraf Editora Ltda

Campinas

lê (:'?diç~o 1985 176 páginas

De urna rn•..",nI-:'?ir a rápida e ob íeti va , o autor

bLISCf.:if.:\pnó?sent.::u-um 11rot~?ir(j prá tií.co de apl icaç~cJ

iml-:'?dia ta", ·fornF.Kendo subs.i.cHos neces~jj.ár.io s pat··a

os dirigentes e pessoal de sistemas realizar todo

P1anf.ó?j<=''1rnento de in'formá t.Lc a d a I-:"?rnpnó?sa.t>.?I1trado

no "Plano Dixet.or dF.:~Infor·m<fit.ica", o autor' avança

seca e suscintarnente sobre detalhes, deixando

la-cunas vez por' ou t.ra. O capí tu 1o XV, dedicado ê:\D

"Plano de DC)cumF.?I1taç~o"é e>:t.remament.€'~ ol~iE.'f"ltad(..J

para O&M, deixando urna falsa atmosfera de que seja

fácil document.ar sist.emas computadDrizados.

(65)

2 Projeto Estruturado de Sistemas 26

Meilir PAGE-JONES

t'1cGt-at-J-Hi11

S~ll Paulo

1988 ~596 páginas

Como discípulo direto de Yourdon e DeMarco, o

autor consolida os conhecimentos sobre o título do

Lí vr o , ou seja,pl'"'ojetD estl~Llturc."H10 d(2 sistema.

Con!:~idero, P(",sso.:!\lm~?ntefalando, o mais completo

e, pr.incipalmE~nte, dídátí.c o Lí v ro !50bl'-e o tema.

Este livro trata, entre outros, dos seguintes

b::~(néH:;, a sé.~bel'"·,d Laq rama de estrutLw<:'i, diagl'"amas

de fluxo de dados, dicionário de dados,

ferramen-tas de m&?talinguagem, ac op l ament o , ct")es~~o entt-e

programas, e assim por diante.

26 TI~'ê\duzido do original ~?m ingl"ês "Thr~ PraticaI

Guide to Stl~Llctun2d Systems Des.i..~~ns", Your-don

Iric , , 19EiD

(66)

3 - Auditoria em Informática

Jo~o Marcos FANTINATTI

t1cGr,;~\J>J-Hi11

S2ío Paulo

1988 128 _páginas

Um livro especificamente orientado para a

au-ditoria de sistemas e que menciona muito

superfi-cialmente a documentaç~o como objeto de uma

inves-tigaçào de auditoria de sistema, sendo quase que

só voltado para a segurança dos dados e processos.

4 - O Computador e o Executivo: Um Diálogo Proveitoso 27

Susan WOOLDRIDGE e Keith LONDON

LTC Livros Técnicos Cientificas Editora S/A

1.§'\ ed.i.ç:~o 1.977 168 pt!ginas

27 TF'c~cluzidodo original €:-.'m .i.ngl-es"TheComputer

BUF'--vi.va I H"mdbook", 197:3

(67)

Um "best-sell(;?r" da área de informática durante anos, desde sua primeira ediç~o em in9l3s,

no inicio da década de 70. O livro foi escrito com

o objetivo de discorrer de maneira sincera e

direta sobre os conflitos emergentes entre a

c omun í.dade de u~5uário~:;('f! "os amigos do cornputa-:

dc:w", numa ép(Jc~:1em que o computador pêH·ec~a mais

um monstro que vinha para incomodar ai.nda mais a

vida dos executivos. ~ espantoso como os problemas

daquele tempo ainda hoje est~o presentes no

dia-a-dia das (,Jt'·ç;jani;;~açf.jf::~s,ç.wincipalmf:,mte no que diz

rE:.?!sp~:?it.o "'~1.(:\~targiados rf?sponsáveis pelos 50ft,·· wares em documentar corretamente seus produtos. ~

com certeza um dos livros mais detest.ado e temido

por anê'tli.stas e consul tores de ss í stema s

dE~sinte·-r·essados !:-?11latencier' sincel"'i::~ment!:-?,ttsnect-'?ssidades

n:,?aisdos u~~uát-i.c)!:.;,pois "isto dá rnuí to trabalho".

, ,

(68)

9 - Organizaç~oe Métodos Integrados à Informática

Jo~o Chinelato Filho

1986 284 páginas

Em resumo, o autor procura mostrar como o O&M

pode ser ótil à _{informática.} _{O livro} é dividido em

trªs partes. A primeira enfatiza os problemas

cul-turais, comportamentais, a importância da

organi-zaç~o e o perfil do analista de Organizaç~o,

Sis-temas & Métodos em consonância com a Era da

Infor-mática. A segunda parte enfoca e exemplifica a

im-portância dos instrumentos técnicos de O&M, a

s~":l.bE'r,os r'E'J.atót-ios,os gt"'áficosde infonnaç~o,

os gt-áficos d(~ organizaç~o, o quad ro de

distr'i-buiçâo do trabalho, o Layout, os formulários, os

manuais administrativos e um roteiro metodológico

pa ra an á 1iSE> dos sist.€õ'masadminist.rc!tivos. Já na

óltima parte (O&M e Informática Integrados)

apre-senta a informática e o CPD, a atuaç~o do analista

[ de O&M ] no CPD~ a abordagem estrutural, a

inte-graç~o e o consultor de O&M na informática.

(69)

6 - Datenbanksystemme: Aufbau und Einsatz

Joachim Niedereichhloz

F'hysiCêi\-"VSIr"1ag

Wül'-zburg..·..Wien

1983 260 páginas

Este livro tem por objetivo discorr"er sobre

os conhecimentos sobn? a concepç~o e

.í

rnpLant aç êro

de sistemas de bancos de dados, notadamente em

am-técnica, lançando bons conceitos sobre a

documen-taç~o da base de dados.

I

','

(70)

7 - Administraç~o de Sistemas de Informaç~o

Phillip EIN-DOR e Eli SEGEV

Edí.tCl!~a Campus

Rio de ~fan(;~ir(J

175 péginas

Um "tJest'-s(:?llet-" da ár'ea de sistemas" Este

livro discute e procura organizar sistematicamente

O!5 c onc eItos prDposta dos MIS

(M2\n2lgemE.'nt.Infor'mat.i.of'l Sys;t.E.'m~5),t.a ís como seus

ambümte, obi E.?tiVO, p,r-oieto , re!:.>ponsabi 1.idadc:? na

exec:uç~D, i.mplantaç~o e usuários finais.

(71)

8 - Análise Estruturada de Sistemas 28

Chris GANE e Trish SARSON

Rio de Janeiro

Um outro "best--s€~~lJ.er"da .área de c:\náJ.isE'de

sisb::masa ~ didaticamente a melhor cjbn:l.sobre o

E~s~tudo dinâm.ico da sistemas

computadorizados e o grande mestre dos DFDs

(Diagramas de Fluxo de Dados). Sua "ên fas€"",é

VD1tacla para a pre()cupa(;~o com os pt-ocesso~~ que

at.u am !50brce os d edos , Didatici::uTlente,o livro é

rico em exemplos do começo ao fim, principalmente

porque é praticamente todo dedicado a um E'studD de

caso de uma empresa distribuidora de livros,

sendo, portanto, rico em exemplDs.

2f:l Tradu~::ido do Ol~içJina1 ern ing l·e:;"Stt-uctured

Sys-tE?mS Analy~;is: TODls and Tc:-:chniquE?s",Prentice

HalJ., Lnc ; , 1979

(72)

9 - Kalkulation von Softwareentwicklungen

Otto HE~rTmann

R. Oldenbourg Verlag

t1i..inchf-:?n--W.ien

1983 240 páginas

o

titulo trata em detalhes da parte de

con-tr'olac:lot-iafinanceixa do det;envolv.í rnerit.o de sis--'

de computadorizados. Há capítulos que

merecem uma atenç~o especial, c orno sobre os

problemas junto aos cálculos dos custos (capitulo

111), análise das conseqi..i@ncias dos custos sobre o

de~3envDlvimento dos softwares (Cê:IPí.tUJ.OIV) e a

de uma es tr a tég iê\ de levant.ament.o

consistente de custos (capitulo VII).

(73)

10 - Projeto de Sistemas de Processamento da Dados

Donaldo de Souza DIAS e Giosafatte GAZZANEO

LTC Livros Técnicos Cientificos Editora S/A

FUo de Janf-:?iro

lê ediç~o= 1975 - 9ê reimpress~o: 1984 - 151 págs.

O livro é dividido em dois grandes blocos. O

prLme í.r-c trata da teoriC:i soblre a cons;truç;~c) dos

sistemas de processamento de dados, enquanto o

se-gundo bloco é dedicado a exemplos tirados de

atividades corriqueiras do cotidiano das empresas~

usando a t.f::,~ot-ia.1'1e5 ITI C) depoi,s de 15 anos, sua

abordagem continua útil. O capitulo 8 é dedicado es;p€'~ci'ficamE~n t.!:?à tê':\t-e'fa de documert t.aç~o de si

s--temas, mesmo que apresentando uma vis~o muito

rápida de) temC:i.

(74)

11 - Documentaç~o de Software 2~

,J. D. Loma x Edit.or-aCampus

F~ioch'.? Janei.r-o

198:::;' 74 páginas

E~.te Lívr-o contém a bc.if.;edo "esqueleto"

'for---mal dos cont.eúdos das documentaç~es padr-~es~ a

qual foi expandida e r-evisada neste t.r-abalho.Com

toda a vis~o de softwar-e da década de 70, 05 seus

pr-incfpios básicos, na minha opini~o, uma vez

am-pliados e contextualizados par-a a década 90 ainda

podem ser- muito útil.

29 Tr-aduzido do o r'igina I E!m inçJ]. ê=~ "Documesn tation of

Softwar-e Pr-oducts", NCC Publications, Manchester.,

197"1

(75)

12 - Program Design Concepts with Application in CaBOL

Andreas S. PHILIPPAKIS e Leonard J. KAZMIER

McGraw-Hill, Inc.

NevJ York USA

216 páginas

Pat-tindo da prE~tnissa que o 11;:itor conheça o

rn.íní.mo da J.inguaç~em COBDL, este Lí.v r o tr'ata da

"for-ma pr-of issicmal de dE?sign de sistemas, abor-"

dando pontos como a tradicional programaç~o

estru-turada, coes~o entre programas, o design dos

módu-los de programi:ils e sist('?mas e out.r aa técnicas e

algoritmos especificos do CDBDL em ambiente de

9 r-andc'?por·tf:'?

(76)

13 - Engenharia da Informaç~o:

Metodologia, Técnicas e Ferramentas

Acácia FELICIANO Neto, J.Davi FURLAN

&

Wilson HIGA

I"1c:Graw--Hi11

S~o Paulo

1988

Os td~s autor-es , todos consultores de

sis-temas, reúnem os conceitos básicos que fundamentam

a Engenharia da Informaç~o, tais como as técnicas

fundamentais de análise estrutrurada, de análise e

modelagem de dados para bancos de dados e de

de-senho estruturado, aliando-os às ferramentas

com-putadorizadas de apoio ao desenvolvimento de

sistemas (CASE ou CASA). Neste ponto, percebe-se a

mucíariça do tradicional enfoque da ccmst,..'uç::\1ode

sistemas voltados para o procedimento!funç~o para

o do tratamento aos dados (bancos de dados).

(77)

14 - Die Entwicklung von Software-Systemen:

Prinzipien, Methoden, Sprachen, Werkzeuge

He l mut BALZEfH

Bibliographisches Institut AG

Zü r Lc h SL.l:f..ça

1982

Este livro apresenta de maneira sistemática e

orcJenada urna v is~o 9 loba1 sob,'"eC)S funclamentos,

pr'ineí_pios, _métodos, 1inguagens .::50 e ferramen tas

de trabalho para o desenvolvimento de sistemas de

informaç~c.l c::omputadorizados.;.O tr<::ibaHloé muito

rico em detalhes, indicando as técnicas de análise

e projeto estruturado conforme o ciclo de vida do

S.istf-1ma.

30 Em destaque, as principais linguagens tradicionais

de ambiente de mainframe do fim da década de 70 e

ird.c:iode 80.

Documentação de sistemas computadorizados

DOCUMENTAÇAO

DE SISTEMAS

COMPUTADORIZADOS

,~.- .,-_.

'=l

EAE~:r-;:) - ". '.

_~_~:~~iic···k"l~=~··~···~·l

DOCUMENTAÇAO

DE

SISTEMAS

COMPUTADORIZADOS

E.~

I N D I C E

(3 E R A L

'A

_._---+

_.__ .__._----+

&

/

A

<;:

o

Na

o

CONTEUDD::

SISTEMA

E

IV)

o

&

t

c.

.í

o

&

_. .._----+

_t