TI CorporativaNão menospreze o usuário!

Não menospreze o usuário!

-

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 realmente atualizados?

Se você respondeu sim a pelo menos duas das questões acima, está na hora de você conhecer o Progressive Disclosure (liberação progressiva, em tradução livre) aplicado à documentação de sistemas.

Primeiro lembre-se que documentar um software não se trata somente de escrever manuais – documentação engloba nomes de campos, abas, telas, mensagens de erro, helps online, enfim, tudo aquilo que seja tecnicamente escrito para o seu usuário final.

Segundo lembre-se que um bom redator técnico é meio caminho andado para ter êxito na documentação do seu sistema.

Tendo tudo isso em mente, determine as “camadas” de informação que você providenciará ao seu usuário. Por exemplo, na primeira camada, teremos os nomes dos campos e de todos os outros elementos na tela, incluindo algumas frases que possam resumir o propósito de uma certa janela ou aba (chamados help grids). Esta primeira camada deve ser simples, bem estruturada e clara, o que significa que você deve fugir das abreviações e das siglas o máximo possível.

Na segunda camada teremos o hover text e o field help. Lembrando que estes também devem manter clareza e dar ao usuário uma visão do que se trata o campo, que tipo de informação ele espera e qual o resultado de escolher-se este ou aquele tipo de input. Aqui também poderíamos incluir as mensagens de erro, que sempre devem fornecer ao usuário qual a solução do problema, ou pelo menos definir exatamente onde ele pode encontrá-la.

Na terceira camada poderemos colocar o help online e os manuais que devem então ter seu foco alterado – não mais descreverão campos, telas e procedimentos indiscriminadamente, mas sim as tarefas que o usuário deseja efetuar (user goals). Neste momento pare e pense “onde o usuário quer chegar?” e esqueça-se do seu software. Não se permita cair na armadilha de descrever aquilo que o usuário vê na tela, mas sim procedimentos, referências e conceitos que o auxiliem a atingir um objetivo de negócio.

Neste contexto, qualquer mudança feita nos labels da interface (quase) não afetará sua documentação. As partes relativas a campos e outras entidades do tipo estarão bem na frente do cliente, ele não precisará correr atrás de explicações num manual. Com a correta aplicação do progressive disclosure, o usuário ganha rapidez, não perde o foco, e você e sua empresa ganham mercado e rentabilidade.

E você agora deve estar pensando: “mas isso é o paraíso!” Bom, nem tanto. Aplicar um processo de progressive disclosure bem estruturado depende de tempo, maturidade tanto do produto quanto de seus profissionais e processos de desenvolvimento, uma equipe engajada, e do buy-in da alta gerência. Engloba principalmente a alteração da maneira de pensar de sua equipe de documentação, testes e desenvolvimento. Enfatiza falhas nos processos do sistema, uma vez que cada um de seus profssionais passa a atuar com foco na maneira como o cliente vê o produto, e não mais com os olhos técnicos de quem simplesmente o desenvolve.

Com certeza é uma grande mudança… para melhor.

No fim das contas, aplicar, desenvolver e manter um processo desses prova que sua empresa não menospreza seu usuário final – faz dele o foco principal de seu produto.

Sarah Siqueira
Sou pós-graduada pela FGV em Gerência de TI. Já fui programadora, tradutora, revisora, e atualmente sou redatora técnica há mais de 11 anos. Aprendi inglês muito nova, e descobri a redação técnica meio que por acaso, através de um anúncio de multinacional que precisava de alguém que escrevesse bem em português e inglês e tivesse disponibilidade para viagens. Lá trabalhei por 7 anos, viajei por todos os continentes, aprimorei técnicas, e entrei em contato mais profundo com o ciclo de vida do desenvolvimento de software no Brasil. Hoje sou líder de desenvolvimento de informações na IBM, onde planejo os projetos de documentação do produto sob minha responsabilidde, desenvolvo conteúdo, reviso materiais, dou treinamentos, mentorizo equipes mais novas e auxilio no processo de globalização e de teste da interface com os usuários finais. Espero trazer a vocês bons insights sobre o mundo da documentação em TI.

Latest news

4 bons conceitos para apoiar a sua identidade de marca

No mercado, existem marcas que, ao falar seus nomes, rapidamente associamos com determinadas palavras que são boas para quem...

Estratégia de comunicação B2B para redes sociais: dos posts para as vendas!

Adaptar seu conteúdo permite experimentar diferentes maneiras de mostrar sua empresa de TI, os benefícios dos seus serviços e não ser tão repetitivo com algumas táticas.

IA para MSPs: como a inteligência artificial está transformando o mercado de serviços gerenciados

A Inteligência Artificial (IA) está desempenhando um papel crucial na transformação dos Prestadores de Serviços Gerenciados (MSPs). Mais do...

O que é integração de sistemas de RH e como ela facilita o trabalho?

A integração de sistemas de RH traz muitos benefícios, principalmente em termos de otimização do tempo e de recursos. Sem ela, diferentes plataformas podem gerar dados desconexos e difíceis de consolidar, o que pode levar a erros e à sobrecarga de trabalho manual.
Publicidade

Cibersegurança como pilar da resiliência empresarial: a abordagem estratégica dos MSPs

Na última década, a segurança cibernética deixou de ser um tema restrito às áreas de TI para se tornar...

ADDEE traz HaloPSA ao Brasil, apostando na eficiência para MSPs

Plataforma de atendimento e automação promete otimizar a gestão de serviços com funcionalidades integradas para todo o ciclo de vida...

Must read

4 bons conceitos para apoiar a sua identidade de marca

No mercado, existem marcas que, ao falar seus nomes,...

Estratégia de comunicação B2B para redes sociais: dos posts para as vendas!

Adaptar seu conteúdo permite experimentar diferentes maneiras de mostrar sua empresa de TI, os benefícios dos seus serviços e não ser tão repetitivo com algumas táticas.
- Advertisement -

You might also likeRELATED
Recommended to you