initial structure implemented

docs -> _docs
This commit is contained in:
Oleksandr Bezdieniezhnykh
2025-12-01 14:20:56 +02:00
parent 9134c5db06
commit abc26d5c20
360 changed files with 3881 additions and 101 deletions
@@ -1,34 +1,35 @@
# Create initial structure
## The problem description
`@docs/00_problem/problem_description.md`.
`@_docs/00_problem/problem_description.md`.
## Data samples
Located here: `@docs/00_problem/input_data`. They are for reference only, yet it is an example of the real data.
Located here: `@_docs/00_problem/input_data`. They are for reference only, yet it is an example of the real data.
## Restrictions for the input data
`@docs/00_problem/restrictions.md`.
`@_docs/00_problem/restrictions.md`.
## Acceptance criteria for the output of the system:
`@docs/00_problem/acceptance_criteria.md`.
`@_docs/00_problem/acceptance_criteria.md`.
## Existing solution spec:
`@docs/01_solution/solution.md`
`@_docs/01_solution/solution.md`
## Components with Features specs
`@docs/02_components`
`@_docs/02_components`
## Role
You are a professional software architect and developer
You are a professional software architect
## Task
- Read carefully all the component specs and features in the components folder: `@docs/02_components`
- Read carefully all the component specs and features in the components folder: `@_docs/02_components`
- Investgate in internet what are the best way and tools to implement components and its features
- Create initial structure:
- Make a plan for the creating initial structure:
- DTOs
- component's interfaces
- empty implementations
- helpers - empty implementations or interfaces
- add README.md, describe the project by @_docs/01_solution/solution.md
## Notes
- Follow SOLID principles
@@ -4,26 +4,26 @@
component_folder
## The problem description
`@docs/00_problem/problem_description.md`.
`@_docs/00_problem/problem_description.md`.
## Data samples
Located here: `@docs/00_problem/input_data`. They are for reference only, yet it is an example of the real data.
Located here: `@_docs/00_problem/input_data`. They are for reference only, yet it is an example of the real data.
## Restrictions for the input data
`@docs/00_problem/restrictions.md`.
`@_docs/00_problem/restrictions.md`.
## Acceptance criteria for the output of the system:
`@docs/00_problem/acceptance_criteria.md`.
`@_docs/00_problem/acceptance_criteria.md`.
## Existing solution:
`@docs/01_solution/solution.md`
`@_docs/01_solution/solution.md`
## Role
You are a professional software architect and developer
## Task
- Read carefully component spec in the component_folder: `@docs/02_components/[##]_[component_name]/[##]._component_[component_name]`
- Read carefully all the component features in the component_folder: `@docs/02_components/[##]_[component_name]/[##].[##]_feature_[feature_name]`
- Read carefully component spec in the component_folder: `@_docs/02_components/[##]_[component_name]/[##]._component_[component_name]`
- Read carefully all the component features in the component_folder: `@_docs/02_components/[##]_[component_name]/[##].[##]_feature_[feature_name]`
- Investgate in internet what are the best way and tools to implement component and its features
- During the investigation is is possible that found solutions required architecturally reorganization of the features. It is ok, propose that and if user agrees, include reorganization in the build feature plan. Also it is possible that interface could be changed or even removed or added new one. It is ok.
- Make sure feature is connected and communicated properly with other features and existing code