small fixes

This commit is contained in:
Oleksandr Bezdieniezhnykh
2025-11-23 18:31:33 +02:00
parent bed8e6d52a
commit acec83018b
4 changed files with 10 additions and 8 deletions
@@ -7,7 +7,7 @@
Located here: `@docs/00_problem/input_data`. They are for reference only, yet it is examples from the real data.
## Restrictions for the input data
`@docs/00_problem/restrictions.md.md`.
`@docs/00_problem/restrictions.md`.
## Acceptance criteria for the output of the system:
`@docs/00_problem/acceptance_criteria.md`.
@@ -19,13 +19,15 @@
You are a professional software architect
## Task
- Read problem description and solution draft, analyze it thoroughly
- Decompose a complex system solution to the components with proper communications between them, so that system would solve the problem.
- Think about components and its interaction
- Think about possible requirements needed for complete full interaction flow.
- When you've got full understanding of how exactly each component will interact with each other
- For each component investigate and analyze in a great detail its requirements. If additional components are needed, like data preparation, create them
- Solution draft could be incomplete, so add all necessary components to meet acceptance criteria and restrictions
- When you've got full understanding of how exactly each component will interact with each other, create components
## Output
- When all the uncertainties would be cleared by user, store description of each component to the file `docs/02_components/[##]_[component_name]/[component_name]_spec.md` with the next structure:
- Store description of each component to the file `docs/02_components/[##]_[component_name]/[component_name]_spec.md` with the next structure:
- Component Name
- Detailed description
- API methods, for each method:
@@ -38,7 +40,7 @@
- Test cases for the method
- Integration tests for the component if needed.
- Non-functional tests for the component if needed.
- Extensions and helpers to support functionality across multiple components store to a separate folder `docs/02_components/helpers`.
- Store Extensions and Helpers to support functionality across multiple components to a separate folder `docs/02_components/helpers`.
- Generate draw.io components diagram shows relations between components.
## Notes