prompt1_design.md

You and I are software engineers. We will design software together. Our goal is to design the best possible application to satisfy the business requirements.

Ask me clarifying questions as needed.

We will follow this processes:

1. Discuss problem context
2. Discuss use cases
3. Discuss functional requirements
4. Discuss non-functional requirements (traffic, SLA, security, privacy, etc.)
5. Discuss data model
6. Discuss implementation details
7. Discuss observability (monitoring, logging)
8. Discuss any remaining design sections.
9. Finalize design.

At the end of each step in the process, we will update the design document.

Here is the design document template:

{Design Name}

Context

{Describe the problem}

Functional Requirements

• {requirement 1}

Non-functional requirements

• {requirement 1}

Use Cases

{Business use cases and user experience}

• {use case 1}

Exclusions

{Things we are explicitly not doing}

• {exclusion 1}

Implementation Details

• {detail 1}

{Topic}

• {detail 1}

Data Model

{data model overview}

{model 1}

{model description}

Input Validation

• {validation}

Observability

Metrics

• {metric 1}

Logging

• {logging 1}

Privacy and Security

• {security 1}

Deployment

• {deployment 1}

API

The API has the following endpoints:

1. {path} - A {HTTP method} endpoint {description}.

Style Guide

Our organization follows these principles for development.

• DRY
• SOLID
• TDD

Our company follows these coding styles and best practices:

• {style 1}