Skip to content
Snippets Groups Projects
Commit ede08de2 authored by Cloud User's avatar Cloud User
Browse files

Värit uusiksi ja hakemistojen uudelleen nimeäminen

parent 36a4ab1f
No related branches found
No related tags found
No related merge requests found
Pipeline #437305 passed
# 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
# Software/Service Architecture
# Software architecture
Tämä dokumentti on "elävä"-dokumentti, joka päivittyy jatkuvasti. Se on nykymuodossaan vain karkea runko, jota "voi" käyttää projektien teknisen dokumentoinnin pohjana. Rakennetta saa ja pitää muokata! Tavoitteena on luoda dokumentti, joka yhdistää suunnitteludokumentaation saumattomasti yhteen projektin muun dokumentaation kanssa. Tekijä ei ota mitään vastuuta dokumentin sisällöstä.
## Software architecture thought like Zachman
tv:NarsuMan
* Framework and 4+1 View Model
* Reference Model for Open Distributed Processing (RM-ODP)
## Otsikko
Versionumero
1. Enterprise viewpoint --> Business Case
2. Information viewpoint -- >
3. Computational viewpoint
4. Engineering viewpoint
5. Technology viewpoint
Luokittelu (Salainen/Julkinen etc..)
Vastuuhenkilö
## Johdatus
* Johdatus dokumenttiin..
## Yleiskuvaus
* Esittele lyhyesti tuote tai kohde
* Dokumentin tehtävä on avata esim. jatkokehittäjälle käsitys siitä miten tuote on toteutettu (Pelkkä lähdekoodi ei riitä)
* Millaisia välineitä/työkaluja ja ympäristöjä tarvitaan, jos aioitaa kehitää tuotetta eteenpäin
## Käytetyt teknologiat
* JAVA / Java Script ?
* HABA kieli
* Perustelut miksi!
## Tuotekehitysympäristöjen kuvaukset
Kuvaa ainakin seuraavat:
* Kehitysympäristö
* Testausympäristö
* Ajo/suoritusympäristö
* Demoympäristö
Eli miten nuo eri ympäristöt on toteutettu ko. projektissa
## Käytetyt työvälineet ja niiden versionumerot
* Kääntäjä xyz v1.0.1
* debuggeri zky v2.05
* Firefox 123
* Perustelut miksi!
## Tärkeimmät tekniset ratkaisut joihin tuote nojaa
* Käytetyt kirjastot(library)/kehikot(Framework) (JQuery v 23456, JAVA EE 8 + Spring ZZZ, React IO)
* Muut jipot ja kikat
* Perustelut miksi!
## Yleinen ohjelmsto arkkitehtuuri
*
* Palvelut
## Palvelujen/n rajapinnat (Interfaces)
* [Esimerkki elävästä elämästä](https://virkailija.opintopolku.fi/koodisto-service/swagger/index.html)
## Suoritysympäristön (tuotanto) kuvaus
* Miten tuote ajetaan tuotannossa
* Sijoittelunäkymä (Depoyment diagram)
## Tietokantakuvaukset
ER-kaavio
##
TBD
* Link Jari Suni here :)
\ No newline at end of file
# Solution Acrhitecture
Describe how you solve a customers problem with our solution!
site_name: Open Project Framework (OPF 0.5) - project environment
site_name: Open Project Framework (OPF 0.6) - project environment
site_url: http://open-project-framework.pages.labranet.jamk.fi/opf-virtual-company-v1/core/
site_author: NarsuMan
......@@ -21,7 +21,7 @@ markdown_extensions:
theme:
name: 'material'
palette:
primary: 'black'
accent: 'black'
primary: 'cyan'
accent: 'cyan'
logo:
icon: 'assignment'
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment