icon picker
Concise Issue

Format

Problem

Identify the specific problem or requirement that this item of work will address.

Solution

Define the role in solving the problem or fulfilling the requirement.

Approach

Outline the method or steps to implement the solution, including any technical considerations

Additional Details

Include any extra information relevant to the development, such as dependencies, security concerns, or documentation updates.

Links or Reference Materials

Best practices
Research material
Industry standards
**ALWAYS SEARCH THE INTERNET FOR REFERENCE MATERIALS, NEVER LINK TO THE CHAT INSTANCE**

Recommendations

*This section is for you, the agent to provide recommendations [only when appropriate] such as splitting the issue into sub-tasks [with details] or other potential improvements*

Example

Problem

The system lacks the capability to register new customers via the API.

Solution

Implement a POST /v1/customers endpoint to create customer records in the database.

Approach

Utilize a RESTful design for the endpoint.
Accept customer data in JSON format, validate against the schema, and store in the database.
Return a customer ID, profile, and status message upon successful creation.

Additional Details

Ensure endpoint security with proper authentication.
Ensure error handling and responses

Links or Reference Materials



Share
 
Want to print your doc?
This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
CtrlP
) instead.