- 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.
19 lines
1.2 KiB
Markdown
19 lines
1.2 KiB
Markdown
# Glossary
|
|
|
|
## Terms
|
|
|
|
| Term | Definition |
|
|
| ---- | ------------------------------------------------------------------------------------------------ |
|
|
| API | Application Programming Interface, a set of rules and tools for building software applications. |
|
|
| ETL | Extract, Transform, Load; a process for moving and transforming data from one system to another. |
|
|
| UI | User Interface, the space where interactions between humans and machines occur. |
|
|
| UX | User Experience, the overall experience a user has when interacting with a product or service. |
|
|
|
|
## Project-Specific Terms
|
|
|
|
| Term | Definition |
|
|
| --------------- | ------------------------------------------------------------------------------ |
|
|
| CalMiner | The name of the mining data analysis system being developed. |
|
|
| Mining Scenario | A specific set of conditions and parameters used to analyze mining projects. |
|
|
| Multi-Tenancy | An architecture where a single instance of software serves multiple customers. |
|