1 / 8

MDDMS

MDDMS. Mark Down Documentation Management System August 2019. Topics. Problem Description. Motivation. General Approach Skills Contact Information. G.FAST. Problem Description. Markdown is the most commonly used markup language used by developers these days.

jbessie
Download Presentation

MDDMS

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. MDDMS Mark Down Documentation Management System August 2019

  2. Topics • Problem Description. • Motivation. • General Approach • Skills • Contact Information G.FAST

  3. Problem Description • Markdown is the most commonly used markup language used by developers these days. • We want to be able to give the flexibility to the developers and the documentation team to be able to build documentation for their projects • MDDMS is a documentation management system which allows the users to do the following. • Build documentation using simple markdown syntax • Version control the documentation • Manage all the documentation for different projects in a single location. • Integrate seamlessly with different applications like JavaFx, Web Applications and mobile applications G.FAST

  4. Motivation • There are many documentation systems available in the market like Flare, Adobe etc but as any software, it has limitations. • WYSIWYG is very friendly but the data gets stored in a custom proprietary format. • Portability is a major nightmare with existing applications. • Too much cost associated with enterprise documentation systems. • The application proposed will have the following advantages. • Documents build on this system could be easily ported to GitHub. • Integrating seamlessly within the applications. • Anyone with minimal experience can create professional documentation. • If we can integrate with grammarly or something similar would be an added advantage. • Reduce the operational expenses for any company including startup companies. • This tools provides an option to include documentation as a general practice in SDLC without getting experts involved. G.FAST

  5. General Approach • Build a web application with the following components • REST API Server • Web client • Mobile client • (Additional points if you could build re-usable web and mobile client code) • Security • Provide options of at least basic authentication. • Integrating with SAML would be really nice. • Plugin based architecture • It would be nice to be able to integrate with one version control system like Git and provide a plugin based architecture to be able to create a plugin with any third party version control systems G.FAST

  6. Skills • The following are the skillsets that would be nice to have • Angular or VueJS or React • Spring Boot/Loopback (REST API Server) • Ionic (Building web/mobile applications) • Git • Agile Methodology • Any choice of database, you can use file system to store the output files. • The tools and skills mentioned above are strictly suggestions, you have the flexibility to pick any technology you want to solve this problem. G.FAST

  7. Contact Information • Aravind Chennuru • Software Architect • Enghouse Networks • Aravind.Chennuru@Enghouse.com • Ashish Datwani • Professional Service Lead • Enghouse Networks • Ashish.Datwani@Enghouse.com G.FAST

  8. THANK YOU www.enghousenetworks.com

More Related