diff --git a/src/02_product-documentation/01_requirements.tex b/src/02_product-documentation/01_requirements.tex deleted file mode 100644 index d29761c2ead540b644afa2b17a5b923548eb2695..0000000000000000000000000000000000000000 --- a/src/02_product-documentation/01_requirements.tex +++ /dev/null @@ -1,3 +0,0 @@ -\chapter{Requirements} - \input{02_product-documentation/01_requirements/01_functional-requirements} - \input{02_product-documentation/01_requirements/02_non-functional-requirements} diff --git a/src/02_product-documentation/03_architecture.tex b/src/02_product-documentation/03_architecture.tex deleted file mode 100644 index 7290a63341c1a86cb9c6807680b1ada08a34de98..0000000000000000000000000000000000000000 --- a/src/02_product-documentation/03_architecture.tex +++ /dev/null @@ -1,7 +0,0 @@ -\chapter{Architecture} - This chapter explores the main structure of the project. - - \input{02_product-documentation/03_architecture/project-architecture} - \input{02_product-documentation/03_architecture/c4-diagrams} - \input{02_product-documentation/03_architecture/data-flow} - \input{02_product-documentation/03_architecture/toolstack} diff --git a/src/02_product-documentation/architecture.tex b/src/02_product-documentation/architecture.tex new file mode 100644 index 0000000000000000000000000000000000000000..720fb40b99153fc1cd8d7518650095158116a483 --- /dev/null +++ b/src/02_product-documentation/architecture.tex @@ -0,0 +1,7 @@ +\chapter{Architecture} + This chapter explores the main structure of the project. + + \input{02_product-documentation/architecture/project-architecture} + \input{02_product-documentation/architecture/c4-diagrams} + \input{02_product-documentation/architecture/data-flow} + \input{02_product-documentation/architecture/toolstack} diff --git a/src/02_product-documentation/03_architecture/c4-diagrams.tex b/src/02_product-documentation/architecture/c4-diagrams.tex similarity index 100% rename from src/02_product-documentation/03_architecture/c4-diagrams.tex rename to src/02_product-documentation/architecture/c4-diagrams.tex diff --git a/src/02_product-documentation/03_architecture/data-flow.tex b/src/02_product-documentation/architecture/data-flow.tex similarity index 100% rename from src/02_product-documentation/03_architecture/data-flow.tex rename to src/02_product-documentation/architecture/data-flow.tex diff --git a/src/02_product-documentation/03_architecture/project-architecture.tex b/src/02_product-documentation/architecture/project-architecture.tex similarity index 100% rename from src/02_product-documentation/03_architecture/project-architecture.tex rename to src/02_product-documentation/architecture/project-architecture.tex diff --git a/src/02_product-documentation/03_architecture/toolstack.tex b/src/02_product-documentation/architecture/toolstack.tex similarity index 100% rename from src/02_product-documentation/03_architecture/toolstack.tex rename to src/02_product-documentation/architecture/toolstack.tex diff --git a/src/02_product-documentation/limitations.tex b/src/02_product-documentation/limitations.tex new file mode 100644 index 0000000000000000000000000000000000000000..b11aae5a4deccf736020fff145bdc2f898d162f2 --- /dev/null +++ b/src/02_product-documentation/limitations.tex @@ -0,0 +1,18 @@ +\chapter{Limitations} + This chapter describes the limitations of the SmartEating chatbot. + + \section{Audio limitations} + For optimal performance, users must speak loudly and clearly when interacting with the chatbot. + This ensures accurate audio transcription and reduces the likelihood of misinterpretations. + + The assistants may struggle to transcribe the audio recorded in noisy environments effectively. + For the best experience, users should use the application in a quiet setting to avoid background noise interference. + + A quiet environment is also required for the assistants to pick up when the user stops speaking. + + \section{Recipe selection limitation} + Once a recipe is selected within the chatbot, it cannot be changed. + + \section{Language limitations} + The chatbot currently supports only English for both text messages and audio messages. + Therefore, users should only interact with the chatbot in English. diff --git a/src/02_product-documentation/04_quality-measures.tex b/src/02_product-documentation/quality-measures.tex similarity index 50% rename from src/02_product-documentation/04_quality-measures.tex rename to src/02_product-documentation/quality-measures.tex index 98627b8550f42108f7b7eca4578868aae5bbd906..13063372c519c4747ec468532e18332d9166b228 100644 --- a/src/02_product-documentation/04_quality-measures.tex +++ b/src/02_product-documentation/quality-measures.tex @@ -2,7 +2,7 @@ Quality measures are critical indicators used to evaluate the effectiveness and efficiency of software development, encompassing various metrics that assess the software's functionality, performance, security, maintainability, and other key factors. - \input{02_product-documentation/04_quality-measures/guidelines} - \input{02_product-documentation/04_quality-measures/build-tools} - \input{02_product-documentation/04_quality-measures/test-strategy} - \input{02_product-documentation/04_quality-measures/assistant-comparison} + \input{02_product-documentation/quality-measures/guidelines} + \input{02_product-documentation/quality-measures/build-tools} + \input{02_product-documentation/quality-measures/test-strategy} + \input{02_product-documentation/quality-measures/assistant-comparison} diff --git a/src/02_product-documentation/04_quality-measures/assistant-comparison.tex b/src/02_product-documentation/quality-measures/assistant-comparison.tex similarity index 100% rename from src/02_product-documentation/04_quality-measures/assistant-comparison.tex rename to src/02_product-documentation/quality-measures/assistant-comparison.tex diff --git a/src/02_product-documentation/04_quality-measures/build-tools.tex b/src/02_product-documentation/quality-measures/build-tools.tex similarity index 100% rename from src/02_product-documentation/04_quality-measures/build-tools.tex rename to src/02_product-documentation/quality-measures/build-tools.tex diff --git a/src/02_product-documentation/04_quality-measures/guidelines.tex b/src/02_product-documentation/quality-measures/guidelines.tex similarity index 100% rename from src/02_product-documentation/04_quality-measures/guidelines.tex rename to src/02_product-documentation/quality-measures/guidelines.tex diff --git a/src/02_product-documentation/04_quality-measures/test-strategy.tex b/src/02_product-documentation/quality-measures/test-strategy.tex similarity index 100% rename from src/02_product-documentation/04_quality-measures/test-strategy.tex rename to src/02_product-documentation/quality-measures/test-strategy.tex diff --git a/src/02_product-documentation/requirements.tex b/src/02_product-documentation/requirements.tex new file mode 100644 index 0000000000000000000000000000000000000000..91153a4faf36f2e5d76d1d232850a568e56ecbb6 --- /dev/null +++ b/src/02_product-documentation/requirements.tex @@ -0,0 +1,3 @@ +\chapter{Requirements} + \input{02_product-documentation/requirements/functional-requirements} + \input{02_product-documentation/requirements/non-functional-requirements} diff --git a/src/02_product-documentation/01_requirements/01_functional-requirements.tex b/src/02_product-documentation/requirements/functional-requirements.tex similarity index 100% rename from src/02_product-documentation/01_requirements/01_functional-requirements.tex rename to src/02_product-documentation/requirements/functional-requirements.tex diff --git a/src/02_product-documentation/01_requirements/02_non-functional-requirements.tex b/src/02_product-documentation/requirements/non-functional-requirements.tex similarity index 100% rename from src/02_product-documentation/01_requirements/02_non-functional-requirements.tex rename to src/02_product-documentation/requirements/non-functional-requirements.tex diff --git a/src/03_project-documentation/02_project-plan.tex b/src/03_project-documentation/02_project-plan.tex deleted file mode 100644 index dec36413425e8dc06ae7b093dc108ff5c715c4a2..0000000000000000000000000000000000000000 --- a/src/03_project-documentation/02_project-plan.tex +++ /dev/null @@ -1,9 +0,0 @@ -\chapter{Project Plan} - The project plan outlines the resources, roles and processes required for the successful completion. - It goes into detail which risks I expect and how I have laid out the long term plan. - - \input{03_project-documentation/02_project-plan/01_resources} - \input{03_project-documentation/02_project-plan/02_roles} - \input{03_project-documentation/02_project-plan/03_processes-meetings} - \input{03_project-documentation/02_project-plan/04_risk-management} - \input{03_project-documentation/02_project-plan/05_long-term-plan} diff --git a/src/03_project-documentation/01_initial-project-description.tex b/src/03_project-documentation/initial-project-description.tex similarity index 100% rename from src/03_project-documentation/01_initial-project-description.tex rename to src/03_project-documentation/initial-project-description.tex diff --git a/src/03_project-documentation/05_meeting-notes.tex b/src/03_project-documentation/meeting-notes.tex similarity index 100% rename from src/03_project-documentation/05_meeting-notes.tex rename to src/03_project-documentation/meeting-notes.tex diff --git a/src/03_project-documentation/04_personal-reports.tex b/src/03_project-documentation/personal-reports.tex similarity index 100% rename from src/03_project-documentation/04_personal-reports.tex rename to src/03_project-documentation/personal-reports.tex diff --git a/src/03_project-documentation/project-plan.tex b/src/03_project-documentation/project-plan.tex new file mode 100644 index 0000000000000000000000000000000000000000..7edfdacfb1b43017f7cdfc4ed606e7315898ffe2 --- /dev/null +++ b/src/03_project-documentation/project-plan.tex @@ -0,0 +1,9 @@ +\chapter{Project Plan} + The project plan outlines the resources, roles and processes required for the successful completion. + It goes into detail which risks I expect and how I have laid out the long term plan. + + \input{03_project-documentation/project-plan/resources} + \input{03_project-documentation/project-plan/roles} + \input{03_project-documentation/project-plan/processes-meetings} + \input{03_project-documentation/project-plan/risk-management} + \input{03_project-documentation/project-plan/long-term-plan} diff --git a/src/03_project-documentation/02_project-plan/05_long-term-plan.tex b/src/03_project-documentation/project-plan/long-term-plan.tex similarity index 100% rename from src/03_project-documentation/02_project-plan/05_long-term-plan.tex rename to src/03_project-documentation/project-plan/long-term-plan.tex diff --git a/src/03_project-documentation/02_project-plan/03_processes-meetings.tex b/src/03_project-documentation/project-plan/processes-meetings.tex similarity index 100% rename from src/03_project-documentation/02_project-plan/03_processes-meetings.tex rename to src/03_project-documentation/project-plan/processes-meetings.tex diff --git a/src/03_project-documentation/02_project-plan/01_resources.tex b/src/03_project-documentation/project-plan/resources.tex similarity index 100% rename from src/03_project-documentation/02_project-plan/01_resources.tex rename to src/03_project-documentation/project-plan/resources.tex diff --git a/src/03_project-documentation/02_project-plan/04_risk-management.tex b/src/03_project-documentation/project-plan/risk-management.tex similarity index 100% rename from src/03_project-documentation/02_project-plan/04_risk-management.tex rename to src/03_project-documentation/project-plan/risk-management.tex diff --git a/src/03_project-documentation/02_project-plan/02_roles.tex b/src/03_project-documentation/project-plan/roles.tex similarity index 100% rename from src/03_project-documentation/02_project-plan/02_roles.tex rename to src/03_project-documentation/project-plan/roles.tex diff --git a/src/03_project-documentation/03_time-tracking-report.tex b/src/03_project-documentation/time-tracking-report.tex similarity index 100% rename from src/03_project-documentation/03_time-tracking-report.tex rename to src/03_project-documentation/time-tracking-report.tex diff --git a/src/main.tex b/src/main.tex index dd7fa3cf04772f57350f318a889d1ac71bf69d3e..fe5a6fb69964ec32950635f3642782786ac52474 100644 --- a/src/main.tex +++ b/src/main.tex @@ -29,17 +29,18 @@ \part{Product Documentation} -\input{02_product-documentation/01_requirements} -\input{02_product-documentation/03_architecture} -\input{02_product-documentation/04_quality-measures} +\input{02_product-documentation/requirements} +\input{02_product-documentation/architecture} +\input{02_product-documentation/quality-measures} +\input{02_product-documentation/limitations} \part{Project Documentation} -\input{03_project-documentation/01_initial-project-description} -\input{03_project-documentation/02_project-plan} -\input{03_project-documentation/03_time-tracking-report} -\input{03_project-documentation/04_personal-reports} -\input{03_project-documentation/05_meeting-notes} +\input{03_project-documentation/initial-project-description} +\input{03_project-documentation/project-plan} +\input{03_project-documentation/time-tracking-report} +\input{03_project-documentation/personal-reports} +\input{03_project-documentation/meeting-notes} \part{Bibliography} \input{bibliography}