Please use this identifier to cite or link to this item: https://hdl.handle.net/10216/110193
Author(s): Diogo Filipe Dos Santos Ferreira
Title: Weaki Desktop App: a tool for agile software documentation
Issue Date: 2017-07-12
Abstract: Software documentation is an important aspect of software development but unfortunately nottreated as such most of the time. There are many known ways to document software and theseshould be adopted by the developers taking their work environment into account. The target audi-ence is the most important factor since it dictates the contents and structure of the documentationand assumes the pre-acquired knowledge of the reader. Documentation for the product's end-usershould be completely different to the one viewed by the development team for example.Agile development describes a mindset which focuses on doing only what is required when itis required. This can also be applied to documentation and there is a set of guidelines to followamong which reusability and simplicity stand out. These two guidelines can be interpreted as themost basic requirements for agile software documentation tools.Weaki is a cross-platform desktop application, based on the Electron framework, for agilesoftware documentation meant to extend its web version based on DokuWiki. Its principles arebased on weakly-typed wikis which means that the pages are structured but it is not enforced onthe user who has the freedom to gradually adopt stricter rules but with benefits. Running nativelyon the desktop brings many benefits such as direct access to the file system, integration with Gitand the ability to customize the application to the user.The application is developed with the use of agile methods in which at the end of each iteration,one week-long, there's palpable progress and reports on the situation. Starting by implementingthe core features of the web version of Weaki, at the end of 3 months it is expected to start workingfor the next month on refinements and extra-features such as integrating with Slack, GitHub andGoogle Drive. The results are then compared to the initial goals and the conclusions are taken.
Description: Uma aplicação multi-plataforma para documentação de software em ambiente agile desenvolvida em Node, Electron e React. Weaki foca-se em maximizar a reutilização ao, por exemplo, oferecer um sistema de páginas tipificadas reduzindo assim o esforço necessário aquando se pretende produzir diversas páginas semelhantes. Para além deste aspecto a aplicação também facilita o seu uso ao ter uma interface muito semelhante a outras aplicações usadas pelos developers tais como o editor de texto Atom e ao integrar com ferramentas como o Git.
Subject: Engenharia electrotécnica, electrónica e informática
Electrical engineering, Electronic engineering, Information engineering
Scientific areas: Ciências da engenharia e tecnologias::Engenharia electrotécnica, electrónica e informática
Engineering and technology::Electrical engineering, Electronic engineering, Information engineering
TID identifier: 201904667
URI: https://repositorio-aberto.up.pt/handle/10216/110193
Document Type: Dissertação
Rights: openAccess
Appears in Collections:FEUP - Dissertação

Files in This Item:
File Description SizeFormat 
243544.pdfWeaki Desktop App: a tool for agile software documentation1.01 MBAdobe PDFThumbnail
View/Open


Items in DSpace are protected by copyright, with all rights reserved, unless otherwise indicated.