Mobile documentation application for Fab Academy projects

Abstract

Documenting the digital fabrication processes is a key part in the Fab Academy program, the Fab Lab community, and the Maker community in general. Specifically for Fab Academy, chronological documentation is preferred but it presents challenges for the students. This thesis presents a mobile application which aims to ease the documentation process by making it easy to add images and text to markdown text files which are directly sent to the Git repository which would be used to store the documentation regardless if this application was used.

A critical feature of the application is the ability to automatically compress images to a suitable size and link them in the markdown files. The application does not depend on any external services, in addition to GitLab, as it communicates directly with the GitLab API. In the case of Fab Academy, they use a self-hosted instance of GitLab. Thus, the application can be used to create, read and edit any text files in any GitLab repository.

We set the requirements for this application based on the identified difficulties and issues with the existing tools. The implementation of the application was evaluated against these requirements which for the significant parts were met. The mobile application and its source code is published with an open license and ready for use and further development.

Digitaalisten valmistusprojektien dokumentointi on keskeinen osa erityisesti Fab Academy -ohjelmaa, mutta myös Fab Lab -yhteisöä sekä laajempaa Maker-yhteisöä. Erityisesti Fab Academyn opiskelijalta odotetaan kronologista dokumentointia, joka kertoo yksityiskohtia opiskelijan työstä, eikä pelkästään esitä lopputulosta. Usein tämä kuitenkin tuottaa merkittäviä vaikeuksia opiskelijoille. Tämä diplomityö esittää ratkaisuna mobiilisovelluksen, joka mahdollistaa kuvien ja tekstin lisäämisen markdown-tiedostoihin helposti. Fabscribe sovelluksella nämä tiedostot saadaan lähetettyä suoraan valittuun Git-projektiin, jossa dokumentaatiotiedostot muutenkin säilytettäisiin. Mobiilisovellusta voi siis käyttää minkä tahansa GitLab-projektin tekstitiedostojen muokkaamiseen ja luomiseen.

Sovelluksen tärkeimpiä ominaisuuksia on sen kyky pakata kuvatiedostot sopivaan kokoon automaattisesti, sekä linkittää ne suoraan markdown-tiedostoihin. Sovellus ei ole riippuvainen mistään ulkoisista palvelusta, lukuunottamatta GitLabia sillä se kommunikoi suoraan GitLab API:n kanssa. Esimerkiksi Fab Academy käyttää omaa itse-ylläpitämäänsä GitLab-instanssia. Asettamamme vaatimukset mobiilisovellukselle perustuvat sekä dokumentaatioprosessin tunnistettuihin haasteisiin että olemassa olevien työkalujen ongelmakohtiin.

Mobiilisovelluksen toteutus arvioitiin näiden asetettujen vaatimusten perusteella, ja ne täyttyivät oleellisilta osin. Mobiilisovellus sekä sen lähdekoodi on julkaistu avoimella lisenssillä, ja se on valmis käytettäväksi sekä jatkokehitettäväksi.