GuideAutomator: Automated User Manual Generation with Markdown

Detalhes bibliográficos
Autor(a) principal: Oliveira, Allan dos Santos
Data de Publicação: 2016
Tipo de documento: Trabalho de conclusão de curso
Idioma: eng
Título da fonte: Repositório Institucional da UFBA
Texto Completo: http://repositorio.ufba.br/ri/handle/ri/20947
Resumo: 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.
id UFBA-2_3d0af1324ca82a0ad334c2acb89bddd7
oai_identifier_str oai:repositorio.ufba.br:ri/20947
network_acronym_str UFBA-2
network_name_str Repositório Institucional da UFBA
repository_id_str 1932
spelling Oliveira, Allan dos SantosSouza, Rodrigo Rocha Gomes eSant'anna, ClaudioSilva, Bruno2016-11-03T14:31:11Z2016-11-03T14:31:11Z2016-11-032016-10-24http://repositorio.ufba.br/ri/handle/ri/20947Manual 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.Submitted by Rodrigo Souza (rodrigorgs@ufba.br) on 2016-11-01T16:46:18Z No. of bitstreams: 1 monografia-allan-versao-final.pdf: 2299351 bytes, checksum: 026d67f8db28b7b8a044de8135f4d92f (MD5)Approved for entry into archive by Vanessa Reis (vanessa.jamile@ufba.br) on 2016-11-03T14:31:11Z (GMT) No. of bitstreams: 1 monografia-allan-versao-final.pdf: 2299351 bytes, checksum: 026d67f8db28b7b8a044de8135f4d92f (MD5)Made available in DSpace on 2016-11-03T14:31:11Z (GMT). No. of bitstreams: 1 monografia-allan-versao-final.pdf: 2299351 bytes, checksum: 026d67f8db28b7b8a044de8135f4d92f (MD5)user manualuser guideGuideAutomator: Automated User Manual Generation with Markdowninfo:eu-repo/semantics/publishedVersioninfo:eu-repo/semantics/bachelorThesisDepartamento de Ciência da ComputaçãoUFBABrasilinfo:eu-repo/semantics/openAccessengreponame:Repositório Institucional da UFBAinstname:Universidade Federal da Bahia (UFBA)instacron:UFBAORIGINALmonografia-allan-versao-final.pdfmonografia-allan-versao-final.pdfapplication/pdf2299351https://repositorio.ufba.br/bitstream/ri/20947/1/monografia-allan-versao-final.pdf026d67f8db28b7b8a044de8135f4d92fMD51LICENSElicense.txtlicense.txttext/plain1345https://repositorio.ufba.br/bitstream/ri/20947/2/license.txtff6eaa8b858ea317fded99f125f5fcd0MD52TEXTmonografia-allan-versao-final.pdf.txtmonografia-allan-versao-final.pdf.txtExtracted texttext/plain45365https://repositorio.ufba.br/bitstream/ri/20947/3/monografia-allan-versao-final.pdf.txt99c6a9d1323d68f8858ea4ba54c634eeMD53ri/209472022-03-16 22:36:46.291oai:repositorio.ufba.br:ri/20947VGVybW8gZGUgTGljZW7vv71hLCBu77+9byBleGNsdXNpdm8sIHBhcmEgbyBkZXDvv71zaXRvIG5vIFJlcG9zaXTvv71yaW8gSW5zdGl0dWNpb25hbCBkYSBVRkJBLgoKIFBlbG8gcHJvY2Vzc28gZGUgc3VibWlzc++/vW8gZGUgZG9jdW1lbnRvcywgbyBhdXRvciBvdSBzZXUgcmVwcmVzZW50YW50ZSBsZWdhbCwgYW8gYWNlaXRhciAKZXNzZSB0ZXJtbyBkZSBsaWNlbu+/vWEsIGNvbmNlZGUgYW8gUmVwb3NpdO+/vXJpbyBJbnN0aXR1Y2lvbmFsIGRhIFVuaXZlcnNpZGFkZSBGZWRlcmFsIGRhIEJhaGlhIApvIGRpcmVpdG8gZGUgbWFudGVyIHVtYSBj77+9cGlhIGVtIHNldSByZXBvc2l077+9cmlvIGNvbSBhIGZpbmFsaWRhZGUsIHByaW1laXJhLCBkZSBwcmVzZXJ2Ye+/ve+/vW8uIApFc3NlcyB0ZXJtb3MsIG7vv71vIGV4Y2x1c2l2b3MsIG1hbnTvv71tIG9zIGRpcmVpdG9zIGRlIGF1dG9yL2NvcHlyaWdodCwgbWFzIGVudGVuZGUgbyBkb2N1bWVudG8gCmNvbW8gcGFydGUgZG8gYWNlcnZvIGludGVsZWN0dWFsIGRlc3NhIFVuaXZlcnNpZGFkZS4KCiBQYXJhIG9zIGRvY3VtZW50b3MgcHVibGljYWRvcyBjb20gcmVwYXNzZSBkZSBkaXJlaXRvcyBkZSBkaXN0cmlidWnvv73vv71vLCBlc3NlIHRlcm1vIGRlIGxpY2Vu77+9YSAKZW50ZW5kZSBxdWU6CgogTWFudGVuZG8gb3MgZGlyZWl0b3MgYXV0b3JhaXMsIHJlcGFzc2Fkb3MgYSB0ZXJjZWlyb3MsIGVtIGNhc28gZGUgcHVibGljYe+/ve+/vWVzLCBvIHJlcG9zaXTvv71yaW8KcG9kZSByZXN0cmluZ2lyIG8gYWNlc3NvIGFvIHRleHRvIGludGVncmFsLCBtYXMgbGliZXJhIGFzIGluZm9ybWHvv73vv71lcyBzb2JyZSBvIGRvY3VtZW50bwooTWV0YWRhZG9zIGVzY3JpdGl2b3MpLgoKIERlc3RhIGZvcm1hLCBhdGVuZGVuZG8gYW9zIGFuc2Vpb3MgZGVzc2EgdW5pdmVyc2lkYWRlIGVtIG1hbnRlciBzdWEgcHJvZHXvv73vv71vIGNpZW5077+9ZmljYSBjb20gCmFzIHJlc3Ryae+/ve+/vWVzIGltcG9zdGFzIHBlbG9zIGVkaXRvcmVzIGRlIHBlcmnvv71kaWNvcy4KCiBQYXJhIGFzIHB1YmxpY2Hvv73vv71lcyBzZW0gaW5pY2lhdGl2YXMgcXVlIHNlZ3VlbSBhIHBvbO+/vXRpY2EgZGUgQWNlc3NvIEFiZXJ0bywgb3MgZGVw77+9c2l0b3MgCmNvbXB1bHPvv71yaW9zIG5lc3NlIHJlcG9zaXTvv71yaW8gbWFudO+/vW0gb3MgZGlyZWl0b3MgYXV0b3JhaXMsIG1hcyBtYW5077+9bSBhY2Vzc28gaXJyZXN0cml0byAKYW8gbWV0YWRhZG9zIGUgdGV4dG8gY29tcGxldG8uIEFzc2ltLCBhIGFjZWl0Ye+/ve+/vW8gZGVzc2UgdGVybW8gbu+/vW8gbmVjZXNzaXRhIGRlIGNvbnNlbnRpbWVudG8KIHBvciBwYXJ0ZSBkZSBhdXRvcmVzL2RldGVudG9yZXMgZG9zIGRpcmVpdG9zLCBwb3IgZXN0YXJlbSBlbSBpbmljaWF0aXZhcyBkZSBhY2Vzc28gYWJlcnRvLgo=Repositório InstitucionalPUBhttp://192.188.11.11:8080/oai/requestopendoar:19322022-03-17T01:36:46Repositório Institucional da UFBA - Universidade Federal da Bahia (UFBA)false
dc.title.pt_BR.fl_str_mv GuideAutomator: Automated User Manual Generation with Markdown
title GuideAutomator: Automated User Manual Generation with Markdown
spellingShingle GuideAutomator: Automated User Manual Generation with Markdown
Oliveira, Allan dos Santos
user manual
user guide
title_short GuideAutomator: Automated User Manual Generation with Markdown
title_full GuideAutomator: Automated User Manual Generation with Markdown
title_fullStr GuideAutomator: Automated User Manual Generation with Markdown
title_full_unstemmed GuideAutomator: Automated User Manual Generation with Markdown
title_sort GuideAutomator: Automated User Manual Generation with Markdown
author Oliveira, Allan dos Santos
author_facet Oliveira, Allan dos Santos
author_role author
dc.contributor.author.fl_str_mv Oliveira, Allan dos Santos
dc.contributor.advisor1.fl_str_mv Souza, Rodrigo Rocha Gomes e
dc.contributor.referee1.fl_str_mv Sant'anna, Claudio
Silva, Bruno
contributor_str_mv Souza, Rodrigo Rocha Gomes e
Sant'anna, Claudio
Silva, Bruno
dc.subject.por.fl_str_mv user manual
user guide
topic user manual
user guide
description 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.
publishDate 2016
dc.date.submitted.none.fl_str_mv 2016-10-24
dc.date.accessioned.fl_str_mv 2016-11-03T14:31:11Z
dc.date.available.fl_str_mv 2016-11-03T14:31:11Z
dc.date.issued.fl_str_mv 2016-11-03
dc.type.status.fl_str_mv info:eu-repo/semantics/publishedVersion
dc.type.driver.fl_str_mv info:eu-repo/semantics/bachelorThesis
format bachelorThesis
status_str publishedVersion
dc.identifier.uri.fl_str_mv http://repositorio.ufba.br/ri/handle/ri/20947
url http://repositorio.ufba.br/ri/handle/ri/20947
dc.language.iso.fl_str_mv eng
language eng
dc.rights.driver.fl_str_mv info:eu-repo/semantics/openAccess
eu_rights_str_mv openAccess
dc.publisher.none.fl_str_mv Departamento de Ciência da Computação
dc.publisher.initials.fl_str_mv UFBA
dc.publisher.country.fl_str_mv Brasil
publisher.none.fl_str_mv Departamento de Ciência da Computação
dc.source.none.fl_str_mv reponame:Repositório Institucional da UFBA
instname:Universidade Federal da Bahia (UFBA)
instacron:UFBA
instname_str Universidade Federal da Bahia (UFBA)
instacron_str UFBA
institution UFBA
reponame_str Repositório Institucional da UFBA
collection Repositório Institucional da UFBA
bitstream.url.fl_str_mv https://repositorio.ufba.br/bitstream/ri/20947/1/monografia-allan-versao-final.pdf
https://repositorio.ufba.br/bitstream/ri/20947/2/license.txt
https://repositorio.ufba.br/bitstream/ri/20947/3/monografia-allan-versao-final.pdf.txt
bitstream.checksum.fl_str_mv 026d67f8db28b7b8a044de8135f4d92f
ff6eaa8b858ea317fded99f125f5fcd0
99c6a9d1323d68f8858ea4ba54c634ee
bitstream.checksumAlgorithm.fl_str_mv MD5
MD5
MD5
repository.name.fl_str_mv Repositório Institucional da UFBA - Universidade Federal da Bahia (UFBA)
repository.mail.fl_str_mv
_version_ 1808459527048134656

Registros relacionados