Add structural documentation to the project

dimasmith / iris

Playground. Service that integrates with banking and accounting systems and compares balances

0 stars 1 forks source link

Add structural documentation to the project #32

Open dimasmith opened 1 year ago

dimasmith commented 1 year ago

The iris application should have documents that describe the structure and architecture of the application. Desired documentaion should contain at least:

Structural diagrams of the application (e.g., C4 model)
Architectural decision records

yashkite commented 1 year ago

can you describe more about this i can document things well

what type of design should be
what element has to be showcased to make the use case more effective
do you like the dedicated documentation file or inside the code file as a comments