Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Story]: Architecture Diagram #188

Closed
5 tasks
Tracked by #42
sumiat opened this issue Jul 11, 2023 · 1 comment · Fixed by #365
Closed
5 tasks
Tracked by #42

[Story]: Architecture Diagram #188

sumiat opened this issue Jul 11, 2023 · 1 comment · Fixed by #365
Assignees
Labels
project: grants.gov Grants.gov Modernization tickets
Milestone

Comments

@sumiat
Copy link
Contributor

sumiat commented Jul 11, 2023

Summary

Create an initial architecture diagram for the backend and frontend that will serve as a living document in the main repository.

This architecture diagram will allow:

  • stakeholders to understand the overall system design at a glance
  • the team to make complex concepts and relationships easier to understand
  • the team to show the system dependencies, interfaces, and interactions which will allow stakeholders to evaluate impact of design choices, identify risks, make informed decisions regarding system modifications, scalability, and future enhancements.
  • Use a tool that is version controlled, like mermaid.js
  • We would need host diagram or application diagram

Examples of a good place to start for level of depth:

User story

As a software architect, I want to create an initial architecture diagram for the backend so that I can have a visual representation of the system's structure, components, and their relationships.

Acceptance criteria

  • Create a living document to visually represent the architecture
  • Following individuals have approved:
  • Following individuals have been notified for option review and feedback
  • Diagram is created and stored in //TBD//
  • Secrets manager is defined in the architecture diagram

Describe the proposed testing strategy

No response

Screenshots and additional context

No response

Blocked by #222

@EOKENAVA
Copy link

EOKENAVA commented Jul 12, 2023

Example of Architecture Diagram - https://github.com/usds/justice40-tool/tree/main/docs/architecture

@EOKENAVA EOKENAVA moved this from Sprint Backlog to Blocked in Simpler.Grants.gov Product Backlog Jul 12, 2023
@sumiat sumiat moved this from Blocked to Sprint Backlog in Simpler.Grants.gov Product Backlog Jul 12, 2023
@widal001 widal001 added the project: grants.gov Grants.gov Modernization tickets label Jul 14, 2023
@SammySteiner SammySteiner self-assigned this Jul 20, 2023
@SammySteiner SammySteiner moved this from Sprint Backlog to In Progress in Simpler.Grants.gov Product Backlog Jul 20, 2023
@sumiat sumiat changed the title [Story]: Backend Architecture Diagram [Story]: Architecture Diagram Jul 20, 2023
@SammySteiner SammySteiner moved this from In Progress to In Review in Simpler.Grants.gov Product Backlog Jul 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
project: grants.gov Grants.gov Modernization tickets
Projects
Development

Successfully merging a pull request may close this issue.

5 participants