Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# Application Architecture
# Architecture and technical solutions
This document is a "living" document that is constantly updated. In its current form, it is only a rough framework that "can" be used as a basis for technical documentation of projects. The structure can and must be modified! The goal is to create a document that seamlessly integrates the design documentation with the rest of the project documentation. The author assumes no responsibility for the content of this document.
TV: NarsuMan
## Title
Version number
Classification (Secret / Public etc ..)
Responsible person
## Introduction
* Introduction to the document ..
## Overview
* Briefly introduce the product or item
* The task of this document is to give the next developer, for example, an understanding of how the product has been implemented (Source code alone is not enough)
* What kind of tools and environments are needed if you plan to develop the product further
## Technologies used
* JAVA / Java Script?
* HABA language
* Reasons why!
## Descriptions of product development environments
Describe at least the following:
* Development environment
* Test environment
* Execution environment
* Demo environment
In other words, how have those different environments been implemented in the project
## Tools used and their version numbers
* Translator for xyz v1.0.1
* debugger zky v2.05
* Firefox 123
* Reasons why!
## The most important technical solutions on which the product relies
* Used libraries / frameworks (JQuery v 23456, JAVA EE 8 + Spring ZZZ, React IO)
* Other jips and gimmicks
* Reasons why!
## General software architecture
*
* Services
## Interfaces
* [Example of living life] (https://virkailija.opintopolku.fi/koodisto-service/swagger/index.html)
## Description of the execution environment (production)
* How the product is run in production
* Deployment diagram
## Database descriptions
ER-Scheme
##
TBD