fev 10, 2012

Como documentadora eu ouço muito a célebre frase “Pra quê? Ninguém lê o que vocês escrevem mesmo…”. Levo na brincadeira, dou risada junto. Mas é claro que eu sei que a realidade é essa mesmo – quase ninguém lê manual… até a hora que precisamos resolver um problema. E, nesse momento, eu faço questão de fazer a diferença para o meu...

jan 26, 2012

O Darwin Information Typing Architecture (DITA) é um modelo de dados XML padrão OASIS destinado a autoria e publicação (Wikipedia). Confuso? Então vamos simplificar. O processo de documentação em DITA é aquele em que a informação é dividida em pequenos tópicos que, por si mesmos, podem ser compreendidos. Cada um deles explica uma tarefa, um conceito...

jan 3, 2012

Houve um tempo em que eu produzia por volta de 60-80 páginas de documentação por semana. Eram páginas e mais páginas que descreviam reuniões de levantamento de escopo de software com clientes. Normalmente pessoas de várias nacionalidades, todas juntas numa sala de reunião debatendo “o que eu tenho hoje” versus “ o que nós podemos fazer por...

dez 12, 2011

O seu projeto de documentação baseia-se em (a) descrever todos os bits and bytes numa tela; (b) fazer com que todas as telas apareçam no manual; (c) ter um bom manual que ensina tudo, até como digitar o nome de usuário e senha? Você gasta demais com revisão do material e tradução a cada nova versão lançada e, ainda assim, seus manuais nunca estão...

nov 17, 2011

Vou pegar o gancho de um artigo recente escrito por Luciano Pires, do Portal Café Brasil – para quem não conhece, eu recomendo a leitura. O artigo do Luciano fala sobre o atendimento recebido por ele quando ligou para o suporte do AdWorks® da Google. Fala do comprometimento e do senso de responsabilidade dos atendentes e de como ele ficou satisfeito e...

nov 1, 2011

Se você é daqueles gerentes de TI que pensam que documentação é uma questão de produzir os manuais de usuário em tempo para o release do seu software, pense de novo. Se você, na sua equipe, nunca ouviu falar da figura do redator técnico ou, se ouviu falar, acredita que essa figura seja totalmente dispensável, pense novamente. Se a sua equipe possui...