Skip to content

Commit bf7cf4e

Browse files
committed
doc: add arc42 template to readme
1 parent d0f679e commit bf7cf4e

1 file changed

Lines changed: 21 additions & 1 deletion

File tree

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,31 @@ This is a template for creating Python projects. It includes a basic project str
2828
code .
2929
```
3030

31-
3. **Reopen in Container:**
31+
3. **Reopen in container:**
3232
- Press `F1` to open the command palette.
3333
- Type `Remote-Containers: Reopen in Container` and select it.
3434
- VS Code will build the Docker container defined in the `.devcontainer` folder and open the project inside the container.
3535

3636
## Additional features
3737

3838
* [Dev Container Feature](https://containers.dev/features)
39+
40+
## Documentation
41+
42+
Some documentation description
43+
44+
### Requirements and architecture documentation
45+
46+
This project uses [arc42](https://docs.arc42.org/home/) to document the requirements and architecture:
47+
- [Introduction and Goals](docs/arc/introduction.md)
48+
- [Architecture Constraints](docs/arc/constraints.md)
49+
- [Context and Scope](docs/arc/context.md)
50+
- [Solution Strategy](docs/arc/strategy.md)
51+
- [Building Block View](docs/arc/building_block.md)
52+
- [Runtime View](docs/arc/runtime.md)
53+
- [Deployment view](docs/arc/deployment.md)
54+
- [Crosscutting Concepts](docs/arc/concepts.md)
55+
- [Architecture Decisions](docs/arc/decisions.md)
56+
- [Quality Requirements](docs/arc/quality.md)
57+
- [Risks and Technical Debt](docs/arc/risks.md)
58+
- [Glossary](docs/arc/glossary.md)

0 commit comments

Comments
 (0)