Skip to content

Commit 7e308ef

Browse files
author
Erik Hofer
committed
Constraints
1 parent 710a6d9 commit 7e308ef

File tree

1 file changed

+27
-14
lines changed

1 file changed

+27
-14
lines changed

src/02_architecture_constraints.adoc

Lines changed: 27 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,32 @@
11
[[section-architecture-constraints]]
22
== Architecture Constraints
33

4+
.Technical Constraints
5+
[options="header",cols="1,2"]
6+
|===
7+
| Constraint | Explanation
8+
| Client | Code FREAK should be accessible on all kinds of systems. It is thus a web application that supports all modern browsers.
9+
| Execution environment | Deployment is possible via Docker. The application should also be runnable without Docker for development.
10+
| Third-party libraries | All third party software that is used must be https://itsfoss.com/what-is-foss/[FOSS] and compatible with AGPL-3.0.
11+
|===
412

5-
[role="arc42help"]
6-
****
7-
.Contents
8-
Any requirement that constrains software architects in their freedom of design and implementation decisions or decision about the development process. These constraints sometimes go beyond individual systems and are valid for whole organizations and companies.
13+
.Organizational Constraints
14+
[options="header",cols="1,2"]
15+
|===
16+
| Constraint | Explanation
17+
| Organizational framework | Rudementary version of Scrum. Sprints are usually 2 weeks.
18+
| Changing team members | The core team consists of university students. The usually only stay for months or few years.
19+
| Code repository | The code is hosted on GitHub: https://github.com/codefreak/codefreak
20+
| Distribution | Code FREAK is https://itsfoss.com/what-is-foss/[FOSS], licensed under AGPL-3.0.
21+
| Release schedule | Releases are currently made on demand. There is no strict release cycle.
22+
|===
923

10-
.Motivation
11-
Architects should know exactly where they are free in their design decisions and where they must adhere to constraints.
12-
Constraints must always be dealt with; they may be negotiable, though.
13-
14-
.Form
15-
Simple tables of constraints with explanations.
16-
If needed you can subdivide them into
17-
technical constraints, organizational and political constraints and
18-
conventions (e.g. programming or versioning guidelines, documentation or naming conventions)
19-
****
24+
.Conventions
25+
[options="header",cols="1,2"]
26+
|===
27+
| Constraint | Explanation
28+
| Architecture documentation | Terminology and structure based on arc42.
29+
| Code style | Rules are included in the repository and automatically enforced.
30+
| Semantic versioning | The main project and secondary repositories use https://semver.org/[semantic versioning].
31+
| Language | All code and documentation is written in English.
32+
|===

0 commit comments

Comments
 (0)