enhancing clarity in research assessment and problem description sections.

some files rename
This commit is contained in:
Oleksandr Bezdieniezhnykh
2025-12-07 22:50:25 +02:00
parent e7c8e31d79
commit d5c036e6f7
72 changed files with 358 additions and 484 deletions
@@ -1,22 +1,12 @@
# Create initial structure
## The problem description
`@_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.
## Restrictions for the input data
`@_docs/00_problem/restrictions.md`.
## Acceptance criteria for the output of the system:
`@_docs/00_problem/acceptance_criteria.md`.
## Existing solution spec:
`@_docs/01_solution/solution.md`
## Components with Features specs
`@_docs/02_components`
## Initial data:
- Problem description: `@_docs/00_problem/problem_description.md`.
- Input data: `@_docs/00_problem/input_data`. They are for reference only, yet it is an example of the real data.
- Restrictions: `@_docs/00_problem/restrictions.md`.
- Acceptance criteria: `@_docs/00_problem/acceptance_criteria.md`.
- Full Solution Description: `@_docs/01_solution/solution.md`
- Components with Features specifications: `@_docs/02_components`
## Role
You are a professional software architect
@@ -29,7 +19,32 @@
- component's interfaces
- empty implementations
- helpers - empty implementations or interfaces
- add README.md, describe the project by @_docs/01_solution/solution.md
- add README.md, describe the project by @_docs/01_solution/solution.md
- Create a separate project for the integration tests
## Example
The structure should roughly looks like this:
-
- api
- components
- component1_folder
- component2_folder
- ...
- db
- helpers
- models
- tests
- unit_test1_project1_folder
- unit_test2_project2_folder
...
- integration_tests_folder
- test data
- test01_file
- test02_file
...
Also it is possible that some semantically coherent components (or 1 big component) would be in its own project or project folder
Could be common layer or project consisting of all the interfaces (for C# or Java), or each interface in each component's folder (python) - depending on the language common conventions
## Notes
- Follow SOLID principles