Como documentar soluções/tecnologias complexas em T.I.?

Bom,

Fugindo um pouco (bem pouco) da escovação de bits e bytes que costuma ser os posts aqui, vou abordar um tema um tanto quanto apavorante na vida de um analista de informática.

ONDE ESTÁ A DOCUMENTAÇÃO DOS SEUS PROJETOS, DAS TECNOLOGIAS QUE VOCÊ IMPLEMENTA?
ESSA DOCUMENTAÇÃO É MANTIDA ATUALIZADA POR ALGUÉM?
ESSA DOCUMENTAÇÃO SERVIRÁ PARA O PRÓXIMO ENTENDER MAIS RAPIDAMENTE A SOLUÇÃO E GARANTIR A CONTINUIDADE DE NEGOCIO?De todas as empresas de T.I. que já trabalhei/prestei serviço/conhecí, nunca vi uma que consiga seguir à risca..

Embora existam N maneiras simples e conhecidas para documentar de forma simples e organizada aquilo que se faz (que geralmente sai do cérebro de analistas no dia-a-dia), muitas vezes o problema da não documentação nem parte da equipe técnica executora. Conheço casos em que a própria equipe gestora que não prevê tempo em cronograma de projeto para documentação, não fomenta a equipe com ferramentas/técnicas de documentação adequadas, e não exige com punho firme que a documentação seja minusciosamente elaborada…muito menos aloca uma pessoa operacionalmente para menter documentação..

A questão é que as equipes técnicas poderiam entregar muito mais, mas as equipes gestoras poderiam trabalhar melhor os os ítens mencionados acima…

Bom essa é minha humilde opinião, como diria o Franklin..

Segue algumas formas legais para documentação de infraestrutura de sistemas operacionais/redes/aplicações, etc.. Todos utilizaveis em ambiente 100% sofware livre..

BLOG – Jogue no Blog que você sempre terá onde recorrer quando não lembra algum procedimento, ou quando alguém lhe pergunta como faz “tal coisa”…

MediaWiki – Quem não conhece o estilão Wiki do WikiPedia? O MediaWiki é um tanto quanto simples de implementar, basta uma máquina Linux, o banco de dados e os pacotes baixados no próprio site oficial…
Para documentar é muito legal, além de ser simples de outras pessoas exercitarem “colaboração” nas páginas de documentação..
Vale ressaltar a importância de se estruturar bem a árvore de assuntos antes de iniciar as documentações, sempre linkando na página inicial os artigos e manuais que vão sendo publicados (estilo main menu).

gtk-recordMyDesktop – Muita gente não conhece essa poderosa ferramenta para gravação da área de trabalho… Geralmente utilizo ela em Linux, pra executá-la em outros sistemas operacionais, basta adequar as libs do GTK. Ela possibilita inclusive a gravação de som através de microfone junto com o vídeo. Da pra fazer uns tutoriais legais…

freemind e xmind – Fluxograma é coisa do passado? Pode ser que o nome sim, mas a idéia dos Mapas Mentais continua firme e forte simplificando o raciocínio a cerca de estruturas complexas. Pra que dificultar se podemos facilitar?

Era isso… Utilizando esse conjunto de técnicas acima, com um pingo de criatividade / organização / disciplina, é possível documentar em tempo real tudo o que se faz no dia-a-dia de Infraestrutura. Se fizermos o mínimo de nossa parte como técnicos, poderemos exigir melhores condições de planejamento da parte da equipe gestora dos projetos 😉

A todos eu desejo um ótimo início de 2010.

Por: Hudson Murilo dos Santos

Referências:
Dias de trabalho com o Franklin;
Experiência em diversos ambientes não documentados;
Professores do curso GerProTI;
As demais referências foram linkadas no nome dos produtos de software;