Affordable Access

Online Markdown editor postavený na GIT / GIT Based Markdown Online Editor

Authors
  • sajdl, vojtěch
Publication Date
Jun 16, 2021
Source
Digital Library of the Czech Technical University in Prague
Keywords
License
Unknown

Abstract

Tato práce se zabývá tvorbou komplexního online nástroje pro podporu celého životního cyklu tvorby dokumentace za použití nástroje Git a jazyku Markdown. Jejím cílem je uspokojit potřeby různých uživatelských skupin, zejména pak autorů, korektorů a manažerů dokumentací. Výsledný systém by měl podporovat tvorbu dokumentací pro různé verze dokumentovaného systému a funkci zvýrazňování změn souborů. Vyvíjený systém byl určen pro integraci do stávajícího procesu dokumentace používaného firmou Stratox Enterprises s.r.o. - pro získávání informací o tomto procesu a použitých technologiích byl kontaktní osobou vedoucí práce. Systém bylo třeba integrovat s používanými technologiemi – zejména pak s hostingem GIT repositářů Gitlab a generátorem statických stránek Docusaurus. Vyvíjený systém měl být také nasazen na jejich vlastní platformě CodeNow. Jelikož Docusaurus podporuje všechny požadavky na výslednou podobu dokumentace, práce se zabývala zejména vývojem nástroje, který by umožnil snadnou editaci, zjednodušený proces korektury a správy dokumentací. Po dokončení prototypování a vývoje minimálního použitelného produktu bylo provedeno uživatelské testování. Jeho výsledky – zejména pak nalezené problémy a jejich řešení jsou následně v práci diskutovány. / This thesis focuses on creating a comprehensive online tool that supports the entire life cycle of software documentation creation, using GIT and Markdown at its core. It aims to satisfy the needs of multiple user groups, especially authors, proof-readers and documentation managers. The system should also support creation of documentations for different versions of the documented system and most importantly be able to highlight changed parts of the text. The developed system was aimed to be integrated with the existing documentation process used by Stratox Enterprises s.r.o. - the main source of information for this purpose was the thesis supervisor. The system was to be integrated with the technology that was already used - this means using the Gitlab repository hosting service and Docusaurus - the static page generator. Also, the system was to be deployed on the in-house developed CodeNow platform. As Docusaurus supports all the requirements imposed upon the resulting documentation, the focus was to create a tool, that would allow for easy file edit, simplified proof-reading process and management of the documentations. After prototyping and finishing the minimal viable product, user testing was conducted. Found problems and their solutions are also discussed.

Report this publication

Statistics

Seen <100 times