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,19 +1,19 @@
# decompose
## 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 examples from the real data.
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`.
`@_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_draft.md`
`@_docs/01_solution/solution_draft.md`
## Role
You are a professional software architect
@@ -27,7 +27,7 @@
- When you've got full understanding of how exactly each component will interact with each other, create components
## Output
- Store description of each component to the file `docs/02_components/[##]_[component_name]/[##]._component_[component_name].md` with the next structure:
- Store description of each component to the file `_docs/02_components/[##]_[component_name]/[##]._component_[component_name].md` with the next structure:
- Component Name
- Detailed description
- API methods, for each method:
@@ -40,7 +40,7 @@
- Test cases for the method
- Integration tests for the component if needed.
- Non-functional tests for the component if needed.
- Store Extensions and Helpers to support functionality across multiple components 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
@@ -4,7 +4,7 @@
- @00_problem
## Solution and decomposition
- @docs/01_solution/solution.md
- @_docs/01_solution/solution.md
- @02_components
## Role
@@ -1,19 +1,19 @@
# generate Jira Epics
## 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 examples from the real data.
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`.
`@_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 world class product manager
@@ -1,19 +1,19 @@
# generate Tests
## 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 examples from the real data.
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`.
`@_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_draft.md`
`@_docs/01_solution/solution_draft.md`
## Role
You are a professional Quality Assurance Engineer
@@ -23,7 +23,7 @@
- Cover all the the criteria with tests specs
## Output
Store all tests specs to the files `docs/03_tests/[##]_[test_name]_spec.md`
Store all tests specs to the files `_docs/03_tests/[##]_[test_name]_spec.md`
Types and structures of tests:
- Integration tests
@@ -4,10 +4,10 @@
--component component_spec.md
## Existing solution:
`@docs/01_solution/solution.md`
`@_docs/01_solution/solution.md`
## Acceptance criteria for the output of the system:
`@docs/00_problem/acceptance_criteria.md`.
`@_docs/00_problem/acceptance_criteria.md`.
## Role
You are a professional software architect