Skip to content

How to Contribute@ JSDoc Comment Document Page

Jump to bottom
JackTuxh edited this page Jun 11, 2020 · 1 revision

JSDoc Comment Page

Welcome to CartoGraphX!

CartoGraphX is a combination of a VS Code extension and a web application that provides software development teams with a way to visualize their coding projects! Our software utilizes the files in a project in order to create a map that helps developers understand the relationships between the files they are working in much like the one displayed below:

Insert image of map view

CartoGraphX keeps track of where team members are working and updates automatically to reflect changes made to files in VS Code

Who is CartoGraphX for?

We created CartoGraphX for software development teams. Our application is intended to help foster and grow a team environment through the use of code visualization.

Why do you need CartoGraphX?

How long do you spend trying to understand the files in a project before you actually begin working?

A visualized map of the source code rather than a high level description design document might make your life easier…

How long do you spend trying to understand code you didn’t write?

Knowing exactly who worked on which file and when would be nice wouldn’t it? We did that for you.

How often are you actually collaborating with your team in a remote setting?

Our platform allows you to take full advantage of your teammates, increasing general productivity.

What Inspired CartoGraphX?

Like any solution, CartoGraphX is a response to a problem, or rather a series of problems. The developers here at CartoGraphX got inspiration both from issues that have been affecting software development teams for a long time as well as other problems that have recently come to light with our current global situation. The problems that CartoGraphX hopes to mitigate are:

  1. Developers often don’t understand the full scope of the projects they work on. Instead, they focus just on the area of the project where they write code and don’t pay much attention to the rest of the project. This is problematic because developers today are essentially trying to solve a problem with partial information. Our map provides software teams with an easier way of understanding the full scope of a project.

  2. Remote work has led to a lack of accountability where developers are left to manage their own time without much supervision. Additionally, with people now having to work from home, there are many more distractions that lead to a fall in productivity. In order to address these issues, our platform keeps track of where coders are working in real time. It places software developers on an “idle island” if code is left untouched for enough time when they should be working. This helps software developers to remain on task as seeing what their peers are doing will help them to maintain accountability. At the same time, this also helps team managers to monitor their developer’s behavior as well as help them to assess team progress throughout the development cycle.

  3. Software developers often have a hard time resolving bugs because they deal with code they didn’t write and therefore don’t completely understand. Our map keeps track of who worked in each file. This means that if a coder runs into an issue in a file or area of the program they don’t fully understand, they can easily see who worked on these files last and can contact them to get help!

  4. Remote working has decreased team interaction further because people are no longer forced to see each other everyday. This is problematic because it affects team morale and reduces team communication in general. CartoGraphX aims to help keep teams connected by providing a platform where teams can work simultaneously.

npm module

Clone this wiki locally