memeLab/Jandig

Improve Jandig's Software Architecture Document

Closed this issue · 2 comments

Refactoring Proposal

Describe the design issue(s) you have identified in the code
The present Software Architecture Document that lays in Jandig documentation present some lacks of information and some missing topics that would be enriching to the document, such as "Architectural Representation" and "Implementation View.

Some of the document's artifacts could also be improved, such as the logic view diagrams.

Which source files are affected to this issue(s)?

  1. docs/architecture-document.md;

Describe refactoring alternatives to redesign the code

  1. Improve architectural representation topic;
  2. Improve the existing diagrams;
  3. Describe in more detail the use case view;
  4. Improve the package diagram;
  5. Write Implementation view;
  6. Reference the Plant UML source code in the doc;
  7. Organize the document better;
  8. Describe in more detail the technologies used in the project;
  9. Describe the actors present in the use case view;

Me, @gustavoduartemoreira and @VictorAmaralC referenced the Plant UML source codes in the architecture document, so the future improvements in these documents should be made on the source code for each diagram.

The path for the diagrams source code is: docs -> images -> plantUML.

Thank you @Gabrielle-Ribeiro, @gustavoduartemoreira and @VictorAmaralC for the support on the issue.

A few days ago we talked to @pablodiegoss and he said that it would be beneficial for the project if the uml diagrams could be editable in the docs 😃