Intrinsically Fascinating MarkDown: conversão de arquivos MarkDown para PDF utilizando tecnologias web

Abstract

O presente produto teve como objetivo produzir uma ferramenta para a criação de documentações de projetos de software, com intenção de aproveitar conhecimentos já adquiridos por desenvolvedores ao longo de suas carreiras. Sendo uma aplicação de terminal, o público-alvo se restringe a desenvolvedores com experiência em desenvolvimento e metodologias ágeis. O produto permite a criação de documentações em PDF a partir de arquivos Markdown, além de possuir capacidade para personalização utilizando tecnologias web, como HTML, CSS e JavaScript, permitindo que as equipes que utilizarão o produto personalizem seu conteúdo de acordo com suas necessidades. O desenvolvimento foi guiado pelo padrão cascata, com objetivos, claros e concisos do começo ao fim, com modelagem utilizando diagramas UML para facilitar a visualização dos componentes. Para garantir qualidade no código produzido, foram feitos testes com automatizados com cerca de 80% de cobertura, além de testes com usuários qualificados para verificar a usabilidade. O produto foi publicado no GitHub e no NPM, gerenciador de pacotes do NodeJS.

The product has, as it is objective, produce a tool for creating documentation of software projects, with the intention of taking advantage of knowledge already obtained from developers in their carriers. Being a terminal application, the target audience is restricted to experienced developers with knowledge in agile methodologies. The product allows the creation of PDF documentations from Markdown files, and have customization capacity using web technologies, such as HTML, CSS and JavaScript, allowing teams to customize their documentations according to their needs. The development was driven by the waterfall development methodology, with clear and concise objectives from the start to finish, using UML diagrams to help visualize the components of the system. To guarantee quality o the code produced, automated testes with roughly 80% of coverage were done, and users tests were conducted to verify the usability of the product. The product was published on GitHub and on NPM, the NodeJS package manager.