• Articles
• admin

Quem está animado para falar manuais do Usuário?

Olha, eu entendo. Mas se você é como eu, então você concorda que documentar processos & sistemas é essencial para qualquer organização sem fins lucrativos. É apenas uma questão de encontrar tempo para fazê-lo.

e por que não? A documentação nos economiza tempo a longo prazo. Isso nos poupa de reuniões desnecessárias & solução de problemas, capacitando a equipe a encontrar suas próprias respostas.

para não mencionar,é uma boa habilidade para ter. E é crucial para sustentar seu trabalho, se você & sua organização se separar.

tente reservar um tempo para fazer isso. As etapas abaixo devem ajudar a tornar isso o mais indolor possível…e se não, há um” brinde ” no final que você vai querer pegar.

Comece com um esboço.

Antes de digitar procedimentos e definições, considere a estrutura do seu documento. Quais são os tópicos que serão fáceis para a equipe seguir? E qual estrutura será fácil para você atualizar com o tempo?

Spoiler: este se torna seu Índice!

para example…my o manual do Salesforce da equipe é dividido principalmente por objetos. Mas dependendo da sua configuração, dividir tópicos por departamento ou função pode fazer mais sentido.

comece bem. Então, estreito.

seu manual é obrigado a ter detalhes específicos e instruções passo a passo. Basicamente, todas as coisas que nossos colegas continuam esquecendo.

mas uma boa documentação também dará uma visão útil e panorâmica de como seu sistema está organizado & por quê. Tenha isso em mente ao planejar seu esboço na Etapa 1.

p. s. eu recomendo diagramar seu modelo de dados. Você pode usar uma ferramenta gratuita como o Google Drawings ou criar algo em um documento do Word ou Powerpoint (usando formas & linhas). Não precisa ser chique!

defina todos os seus dados.

cada ativo tecnológico em seu banco de dados é uma manifestação de alguma “coisa” da vida real: seja uma pessoa (doadores, voluntários, etc…), transação (doação, doação, etc..), ou parceria (entrega do programa).

boa documentação irá preencher a lacuna entre o real e o técnico, definindo o que seus objetos & campos representam no mundo real.

Meta, eu sei.

instrua seus usuários.

seu manual do Usuário deve fazer duas coisas: definir e instruir.

se a equipe precisar executar tarefas em seu banco de dados – entrada de dados, atualizações de dados e até mesmo pesquisa – ajude-os, incluindo instruções passo a passo para essas coisas.

dica: listas numeradas & frases curtas são seu amigo aqui.

escreva tudo uma vez. Em seguida, apare, repetidamente.Todos nós conhecemos a dor de ler um manual que é longo, prolixo e sufocado no texto. Poupe os seus colegas. Faça o primeiro rascunho e planeje passar muito tempo cortando-o.

por quê? Porque menos é mais. E leva tempo para reunir documentação abrangente e eficaz, embora ainda seja concisa.

P. s. não estou dizendo para cortar as coisas por uma questão de brevidade. Estou dizendo que a documentação concisa é uma arte que não cai na primeira tentativa.

use o espaço em branco.

pense nisso em termos de UX (experiência do Usuário). Da mesma forma que você se preocupa com o fato de seu banco de dados ser amigável, Você também deseja que seu manual seja fácil de navegar.

quanto mais espaço em branco houver – o espaçamento entre/ao redor do texto-melhor. Considere também o tamanho da fonte, a altura da linha e o espaçamento entre marcadores.

use apenas capturas de tela onde você precisar.

as capturas de tela são fantásticas. Por que explicar algo para alguém quando você pode mostrá-lo também?

mas eu pessoalmente acredito que eles são um pouco de uma armadilha. Pelo menos quando se trata de documentação.

pense nisso. Se alguma coisa mudar na interface do seu sistema, você terá que voltar a pegar e substituir essas imagens. Eles também podem distrair de suas instruções escritas, especialmente se você se deixar levar.

é por isso que eu os Uso Principalmente para destacar algo que meus usuários poderiam perder.

🌟 mais Uma coisa que pode ajudar….

agora que temos nossos passos, é hora de começar a construir! Para ajudar, criei um modelo de manual do usuário que estou compartilhando com quem quiser – para o Microsoft Word ou Google Docs!

tudo que você precisa é de um endereço de E-mail. Para verificar e pegar sua cópia, siga este link.

como este é um blog de banco de dados, uma nota rápida! Ao se inscrever para receber o modelo, você também será adicionado à lista de E-mail do meu blog (que nunca compartilho com terceiros). Envio atualizações bimestrais e anúncios ocasionais, dos quais você pode optar por não participar a qualquer momento.