Escrevendo Manual do Usuário de Software no MS Word

1

Vou escrever um manual de usuário de software (escrito para Windows) para um software que escrevemos para nosso cliente. O manual precisa ser o mais detalhado possível. Eu vou usar o MS Word 2010 para escrever o manual.

Eu pretendo colocar um monte de screenshots de várias janelas do software e anotar nas imagens. O tamanho da página precisa ser A4 para que os usuários também possam tirar impressões facilmente. O problema é que, se eu tirar screenshots em tela cheia (o software pega a tela inteira, exceto a barra de tarefas) e tentar encaixá-las em papel tamanho A4, muitos textos nas janelas, bem como anotações, podem ser dificilmente legíveis.

Para facilitar as coisas para os usuários, estou pensando em colocar links no manual e embed capturas de tela na palavra. Clicar no link deve abrir a imagem incorporada vinculada em tela cheia. Os usuários devem poder voltar ao manual com ou sem fechar a imagem.

O problema é que não sei se isso pode ser feito no Word. É possível? Se não, existe alguma abordagem alternativa / melhor?

    
por Donotalo 29.11.2012 / 05:50

2 respostas

3

Eu realmente escrevi muita documentação técnica no Word. Não é a ferramenta que eu escolheria se tivesse uma escolha livre, mas os escritores de tecnologia geralmente não o fazem.

O que você está falando certamente é possível - mas eu só posso dizer isso quando fizer algumas suposições sobre como você vai entregar o manual. Se você planeja entregar o manual como um PDF e colocar essas capturas de tela externas na Web, é possível fazê-lo. O Word 2010 permite incorporar links de URL em qualquer parte do documento. Esses links são preservados quando você salva o arquivo como PDF.

Acho que você está fazendo uma suposição ruim aqui, e isso é que uma captura de tela precisa mostrar a janela inteira do aplicativo. Costumo capturar apenas o suficiente da janela para que o usuário possa identificar a mesma coisa em seu próprio monitor.

Você não perguntou sobre softwares, mas vou recomendar alguns de qualquer maneira. No Windows, o SnagIt é a ferramenta indispensável de captura de tela. Sempre foi bom e só melhorou ao longo dos anos. O mecanismo de captura continua ficando cada vez mais poderoso e fácil de usar, e agora a maldita coisa vem com um editor de gráficos muito bom, o ideal para desenhar esses textos explicativos.

    
por 29.11.2012 / 07:26
4

Uma abordagem alternativa (que pode ou não ser viável com base em seu novo software) é brincar um pouco com as imagens.

  • Eles precisam de uma captura de tela completa ou você está tentando chamar atenção para um detalhe específico?
    Se não, talvez você possa cortar a imagem um pouco.

  • Você poderia reduzir a resolução do seu computador para tirar uma captura de tela com menos espaço desperdiçado ?
    Em vez de tirar a captura de tela em 1920x1080, tente usar 1024x768 (ou uma resolução um pouco maior / menor dependendo das suas preferências. Dessa forma, em vez de dimensionar muito a imagem para caber na página, seria necessário apenas uma ligeira reduzir a escala (ou até mesmo), tornando-o mais legível.

por 29.11.2012 / 06:41