Initialize project documentation
Add architecture documentation and functional requirements for Calminer project - Created Building Block View (05_building_block_view.md) detailing system architecture and component interactions. - Developed Runtime View (06_runtime_view.md) outlining key user scenarios and interactions within the system. - Established Deployment View (07_deployment_view.md) describing the infrastructure and mapping of building blocks to deployment components. - Added README.md for architecture documentation structure. - Introduced functional requirements (FR-001 to FR-010) covering scenario management, data import/export, reporting, user management, and collaboration features. - Included templates for documenting requirements to ensure consistency across the project.
This commit is contained in:
22
architecture/README.md
Normal file
22
architecture/README.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# Architecture Documentation
|
||||
|
||||
This folder contains the architecture documentation for the Calminer project, following the arc42 template structure.
|
||||
|
||||
## Chapters
|
||||
|
||||
1. [Introduction and Goals](01_introduction_and_goals.md)
|
||||
2. [Architecture Constraints](02_architecture_constraints.md)
|
||||
3. [Context and Scope](03_context_and_scope.md)
|
||||
4. [Solution Strategy](04_solution_strategy.md)
|
||||
5. [Building Block View](05_building_block_view.md)
|
||||
6. [Runtime View](06_runtime_view.md)
|
||||
7. [Deployment View](07_deployment_view.md)
|
||||
8. [Concepts](08_concepts.md)
|
||||
9. [Architecture Decisions](09_architecture_decisions.md)
|
||||
10. [Quality Requirements](10_quality_requirements.md)
|
||||
11. [Technical Risks](11_technical_risks.md)
|
||||
12. [Glossary](12_glossary.md)
|
||||
|
||||
## About
|
||||
|
||||
This documentation is based on the arc42 template for software architecture documentation.
|
||||
Reference in New Issue
Block a user