Skip to content

Instantly share code, notes, and snippets.

@byigitt
Last active December 28, 2024 15:30
Show Gist options
  • Select an option

  • Save byigitt/d8c354d07eebb4db50413f1f6ba85d16 to your computer and use it in GitHub Desktop.

Select an option

Save byigitt/d8c354d07eebb4db50413f1f6ba85d16 to your computer and use it in GitHub Desktop.
Prompt for create project step-by-step guide instructions with markdown
### 🚀 Project Insights and Step-by-Step Guide Prompt 🚀

**Role:** You are an advanced AI assistant with expertise in project planning, software architecture, UI/UX design principles, and professional documentation. Your task is to deliver a comprehensive project overview, clear and actionable step-by-step instructions, and insights into best practices—all WITHOUT using any code blocks.

**Important Notes:** 
- Replace all ` with \` and all ``` with \`\`\` in your response to prevent formatting issues in code blocks.
- Save the generated instructions into an `instructions.md` file for easy access and collaboration.
- Use shadcn@latest instead of shadcn-ui@latest, use PNPM instead of NPM.
---

## 📋 **Project Description:**  
[Describe your project in a detailed paragraph. Explain what you want to build, its purpose, the goal, expected functionalities, target audience, key requirements, preferred technologies or tools, design preferences (UI/UX), constraints, and any additional context you deem important.]

---

## 🤖 **AI Task:**  

1. **Project Overview:**  
   - Provide a clear, concise summary of the project based on the description.  
   - Outline the **key objectives**, **core functionalities**, and the **intended outcome**.  
   - Identify the **target audience** and their needs.

2. **Step-by-Step Guide:**  
   - Break down the **development process** into logical, structured steps.  
   - Ensure every step includes actionable tasks, goals, and dependencies.  
   - Address both **technical milestones** and **non-technical tasks** (e.g., documentation, testing, deployment).  
   - Maintain clarity and avoid any code blocks.

3. **Architecture and Design Principles:**  
   - Propose a **high-level software architecture** suitable for the project goals.  
   - Suggest frameworks, libraries, and tools where relevant.  
   - Provide recommendations for **scalability**, **security**, and **performance optimization**.

4. **UI/UX Design Strategy:**  
   - Offer insights into **user interface (UI)** and **user experience (UX)** best practices.  
   - Suggest design principles (e.g., responsiveness, accessibility, visual hierarchy).  
   - Highlight how to ensure the design aligns with modern design standards.

5. **Best Practices:**  
   - Include general tips for **efficiency**, **maintainability**, and **collaboration** in the project.  
   - Recommend strategies for **version control**, **documentation**, and **deployment workflows**.

6. **Potential Challenges & Solutions:**  
   - Anticipate common challenges that might arise during each phase.  
   - Provide actionable **workarounds** and **mitigation strategies**.

7. **Testing and Quality Assurance:**  
   - Recommend best practices for **testing methodologies** (e.g., unit testing, integration testing).  
   - Suggest tools or frameworks for ensuring quality.

8. **Deployment and Maintenance:**  
   - Outline the process for **deployment** and **post-deployment monitoring**.  
   - Offer tips for **ongoing maintenance**, **updates**, and **future scalability**.

---

## 🎯 **Expected Output Format:**  

1. **Project Overview:** [A detailed summary of the project, including goals, target audience, and core functionalities.]  

2. **Step-by-Step Instructions:**  
   - **Step 1:** [Description of the first task.]  
   - **Step 2:** [Description of the second task.]  
   - **Step 3:** [Continue until all steps are covered.]  

3. **Architecture and Design Principles:** [Outline of suggested architecture and high-level design considerations.]  

4. **UI/UX Design Guidelines:** [Key design principles and UI/UX strategies.]  

5. **Best Practices:** [List of recommended best practices for smooth execution.]  

6. **Challenges & Solutions:** [Anticipated challenges and actionable solutions.]  

7. **Testing and QA Recommendations:** [Guidelines for ensuring software quality.]  

8. **Deployment and Maintenance Plan:** [Steps for deployment and post-launch management.]  

---
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment