Files
calminer-docs/architecture
zwitschi 1af654de1f Add project documentation and architecture details
- Create .gitignore to exclude specific project files and directories.
- Add CONTRIBUTING.md with guidelines for contributing to the project.
- Update README.md to reflect changes in usage section and contact information.
- Introduce 08_concepts.md outlining cross-cutting concepts in the architecture.
- Add 02_data_model.md detailing the data model and relationships.
- Implement 03_security.md to describe security measures and practices.
- Establish 08_ui_design.md for user interface design principles.
- Document quality requirements in 10_quality_requirements.md.
- Identify risks and technical debts in 11_technical_risks.md.
- Create a glossary in 12_glossary.md for project-specific terms.
- Include about-arc42.md to explain the arc42 documentation template.
- Define price calculation variables and formula in price_calculation.md.
- Introduce ADR template in adr.md for documenting architecture decisions.
2025-11-09 13:17:19 +01:00
..
2025-11-08 19:49:07 +01:00

Architecture Documentation

This folder contains the architecture documentation for the Calminer project, following the arc42 template structure.

Chapters

  1. Introduction and Goals
  2. Architecture Constraints
  3. Context and Scope
  4. Solution Strategy
  5. Building Block View
  6. Runtime View
  7. Deployment View
  8. Concepts
  9. Architecture Decisions
  10. Quality Requirements
  11. Technical Risks
  12. Glossary

About

This documentation is based on the arc42 template for software architecture documentation.