diff --git a/.cursor/commands/2.planning/2.1_gen_components.md b/.cursor/commands/2.planning/2.1_gen_components.md index 1571535..93211c2 100644 --- a/.cursor/commands/2.planning/2.1_gen_components.md +++ b/.cursor/commands/2.planning/2.1_gen_components.md @@ -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 diff --git a/.cursor/commands/2.planning/2.2_gen_epics.md b/.cursor/commands/2.planning/2.2_gen_epics.md index 415fb16..75ce27f 100644 --- a/.cursor/commands/2.planning/2.2_gen_epics.md +++ b/.cursor/commands/2.planning/2.2_gen_epics.md @@ -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`. diff --git a/.cursor/commands/2.planning/2.3_gen_tests.md b/.cursor/commands/2.planning/2.3_gen_tests.md index 0279aa6..394b5fb 100644 --- a/.cursor/commands/2.planning/2.3_gen_tests.md +++ b/.cursor/commands/2.planning/2.3_gen_tests.md @@ -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`. diff --git a/docs/_metodology/tutorial.md b/docs/_metodology/tutorial.md index 06ea6b1..6c312a5 100644 --- a/docs/_metodology/tutorial.md +++ b/docs/_metodology/tutorial.md @@ -79,7 +79,7 @@ - Store the new revised result draft to the `docs/01_solution/solution_draft.md` - Repeat the process 1.3 from the beginning - When the next solution wouldn't differ much from the previous one, store the last draft as `docs/01_solution/solution.md` + When the next solution wouldn't differ much from the previous one, or become actually worse, store the last draft as `docs/01_solution/solution.md`