mirror of
https://github.com/azaion/gps-denied-desktop.git
synced 2026-04-23 06:06:35 +00:00
Make prompts more stuctured.
Separate tutorial.md for developers from commands for AI WIP
This commit is contained in:
@@ -0,0 +1,46 @@
|
||||
# decompose
|
||||
|
||||
## 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 examples from the real data.
|
||||
|
||||
## Restrictions for the input data
|
||||
`@docs/00_problem/restrictions.md.md`.
|
||||
|
||||
## Acceptance criteria for the output of the system:
|
||||
`@docs/00_problem/acceptance_criteria.md`.
|
||||
|
||||
## Existing solution:
|
||||
`@docs/01_solution/solution_draft.md`
|
||||
|
||||
## Role
|
||||
You are a professional software architect
|
||||
|
||||
## Task
|
||||
- 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
|
||||
|
||||
## 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:
|
||||
- Component Name
|
||||
- Detailed description
|
||||
- API methods, for each method:
|
||||
- Name
|
||||
- Detailed description
|
||||
- Which component/system will use this method
|
||||
- Input
|
||||
- Output
|
||||
- Description of input and output data in case if it not obvious
|
||||
- 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`.
|
||||
- Generate draw.io components diagram shows relations between components.
|
||||
|
||||
## Notes
|
||||
Do not put any code yet, only names, input and output.
|
||||
Ask as many questions as possible to clarify all uncertainties.
|
||||
@@ -0,0 +1,24 @@
|
||||
# generate Jira Epics
|
||||
|
||||
## 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 examples from the real data.
|
||||
|
||||
## Restrictions for the input data
|
||||
`@docs/00_problem/restrictions.md.md`.
|
||||
|
||||
## Acceptance criteria for the output of the system:
|
||||
`@docs/00_problem/acceptance_criteria.md`.
|
||||
|
||||
## Existing solution:
|
||||
`@docs/01_solution/solution_draft.md`
|
||||
|
||||
## Role
|
||||
You are a professional product manager
|
||||
|
||||
## Task
|
||||
- Generate Jira Epics from the Components
|
||||
- Ensure each epic has clear goal and acceptance criteria, verify it with acceptance criteria
|
||||
- Generate draw.io components diagram based on previous diagram shows relations between components and Jira Epic numbers corresponding to each component.
|
||||
@@ -0,0 +1,37 @@
|
||||
# generate Tests
|
||||
|
||||
## 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 examples from the real data.
|
||||
|
||||
## Restrictions for the input data
|
||||
`@docs/00_problem/restrictions.md.md`.
|
||||
|
||||
## Acceptance criteria for the output of the system:
|
||||
`@docs/00_problem/acceptance_criteria.md`.
|
||||
|
||||
## Existing solution:
|
||||
`@docs/01_solution/solution_draft.md`
|
||||
|
||||
## Role
|
||||
You are a professional Quality Assurance Engineer
|
||||
|
||||
## Task
|
||||
- Compose tests according to the test strategy
|
||||
- Cover all the the criteria with tests specs
|
||||
|
||||
## Output
|
||||
- Store all tests specs to the files `docs/03_tests/[##]_[test_name]_spec.md` with the next structure for each test file:
|
||||
- Summary
|
||||
- Detailed description
|
||||
- Preconditions for tests
|
||||
- Steps:
|
||||
- Step1 - Expected result1
|
||||
- Step2 - Expected result2
|
||||
...
|
||||
- StepN - Expected resultN
|
||||
|
||||
## Notes
|
||||
Do not put any code yet. Ask as many questions as needed.
|
||||
@@ -0,0 +1,31 @@
|
||||
# generate Features for the provided component spec
|
||||
|
||||
## Input parameter
|
||||
--component @component_spec.md
|
||||
|
||||
## Existing solution:
|
||||
`@docs/01_solution/solution_draft.md`
|
||||
|
||||
## Acceptance criteria for the output of the system:
|
||||
`@docs/00_problem/acceptance_criteria.md`.
|
||||
|
||||
## Role
|
||||
You are a professional software architect
|
||||
|
||||
## Task
|
||||
Decompose component_spec to the features. If component is simple enough, make only 1 feature, if complex - separate per features.
|
||||
Feature can contain 0 or more APIs.
|
||||
|
||||
## Output
|
||||
In a component's folder create feature specs `[##]_[feature_name]_feature.md` with the next structure:
|
||||
- Name
|
||||
- Description
|
||||
- Component APIs it implements if any
|
||||
- External tools and service it uses for implementation if any
|
||||
- Internal methods and its purposes
|
||||
- Unit tests
|
||||
- Integration tests
|
||||
|
||||
## Notes
|
||||
Do NOT generate any code yet, only brief explanations what should be done.
|
||||
Ask as many questions as needed.
|
||||
Reference in New Issue
Block a user