allucanget/calminer-docs
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initialize project documentation

Browse Source 
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:
zwitschi
2025-11-08 19:49:07 +01:00
commit ad56c3c610
23 changed files with 2203 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
templates/README.md Normal file
View File

@@ -0,0 +1,7 @@
# Templates for Documentation
This folder contains template files for various sections of the Calminer documentation. These templates serve as a starting point for creating consistent and comprehensive documentation across different topics related to the Calminer project.
## Available Templates
- [Requirements](requirements.md): A template for documenting the functional requirements of the Calminer system.