Home

User Guide

The ADA project contains several features capable of providing a thorough insight into the level of coupling, or interconnectivity between the components of a product. Here we try to give a more readable, pleasant and user-friendly experience into the different usages of ADA.

(Insert here landing page with sidebar open)

Before being able to see the analysis of a particular project, a user needs to enter the GitHub URL of a project together with the desired branch. By pressing on the "Analyse" button, the application redirects the user to the page where the final analysis shall be presented after the computation has finalised.

(Insert here page with graph view and menus)

Basic interactions:

• Navigation: Using the side menu, the user can go over the previous analysis of other projects by clicking on the owner, repository, branch and then snapshot. Once the user made a selection, the entire hierarchy shall get highlighted to denote the currently viewed snapshot.

(Insert here page with sidenav when highlighted)

• Graph: The graph canvas supports fundamental interactions such as node and edge selection, movement and highlighting. When a node or edge is selected, the Element Insight menu displays the information about the choice such as package and invocations. There are also more complex features that reside in the Graph Menu component, such as:

(Insert here picture with the graph menu extended showing all the options and include all the three features before querying on the graph)

• Layouts & Metric selection: There are several options for layouts; a few examples are circle, grid, doughnut. The user can also choose what metric to show on the graph which is going to affect the colour of the edges.
• Information hiding & edge colour coding: Sometimes project contain classes that are not coupled to any other component, so these can be excluded from the graph by toggling one of the options from the second section, as well as hiding edges that are below a specific metric value threshold. Edges are by default colour coded, but that can be toggled off as well.
• Node spacing: For cases when working on a big project, the nodes can be distanced to offer a more accurate view of the graph.

(Maybe insert here picture with the querying by package)

• Query: Classes can be queried independently in which case the element insight section provides information about them, or entire packages can be searched for which the result is colour coded classes based on the packages they pertain to.