search

iVis-at-Bilkent / software-artifact-analyzer

SAA: A tool to visually analyze varying software artifacts including source code files, pull requests, issues, and commits, as well as their links and their relationships with developers in a software project to improve the software development process
0 stars 0 forks source link

Update Developer Guide and User Guide #122

Closed LaraMerdol closed 1 month ago

LaraMerdol commented 4 months ago

The landing flow changes, now users install the respective GitHub and Atlassian apps from the marketplaces and then directed to the SAA application. Before updating guides we should decide on

  1. Github and Atlassian apps are special to SAA core applications so other feature applications will need new applications. In the developer guide, we should discuss it.
  2. For the user guide users should install applications first. We should publish the Atlassian app on the market.
  3. After those deciosn made we can update the document respectively.
LaraMerdol commented 1 month ago

As part of improving the project documentation, we need to create comprehensive developer and user guides. This will help both developers working on the project and end-users to understand how to use and contribute to the software effectively.

Developer Guide: Outline the structure of the developer guide. Cover the project setup process. Explain the architecture and design principles. Document coding standards and best practices. User Guide: Outline the structure of the user guide. Provide step-by-step instructions for installing and using the software. Include an explanation about all core functions Detail any configuration options or settings.

LaraMerdol commented 1 month ago

Develoepr Guide:

New section added explaining how users can create GitHub and Atlassian applications for use by other users. Link: here

User Guide

Case tools integration flow will be discussed. Context menu changes added and also UI updated Screenshots updated (I left them if they are not related to related change) (expert recommendation - issue type) Updated features discuss. Link: here