A Documenta O De Software

Fó ru n s i Ma ste rs

7 Ma ste rs

/DESIGN

R e vi sta i Ma ste rs

Fe rra me n ta s

/DESENVOLVIMENTO

C u rso s o n l i n e

/BANCO DE DADOS

Ag e n d a

In te rC o n

D e ve l o p e rWe e k Vi tó ri a ­ES



/MARKETING DIGITAL





Twitter

Po rta l

A documentação de software ­

Facebook

27/02/2015

A documentação de software
Paulino Michelazzo em Desenvolvimento



Compartilhar

...



Tweetar

...



Google +

0



Linkedin

...

Necessidade ou preciosismo? A documentação de software, mesmo sendo o carma de qualquer desenvolvedor, é extremanente necessária e auxilia na redução de horas preciosas na correção de problemas. Neste primeiro momento, vamos ver o que é a documentação de um sistema, suas partes principais e também as ferramentas que auxiliam desenvolvedores a fazer desta uma tarefa menos maçante.

Para muitos desenvolvedores, a criação de documentação técnica é a parte mais aterrorizante para se enfrentar em todo o processo de criação de um software, seja pela necessidade de escrever várias e várias páginas de texto, gráficos e desenhos ou ainda pela necessidade de largar aquilo que se aprendeu (programar) para fazer aquilo que não sabe bem (redigir).

Entretanto a documentação é parte integrante de qualquer sistema ou programa criado. Arrisco a dizer inclusive que a documentação é tão importante (ou mais) que as questões de segurança pois sem a devida documentação, bug’s e pontos vulneráveis no sistema demoram a ser encontrados e corrigidos, permitindo assim que os ataques continuem levando à falência múltipla do sistema e, consequentemente, de seu usuário. Normalmente, em grandes corporações existem pessoas e/ou equipes voltadas única e exclusivamente para a criação de documentação, sendo http://imasters.com.br/artigo/4371/gerencia­de­ti/a­documentacao­de­software/ 1/12

27/02/2015

A documentação de software ­

que o desenvolvedor fica restrito à codificação e comentários de seu código. Já no mundo "real", esta atividade é