Could you please provide a template for the instructions and context of the project

2 / 2

173d ago

Project Instructions and Context Template

Below is a comprehensive template you can use to document your project instructions and context. This structured format will help you organize your thoughts and provide clear guidance for anyone working on your project.

Untitled

project-instructions.md

How to Use This Template

Copy the template: Use the code block above to copy the full template.
Fill in your details: Replace the placeholders (text in brackets) with your specific project information.
Customize as needed: Add or remove sections based on your project's specific requirements.
Share with stakeholders: Once completed, share this document with everyone involved in the project to ensure alignment.
Update regularly: As your project evolves, update this document to reflect changes in scope, requirements, or other aspects.

Would you like me to explain any specific section of this template in more detail?

173d ago

Project Name: [Your Project Name]

Project Overview

A brief description of what the project is about, its purpose, and the problem it aims to solve.

Business Context

Information about the business environment, stakeholders, and the business need this project addresses.

Target Audience

Description of who will use the final product and their specific needs.

Business Goals

Clear objectives that define what success looks like for this project.

Technical Requirements

Technology Stack

Frontend: [e.g., Next.js, React, Vue.js]
Backend: [e.g., Node.js, Python, Java]
Database: [e.g., PostgreSQL, MongoDB, MySQL]
Hosting/Deployment: [e.g., Vercel, AWS, Azure]
Other tools: [e.g., Docker, CI/CD pipelines]

Functional Requirements

Detailed description of what the application should do:

Feature 1: [Description]
Feature 2: [Description]
...

Non-Functional Requirements

Performance, security, scalability, and other quality attributes:

Performance: [e.g., load times, response times]
Security: [e.g., authentication, authorization, data protection]
Accessibility: [e.g., WCAG compliance level]
...

Design Guidelines

UI/UX Guidelines

Design system: [e.g., Material Design, custom design system]
Color palette: [Primary, secondary, accent colors]
Typography: [Font families, sizes, weights]
Layout principles: [Grid system, spacing, responsive design principles]

Brand Guidelines

Logo usage
Voice and tone for content
Brand values to reflect in the design

Project Scope

In Scope

Clear list of what is included in this project.

Out of Scope

Clear list of what is explicitly not included in this project.

Timeline and Milestones

Phase 1: [Dates and deliverables]
Phase 2: [Dates and deliverables]
...

Dependencies

External APIs
Third-party services
Other teams or projects

Constraints

Budget limitations
Time constraints
Technical limitations
Legal or compliance requirements

Success Criteria

Measurable outcomes that will determine if the project is successful.

Existing Resources

Links to existing codebases
Documentation
Design files
Research findings

Contact Information

Project owner: [Name, contact details]
Technical lead: [Name, contact details]
Designer: [Name, contact details]
Other key stakeholders: [Names, roles, contact details]

Additional Notes

Any other information that doesn't fit into the categories above but is important for understanding the project.

Could you please provide a template for the instructions and context of the project

2 / 2

173d ago

Project Instructions and Context Template

Untitled

project-instructions.md

How to Use This Template

Copy the template: Use the code block above to copy the full template.
Fill in your details: Replace the placeholders (text in brackets) with your specific project information.
Customize as needed: Add or remove sections based on your project's specific requirements.
Share with stakeholders: Once completed, share this document with everyone involved in the project to ensure alignment.
Update regularly: As your project evolves, update this document to reflect changes in scope, requirements, or other aspects.

Would you like me to explain any specific section of this template in more detail?

173d ago

Project Name: [Your Project Name]

Project Overview

A brief description of what the project is about, its purpose, and the problem it aims to solve.

Business Context

Information about the business environment, stakeholders, and the business need this project addresses.

Target Audience

Description of who will use the final product and their specific needs.

Business Goals

Clear objectives that define what success looks like for this project.

Technical Requirements

Technology Stack

Frontend: [e.g., Next.js, React, Vue.js]
Backend: [e.g., Node.js, Python, Java]
Database: [e.g., PostgreSQL, MongoDB, MySQL]
Hosting/Deployment: [e.g., Vercel, AWS, Azure]
Other tools: [e.g., Docker, CI/CD pipelines]

Functional Requirements

Detailed description of what the application should do:

Feature 1: [Description]
Feature 2: [Description]
...

Non-Functional Requirements

Performance, security, scalability, and other quality attributes:

Performance: [e.g., load times, response times]
Security: [e.g., authentication, authorization, data protection]
Accessibility: [e.g., WCAG compliance level]
...

Design Guidelines

UI/UX Guidelines

Design system: [e.g., Material Design, custom design system]
Color palette: [Primary, secondary, accent colors]
Typography: [Font families, sizes, weights]
Layout principles: [Grid system, spacing, responsive design principles]

Brand Guidelines

Logo usage
Voice and tone for content
Brand values to reflect in the design

Project Scope

In Scope

Clear list of what is included in this project.

Out of Scope

Clear list of what is explicitly not included in this project.

Timeline and Milestones

Phase 1: [Dates and deliverables]
Phase 2: [Dates and deliverables]
...

Dependencies

External APIs
Third-party services
Other teams or projects

Constraints

Budget limitations
Time constraints
Technical limitations
Legal or compliance requirements

Success Criteria

Measurable outcomes that will determine if the project is successful.

Existing Resources

Links to existing codebases
Documentation
Design files
Research findings

Contact Information

Project owner: [Name, contact details]
Technical lead: [Name, contact details]
Designer: [Name, contact details]
Other key stakeholders: [Names, roles, contact details]

Additional Notes

Any other information that doesn't fit into the categories above but is important for understanding the project.

WorkingWorking...

Working...