GuideAutomator: Automated User Manual Generation with Markdown

Abstract

Manual de usuário, também conhecido como guia de usuário, é um documento técnico de comunicação projetado para dar assistência a usuários finais de um produto. Tem como objetivo preencher o abismo entre o que é facilmente dedutível e o que não é. Um fator complicador para aqueles que escrevem tais documentos é mante-los atualizados com mudanças na aplicação ao decorrer do tempo, como adições/remoções de funcionalidades ou somente mudanças nas interfaces de usuário (documentadas como capturas de tela). Este trabalho busca auxiliar escritores de tais documentos, somente para aplicações web, provendo captura de tela automática, reduzindo custo de manutenção e inconsistência do manual de usuário. Esse trabalho apresenta GuideAutomator, uma ferramenta que permite essa automatização através da escrita de documentos na sintáxe Markdown e do encapsulamento do Selenium Web Driver. Em um experimento piloto, GuideAutomator apresentou um desempenho inferior ao das ferramentas tradicionais quando construindo manuais de usuário a partir do zero para usuários inexperientes, no entanto mostrou sinais de um melhor desempenho para uso a longo prazo.

User manual, also known as user guide, is a technical document of communication designed to assist end users of a product. It aims at filling the gap between what is easily deductible and what is not. A complicating factor for those who write these documents is to keep them up-to-date with changes on the application over time, like addition/removal of features or just changes on user interfaces (documented as screenshots). This work aims at assisting writers of such documents, for web applications only, providing automated screen capture, reducing maintenance cost and user manual inconsistency. This work provides GuideAutomator, a tool that enables this automatization through writing of documents under Markdown syntax and encapsulation of Selenium Web Driver. In a pilot experiment GuideAutomator has been found to have a lower performance than traditional tools when building user manuals from scratch for an inexperienced user, however it presented signs of better performance on long term usage.