├── .github ├── FUNDING.yml ├── dependabot.yml ├── workflows │ └── quality-assurance.yml ├── pull_request_template.md └── ISSUE_TEMPLATE │ ├── bug_report.yml │ └── feature_request.yml ├── .markdownlint.json ├── .gitignore ├── templates ├── category-template.md ├── prompt-template.md └── README.md ├── education ├── README.md ├── lesson-plan-generator.md └── quiz-generator.md ├── creative └── README.md ├── productivity ├── README.md └── task-prioritization.md ├── LICENSE ├── analysis └── README.md ├── development ├── README.md ├── code-review.md ├── refactoring-assistant.md ├── documentation-generator.md ├── bug-hunter.md └── architecture-planner.md ├── business ├── README.md ├── xianyu-product-description.md └── meeting-summary.md ├── writing ├── README.md ├── chinese-language-mode.md ├── prompt-generator.md ├── email-templates.md ├── blog-post-generator.md ├── github-copilot-prompt-generator.md ├── technical-documentation.md ├── creative-story-generator.md └── marketing-copy-creator.md ├── SECURITY.md ├── examples ├── README.md └── development-code-review-example.md ├── scripts ├── validate-library-ascii.py ├── validate-library.py ├── check-template-compliance.py └── check-internal-links.py ├── CONTRIBUTING.md └── README.md /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | custom: https://xi-xu.me/#sponsorships 2 | buy_me_a_coffee: xixu 3 | -------------------------------------------------------------------------------- /.markdownlint.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": true, 3 | "MD013": false, 4 | "MD040": false 5 | } 6 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # OS generated files 2 | .DS_Store 3 | .DS_Store? 4 | ._* 5 | .Spotlight-V100 6 | .Trashes 7 | ehthumbs.db 8 | Thumbs.db 9 | 10 | # IDE files 11 | .vscode/ 12 | .idea/ 13 | *.swp 14 | *.swo 15 | *~ 16 | 17 | # Logs 18 | *.log 19 | 20 | # Temporary files 21 | *.tmp 22 | *.temp 23 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | # Maintain dependencies for GitHub Actions 4 | - package-ecosystem: "github-actions" 5 | directory: "/" 6 | schedule: 7 | interval: "weekly" 8 | day: "monday" 9 | open-pull-requests-limit: 10 10 | labels: 11 | - "dependencies" 12 | - "github_actions" 13 | commit-message: 14 | prefix: "ci" 15 | include: "scope" 16 | -------------------------------------------------------------------------------- /templates/category-template.md: -------------------------------------------------------------------------------- 1 | # [Category Name] 2 | 3 | Brief description of what this category contains and its purpose. 4 | 5 | ## Categories 6 | 7 | - **Subcategory 1**: Description of this subcategory 8 | - **Subcategory 2**: Description of this subcategory 9 | - **Subcategory 3**: Description of this subcategory 10 | 11 | ## Example Prompts 12 | 13 | - `example-prompt-1.md` - Brief description of what this prompt does 14 | - `example-prompt-2.md` - Brief description of what this prompt does 15 | - `example-prompt-3.md` - Brief description of what this prompt does 16 | 17 | ## Usage Guidelines 18 | 19 | - [Guideline 1 for using prompts in this category] 20 | - [Guideline 2 for best practices] 21 | - [Guideline 3 for common use cases] 22 | 23 | ## Tips 24 | 25 | - [Tip 1 for effective usage] 26 | - [Tip 2 for customization] 27 | - [Tip 3 for troubleshooting] 28 | 29 | --- 30 | *Add your [category] prompts to this directory following the template structure.* 31 | -------------------------------------------------------------------------------- /education/README.md: -------------------------------------------------------------------------------- 1 | # Education Prompts 2 | 3 | This directory contains prompts for educational and learning applications. 4 | 5 | ## Categories 6 | 7 | - **Lesson Planning**: Creating educational content and curricula 8 | - **Assessment**: Quiz and test generation 9 | - **Explanation**: Breaking down complex concepts 10 | - **Study Guides**: Learning aids and study materials 11 | - **Interactive Learning**: Engaging educational activities 12 | - **Tutoring**: Personalized learning assistance 13 | 14 | ## Example Prompts 15 | 16 | - `lesson-plan-generator.md` - Create comprehensive lesson plans and curricula 17 | - `quiz-generator.md` - Generate quizzes and assessments for knowledge evaluation 18 | 19 | ## Educational Best Practices 20 | 21 | - Adapt to different learning styles 22 | - Include multiple assessment methods 23 | - Provide clear learning objectives 24 | - Encourage active participation 25 | 26 | --- 27 | *Add your education prompts to this directory following the template structure.* 28 | -------------------------------------------------------------------------------- /creative/README.md: -------------------------------------------------------------------------------- 1 | # Creative Prompts 2 | 3 | This directory contains prompts for creative and artistic endeavors. 4 | 5 | ## Categories 6 | 7 | - **Brainstorming**: Idea generation and creative thinking 8 | - **Storytelling**: Narrative creation and plot development 9 | - **Visual Arts**: Descriptions for artwork, design concepts 10 | - **Music & Poetry**: Creative expression in various forms 11 | - **Character Development**: Creating compelling characters 12 | - **World Building**: Constructing fictional worlds and settings 13 | 14 | ## Example Prompts 15 | 16 | - `brainstorming-session.md` - Facilitate innovative brainstorming and idea generation 17 | - `story-creator.md` - Generate creative stories and fictional narratives 18 | 19 | ## Creative Guidelines 20 | 21 | - Encourage experimentation and exploration 22 | - Allow for multiple iterations and variations 23 | - Consider different genres, styles, and approaches 24 | - Balance structure with creative freedom 25 | 26 | --- 27 | *Add your creative prompts to this directory following the template structure.* 28 | -------------------------------------------------------------------------------- /productivity/README.md: -------------------------------------------------------------------------------- 1 | # Productivity Prompts 2 | 3 | This directory contains prompts for general productivity and task management. 4 | 5 | ## Categories 6 | 7 | - **Task Management**: Organizing and prioritizing tasks 8 | - **Time Management**: Optimizing schedules and time usage 9 | - **Goal Setting**: Setting and tracking objectives 10 | - **Decision Making**: Frameworks for making decisions 11 | - **Organization**: Systems for organizing information and workflows 12 | - **Automation**: Streamlining repetitive processes 13 | 14 | ## Example Prompts 15 | 16 | - `task-prioritization.md` - Intelligent task prioritization and workflow optimization 17 | - `schedule-optimizer.md` - Optimize schedules and time allocation 18 | - `goal-setter.md` - Set and track meaningful goals with structured planning 19 | 20 | ## Productivity Tips 21 | 22 | - Focus on actionable outcomes 23 | - Use clear metrics and deadlines 24 | - Consider personal work styles 25 | - Integrate with existing systems 26 | 27 | --- 28 | *Add your productivity prompts to this directory following the template structure.* 29 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2025 Xi Xu 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /analysis/README.md: -------------------------------------------------------------------------------- 1 | # Analysis Prompts 2 | 3 | This directory contains prompts for data analysis, research, and analytical thinking tasks. 4 | 5 | ## Categories 6 | 7 | - **Data Analysis**: Statistical analysis and data interpretation 8 | - **Research**: Literature reviews and research synthesis 9 | - **Trend Analysis**: Identifying patterns and trends 10 | - **Comparative Analysis**: Comparing options, solutions, or approaches 11 | - **Report Generation**: Creating analytical reports and summaries 12 | - **Decision Support**: Frameworks for decision-making 13 | 14 | ## Available Prompts 15 | 16 | - `data-interpreter.md` - Analyze and interpret datasets 17 | - `research-synthesizer.md` - Combine multiple sources into insights 18 | - `trend-analyzer.md` - Identify patterns and predict trends 19 | - `comparison-matrix.md` - Compare multiple options systematically 20 | 21 | ## Analysis Best Practices 22 | 23 | - Clearly define the analytical objective 24 | - Specify the type of analysis needed 25 | - Include relevant context and constraints 26 | - Request specific output formats when needed 27 | 28 | --- 29 | *Add your analysis prompts to this directory following the template structure.* 30 | -------------------------------------------------------------------------------- /templates/prompt-template.md: -------------------------------------------------------------------------------- 1 | # Prompt Template 2 | 3 | ## Description 4 | 5 | [Brief explanation of what this prompt does and its intended use case] 6 | 7 | ## Usage 8 | 9 | [How to use this prompt effectively, including any prerequisites or setup] 10 | 11 | ## Prompt 12 | 13 | ```markdown 14 | [The actual prompt text goes here - this is what you'll copy and paste into your AI tool] 15 | ``` 16 | 17 | ## Example Input 18 | 19 | ```markdown 20 | [Sample input data, context, or parameters that would be used with this prompt] 21 | ``` 22 | 23 | ## Example Output 24 | 25 | ```markdown 26 | [Expected or sample output showing what the AI should produce] 27 | ``` 28 | 29 | ## Variations 30 | 31 | - **Variation 1**: [Description of how to modify the prompt for different use cases] 32 | - **Variation 2**: [Another modification or alternative approach] 33 | - **Advanced**: [More complex version of the prompt] 34 | 35 | ## Tips 36 | 37 | - [Best practice or recommendation] 38 | - [Common pitfall to avoid] 39 | - [Optimization suggestion] 40 | - [When to use this prompt vs alternatives] 41 | 42 | ## Related Prompts 43 | 44 | - [Link to similar or complementary prompts] 45 | - [Cross-references to other categories] 46 | 47 | ## Tags 48 | 49 | `[tag1]` `[tag2]` `[tag3]` `[category]` 50 | -------------------------------------------------------------------------------- /development/README.md: -------------------------------------------------------------------------------- 1 | # Development Prompts 2 | 3 | This directory contains prompts specifically designed for software development tasks. 4 | 5 | ## Categories 6 | 7 | - **Code Review**: Prompts for analyzing and improving code quality 8 | - **Documentation**: Generating technical documentation and comments 9 | - **Debugging**: Finding and fixing issues in code 10 | - **Architecture**: Planning system design and structure 11 | - **Testing**: Creating test cases and testing strategies 12 | - **Refactoring**: Improving code structure and maintainability 13 | 14 | ## Example Prompts 15 | 16 | - `code-review.md` - Comprehensive code review assistant 17 | - `documentation-generator.md` - Auto-generate documentation from code 18 | - `bug-hunter.md` - Debug assistance and error analysis 19 | - `architecture-planner.md` - System design and planning 20 | - `test-case-generator.md` - Create comprehensive test suites 21 | - `refactoring-assistant.md` - Code improvement suggestions 22 | 23 | ## Getting Started 24 | 25 | 1. Choose a prompt that matches your development task 26 | 2. Customize the prompt with your specific code or requirements 27 | 3. Run it through your preferred AI model 28 | 4. Iterate and refine based on the results 29 | 30 | --- 31 | *Add your development prompts to this directory following the template structure.* 32 | -------------------------------------------------------------------------------- /business/README.md: -------------------------------------------------------------------------------- 1 | # Business Prompts 2 | 3 | This directory contains prompts for business and professional applications. 4 | 5 | ## Categories 6 | 7 | - **Strategic Planning**: Business strategy and planning assistance 8 | - **Market Analysis**: Market research and competitive analysis 9 | - **Process Optimization**: Improving business processes and workflows 10 | - **Meeting Management**: Meeting summaries and action items 11 | - **Financial Analysis**: Financial planning and analysis 12 | - **Communication**: Professional communication templates 13 | - **E-commerce**: Product listings and marketplace optimization 14 | 15 | ## Example Prompts 16 | 17 | - `meeting-summary.md` - Transform meeting notes into actionable summaries 18 | - `proposal-writer.md` - Create compelling business proposals and bids 19 | - `strategic-planner.md` - Develop comprehensive business strategies 20 | - `market-analysis.md` - Analyze markets, competitors, and opportunities 21 | - `xianyu-product-description.md` - Create effective Xianyu marketplace listings 22 | 23 | ## Business Applications 24 | 25 | - Use for strategic decision-making 26 | - Improve operational efficiency 27 | - Enhance professional communication 28 | - Support planning and analysis activities 29 | 30 | --- 31 | *Add your business prompts to this directory following the template structure.* 32 | -------------------------------------------------------------------------------- /.github/workflows/quality-assurance.yml: -------------------------------------------------------------------------------- 1 | name: Quality Assurance 2 | 3 | on: 4 | push: 5 | branches: [main, develop] 6 | pull_request: 7 | branches: [main] 8 | 9 | permissions: 10 | contents: read 11 | 12 | jobs: 13 | markdown-lint: 14 | runs-on: ubuntu-latest 15 | name: Markdown Lint 16 | steps: 17 | - uses: actions/checkout@v6 18 | 19 | - name: Lint Markdown files 20 | uses: articulate/actions-markdownlint@v1 21 | with: 22 | config: .markdownlint.json 23 | files: "**/*.md" 24 | ignore: "node_modules" 25 | template-compliance: 26 | runs-on: ubuntu-latest 27 | name: Template Compliance Check 28 | steps: 29 | - uses: actions/checkout@v6 30 | 31 | - name: Setup Python 32 | uses: actions/setup-python@v6 33 | with: 34 | python-version: "3.9" 35 | 36 | - name: Check prompt template compliance 37 | run: | 38 | python scripts/check-template-compliance.py 39 | continue-on-error: true 40 | 41 | internal-links: 42 | runs-on: ubuntu-latest 43 | name: Internal File Link Check 44 | steps: 45 | - uses: actions/checkout@v6 46 | 47 | - name: Setup Python 48 | uses: actions/setup-python@v6 49 | with: 50 | python-version: "3.9" 51 | 52 | - name: Check internal file links 53 | run: | 54 | python scripts/check-internal-links.py --verbose 55 | -------------------------------------------------------------------------------- /templates/README.md: -------------------------------------------------------------------------------- 1 | # Templates 2 | 3 | This directory contains reusable templates for creating new prompts and organizing your prompt library. 4 | 5 | ## Available Templates 6 | 7 | ### `prompt-template.md` 8 | 9 | The standard template for creating new prompts. Includes all necessary sections and formatting guidelines. 10 | 11 | ### `category-template.md` 12 | 13 | Template for creating new category directories with proper documentation. 14 | 15 | ### `example-template.md` 16 | 17 | Template for documenting example outputs and use cases. 18 | 19 | ## Usage Guidelines 20 | 21 | 1. **Copy the appropriate template** before creating new content 22 | 2. **Fill in all sections** - even if brief, each section provides value 23 | 3. **Follow the formatting** to maintain consistency across the library 24 | 4. **Include examples** whenever possible to help users understand usage 25 | 5. **Add relevant tags** to improve discoverability 26 | 27 | ## Best Practices 28 | 29 | - Use clear, descriptive titles 30 | - Write prompts that are specific but flexible 31 | - Include variations for different use cases 32 | - Test prompts before adding to the library 33 | - Keep examples realistic and helpful 34 | 35 | ## Contributing 36 | 37 | When adding new templates: 38 | 39 | 1. Follow the existing structure and format 40 | 2. Include comprehensive documentation 41 | 3. Provide clear usage instructions 42 | 4. Test with multiple AI models when possible 43 | 44 | --- 45 | *Use these templates to maintain consistency and quality across the prompt library.* 46 | -------------------------------------------------------------------------------- /writing/README.md: -------------------------------------------------------------------------------- 1 | # Writing Prompts 2 | 3 | This directory contains prompts for various writing and content creation tasks. 4 | 5 | ## Categories 6 | 7 | - **Technical Writing**: Documentation, tutorials, and technical content 8 | - **Creative Writing**: Stories, poems, and creative content 9 | - **Business Writing**: Proposals, reports, and professional communication 10 | - **Marketing Copy**: Advertisements, social media, and promotional content 11 | - **Email Templates**: Professional and personal email communication 12 | - **Blog Posts**: Articles, opinion pieces, and informational content 13 | 14 | ## Example Prompts 15 | 16 | - `technical-documentation.md` - Create clear, comprehensive technical documentation 17 | - `email-templates.md` - Professional email templates for various scenarios 18 | - `blog-post-generator.md` - Create engaging blog posts and articles 19 | - `marketing-copy-creator.md` - Compelling marketing and sales copy 20 | - `creative-story-generator.md` - Generate creative stories and narratives 21 | - `prompt-generator.md` - Create structured, effective prompts for AI models 22 | - `github-copilot-prompt-generator.md` - Generate specialized prompts for GitHub Copilot's agent mode 23 | - `chinese-language-mode.md` - Ensure AI responses are delivered in Simplified Chinese 24 | 25 | ## Tips for Writing Prompts 26 | 27 | - Be specific about tone, audience, and purpose 28 | - Include style guidelines and formatting requirements 29 | - Provide examples of desired output when possible 30 | - Consider different writing styles and approaches 31 | 32 | --- 33 | *Add your writing prompts to this directory following the template structure.* 34 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | ## Reporting a Vulnerability 4 | 5 | We take security seriously. If you discover a security vulnerability in the Prompt Library, please report it responsibly: 6 | 7 | ### How to Report 8 | 9 | 1. **Email**: Send details to or create a private security advisory on GitHub 10 | 2. **Include**: 11 | - Description of the vulnerability 12 | - Steps to reproduce the issue 13 | - Potential impact assessment 14 | - Suggested fix (if available) 15 | 16 | ### What to Expect 17 | 18 | - **Acknowledgment**: We'll acknowledge receipt within 48 hours 19 | - **Assessment**: Initial assessment within 5 business days 20 | - **Disclosure**: Coordinated disclosure after fix is available 21 | 22 | ### Security Considerations for Prompts 23 | 24 | While this is primarily a documentation repository, please be aware that: 25 | 26 | 1. **Prompt Injection**: Some prompts may be vulnerable to injection attacks when used with AI systems 27 | 2. **Sensitive Data**: Avoid including real sensitive data in examples 28 | 3. **Malicious Use**: Consider how prompts might be misused and include appropriate warnings 29 | 30 | ### Safe Usage Guidelines 31 | 32 | - Always validate and sanitize inputs when using prompts in production 33 | - Be cautious with prompts that handle user-generated content 34 | - Review prompt outputs before using in sensitive contexts 35 | - Follow your AI provider's security guidelines and terms of service 36 | 37 | ## Security Best Practices 38 | 39 | When contributing to or using the Prompt Library: 40 | 41 | 1. **No Secrets**: Never include API keys, passwords, or sensitive information in prompts or examples 42 | 2. **Sanitize Examples**: Use placeholder data or properly anonymized examples 43 | 3. **Consider Context**: Think about how prompts might be misused or exploited 44 | 4. **Report Issues**: If you notice potential security concerns in existing prompts, please report them 45 | 46 | Thank you for helping keep the Prompt Library secure for everyone! 47 | -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | ## Description 2 | 3 | Brief description of what this PR does and why it's needed. 4 | 5 | ## Type of Change 6 | 7 | - [ ] New prompt 8 | - [ ] Prompt improvement/enhancement 9 | - [ ] Documentation update 10 | - [ ] Bug fix 11 | - [ ] Template addition 12 | - [ ] Example addition 13 | - [ ] Other (please describe): 14 | 15 | ## Category 16 | 17 | - [ ] Development 18 | - [ ] Writing 19 | - [ ] Business 20 | - [ ] Analysis 21 | - [ ] Creative 22 | - [ ] Education 23 | - [ ] Productivity 24 | - [ ] Templates 25 | - [ ] Examples 26 | 27 | ## Testing Checklist 28 | 29 | - [ ] Tested prompt with at least one AI model (please specify which): 30 | - [ ] Examples work as expected 31 | - [ ] All required sections are included 32 | - [ ] Follows template structure 33 | - [ ] Markdown formatting is correct 34 | - [ ] Links work correctly 35 | 36 | ## Quality Checklist 37 | 38 | - [ ] Clear, actionable prompt instructions 39 | - [ ] Realistic and helpful examples 40 | - [ ] Appropriate tags included 41 | - [ ] Related prompts linked where relevant 42 | - [ ] Usage instructions are clear 43 | - [ ] Variations provided for different use cases 44 | - [ ] Tips section includes practical advice 45 | 46 | ## Documentation Updates 47 | 48 | - [ ] Updated category README.md if needed 49 | - [ ] Added to main README.md if new prompt 50 | 51 | ## AI Model Testing 52 | 53 | Please specify which AI model(s) you tested with: 54 | 55 | - [ ] Claude Sonnet 4 56 | - [ ] Gemini 2.5 Pro (preview) 57 | - [ ] GPT-4.5 58 | - [ ] GPT-4o 59 | - [ ] o4-mini 60 | - [ ] Grok 3 61 | - [ ] DeepSeek-R1 62 | - [ ] Qwen3-235B-A22B 63 | - [ ] Other: ___________ 64 | 65 | ## Additional Notes 66 | 67 | Add any additional context, screenshots, or notes for reviewers here. 68 | 69 | --- 70 | 71 | By submitting this pull request, I confirm that: 72 | 73 | - [ ] I have read and followed the [contributing guidelines](../CONTRIBUTING.md) 74 | - [ ] This content is my original work or properly attributed 75 | - [ ] I agree to license this contribution under the MIT License 76 | -------------------------------------------------------------------------------- /writing/chinese-language-mode.md: -------------------------------------------------------------------------------- 1 | # Chinese Language Mode 2 | 3 | ## Description 4 | 5 | A simple but effective prompt instruction that ensures AI responses are delivered in Simplified Chinese by default. This prompt is useful for Chinese-speaking users who want consistent Chinese responses without having to specify the language in every interaction. 6 | 7 | ## Usage 8 | 9 | Perfect for Chinese-speaking users, educational contexts involving Chinese language learning, business communications in Chinese markets, or any scenario where Simplified Chinese should be the default response language. Simply include this instruction at the beginning of your conversation or system prompt. 10 | 11 | ## Prompt 12 | 13 | ```markdown 14 | ALWAYS respond in Simplified Chinese unless I explicitly instruct otherwise. 15 | ``` 16 | 17 | ## Example Input 18 | 19 | ```markdown 20 | Tell me about the weather today. 21 | ``` 22 | 23 | ## Example Output 24 | 25 | ```markdown 26 | 今天的天气情况取决于您所在的具体位置。我无法获取实时天气数据，建议您查看当地的天气预报应用或网站来了解今天的具体天气情况。如果您能告诉我您所在的城市，我可以为您提供更有针对性的建议。 27 | ``` 28 | 29 | ## Variations 30 | 31 | - **Traditional Chinese**: "ALWAYS respond in Traditional Chinese unless I explicitly instruct otherwise." 32 | - **Bilingual Mode**: "Respond in both Simplified Chinese and English unless I specify otherwise." 33 | - **Learning Mode**: "Respond in Simplified Chinese and provide English translations in parentheses for key terms." 34 | 35 | ## Tips 36 | 37 | - Place this instruction at the very beginning of your conversation or system prompt 38 | - The AI will maintain Chinese responses throughout the conversation unless you explicitly request a different language 39 | - This works well in combination with other prompts - just add this instruction to the beginning 40 | - Use "请用英文回答" (Please respond in English) when you need a specific response in English 41 | 42 | ## Related Prompts 43 | 44 | - [Email Templates](./email-templates.md) - Can be combined for Chinese business communications 45 | - [Technical Documentation](./technical-documentation.md) - For Chinese technical writing 46 | - [Marketing Copy Creator](./marketing-copy-creator.md) - For Chinese marketing materials 47 | 48 | ## Tags 49 | 50 | `chinese` `language` `localization` `communication` `writing` 51 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.yml: -------------------------------------------------------------------------------- 1 | name: Bug Report 2 | description: File a bug report 3 | title: "[Bug]: " 4 | labels: ["bug", "triage"] 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: | 9 | Thanks for taking the time to fill out this bug report! 10 | - type: input 11 | id: prompt-name 12 | attributes: 13 | label: Prompt Name 14 | description: Which prompt is experiencing the issue? 15 | placeholder: e.g., Code Review Assistant 16 | validations: 17 | required: true 18 | - type: dropdown 19 | id: category 20 | attributes: 21 | label: Category 22 | description: Which category does this prompt belong to? 23 | options: 24 | - Development 25 | - Writing 26 | - Business 27 | - Analysis 28 | - Creative 29 | - Education 30 | - Productivity 31 | - Templates 32 | validations: 33 | required: true 34 | - type: textarea 35 | id: what-happened 36 | attributes: 37 | label: What happened? 38 | description: Describe the issue you encountered 39 | placeholder: Tell us what went wrong! 40 | validations: 41 | required: true 42 | - type: textarea 43 | id: expected-behavior 44 | attributes: 45 | label: Expected Behavior 46 | description: What did you expect to happen? 47 | validations: 48 | required: true 49 | - type: textarea 50 | id: steps-to-reproduce 51 | attributes: 52 | label: Steps to Reproduce 53 | description: How can we reproduce this issue? 54 | placeholder: | 55 | 1. Go to '...' 56 | 2. Use prompt with '....' 57 | 3. See error 58 | validations: 59 | required: true 60 | - type: dropdown 61 | id: ai-model 62 | attributes: 63 | label: AI Model Used 64 | description: Which AI model were you using? 65 | options: 66 | - ChatGPT (GPT-4) 67 | - ChatGPT (GPT-3.5) 68 | - Claude (Anthropic) 69 | - Gemini (Google) 70 | - Other 71 | validations: 72 | required: false 73 | - type: textarea 74 | id: additional-context 75 | attributes: 76 | label: Additional Context 77 | description: Add any other context about the problem here. 78 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.yml: -------------------------------------------------------------------------------- 1 | name: Feature Request 2 | description: Suggest a new prompt or enhancement 3 | title: "[Feature]: " 4 | labels: ["enhancement", "triage"] 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: | 9 | Thanks for suggesting a new feature or improvement! 10 | - type: dropdown 11 | id: request-type 12 | attributes: 13 | label: Request Type 14 | description: What type of feature are you requesting? 15 | options: 16 | - New Prompt 17 | - Prompt Enhancement 18 | - Documentation Improvement 19 | - Template Addition 20 | - Example Addition 21 | - Other 22 | validations: 23 | required: true 24 | - type: dropdown 25 | id: category 26 | attributes: 27 | label: Category 28 | description: Which category would this fit into? 29 | options: 30 | - Development 31 | - Writing 32 | - Business 33 | - Analysis 34 | - Creative 35 | - Education 36 | - Productivity 37 | - Templates 38 | - New Category 39 | validations: 40 | required: true 41 | - type: textarea 42 | id: feature-description 43 | attributes: 44 | label: Feature Description 45 | description: Describe your feature request in detail 46 | placeholder: What would you like to see added or improved? 47 | validations: 48 | required: true 49 | - type: textarea 50 | id: use-case 51 | attributes: 52 | label: Use Case 53 | description: Describe the specific use case or problem this would solve 54 | placeholder: How would this be used? What problem does it solve? 55 | validations: 56 | required: true 57 | - type: textarea 58 | id: proposed-solution 59 | attributes: 60 | label: Proposed Solution 61 | description: If you have ideas for how to implement this, please share them 62 | validations: 63 | required: false 64 | - type: textarea 65 | id: alternatives 66 | attributes: 67 | label: Alternatives Considered 68 | description: Have you considered any alternative solutions or workarounds? 69 | validations: 70 | required: false 71 | - type: dropdown 72 | id: priority 73 | attributes: 74 | label: Priority 75 | description: How important is this feature to you? 76 | options: 77 | - Low - Nice to have 78 | - Medium - Would be helpful 79 | - High - Important for my workflow 80 | - Critical - Blocking my work 81 | validations: 82 | required: true 83 | - type: checkboxes 84 | id: contribution 85 | attributes: 86 | label: Contribution 87 | description: Would you be willing to help implement this feature? 88 | options: 89 | - label: I would be willing to contribute code for this feature 90 | - label: I would be willing to help with documentation 91 | - label: I would be willing to provide examples/testing 92 | -------------------------------------------------------------------------------- /examples/README.md: -------------------------------------------------------------------------------- 1 | # Example Use Cases and Outputs 2 | 3 | This directory contains real-world examples of how to use the prompts in the library, along with sample outputs to demonstrate their effectiveness. 4 | 5 | ## Categories 6 | 7 | ### Development Examples 8 | 9 | - **Code Review Example**: Complete code review with before/after code samples 10 | - **Architecture Planning**: Full system design for an e-commerce platform 11 | - **Bug Fixing**: Step-by-step debugging of a production issue 12 | 13 | ### Writing Examples 14 | 15 | - **Technical Documentation**: API documentation creation process 16 | - **Email Templates**: Business email examples for different scenarios 17 | - **Content Creation**: Blog post and marketing copy examples 18 | 19 | ### Business Examples 20 | 21 | - **Meeting Summaries**: Board meeting and team standup summaries 22 | - **Strategic Planning**: Market analysis and business plan examples 23 | - **Proposal Writing**: Client proposals and project estimates 24 | 25 | ### Creative Examples 26 | 27 | - **Brainstorming Sessions**: Innovation workshops and idea generation 28 | - **Content Strategy**: Social media and marketing campaign planning 29 | - **Design Concepts**: UI/UX and brand design briefs 30 | 31 | ## How to Use Examples 32 | 33 | 1. **Find Relevant Example**: Browse by category or search for your use case 34 | 2. **Review Input**: See what information was provided to the AI 35 | 3. **Study Output**: Examine the quality and structure of results 36 | 4. **Adapt for Your Needs**: Modify the approach for your specific situation 37 | 38 | ## Contributing Examples 39 | 40 | To add your own examples: 41 | 42 | 1. Use a real scenario (anonymize sensitive information) 43 | 2. Include both the prompt input and the generated output 44 | 3. Add commentary on what worked well and what could be improved 45 | 4. Follow the naming convention: `category-usecase-example.md` 46 | 47 | --- 48 | 49 | *Examples are updated regularly to showcase best practices and new prompt techniques.* 50 | 51 | ## Structure 52 | 53 | Each example follows this format: 54 | 55 | - **Input**: The original prompt and any provided context 56 | - **Output**: The AI's response 57 | - **Analysis**: What worked well and areas for improvement 58 | - **Variations**: How the prompt could be modified for different results 59 | 60 | ## Output Categories 61 | 62 | ### Development Outputs 63 | 64 | - Code review sessions 65 | - Documentation generation 66 | - Architecture planning outputs 67 | 68 | ### Writing Outputs 69 | 70 | - Blog post drafts 71 | - Technical documentation 72 | - Marketing copy samples 73 | 74 | ### Analysis Examples 75 | 76 | - Data interpretation reports 77 | - Research summaries 78 | - Decision frameworks in action 79 | 80 | ### Creative Outputs 81 | 82 | - Story excerpts 83 | - Character profiles 84 | - Creative brainstorming sessions 85 | 86 | ### Business Outputs 87 | 88 | - Strategic plans 89 | - Market analysis reports 90 | - Process optimization recommendations 91 | 92 | ### Education Examples 93 | 94 | - Lesson plans 95 | - Quiz questions 96 | - Study guides 97 | 98 | ### Productivity Examples 99 | 100 | - Task prioritization matrices 101 | - Schedule optimizations 102 | - Goal setting frameworks 103 | 104 | ## Learning from Examples 105 | 106 | 1. Review examples similar to your use case 107 | 2. Note what makes an example effective 108 | 3. Adapt successful patterns to your needs 109 | 4. Learn from less successful examples 110 | 111 | --- 112 | *Add your example outputs to this directory to help others learn effective prompt usage.* 113 | -------------------------------------------------------------------------------- /business/xianyu-product-description.md: -------------------------------------------------------------------------------- 1 | # Xianyu Product Description Generator 2 | 3 | ## Description 4 | 5 | This prompt helps sellers create compelling, honest, and effective product descriptions for the Xianyu second-hand marketplace platform. It guides users to write descriptions that highlight key features, accurately describe condition, and encourage buyer engagement. 6 | 7 | ## Usage 8 | 9 | Perfect for individuals selling items on Xianyu who want to create attractive listings, improve conversion rates, and reduce potential disputes by ensuring clear communication about product condition and features. 10 | 11 | ## Prompt 12 | 13 | ```markdown 14 | 请你扮演一位经验丰富的闲鱼资深卖家，根据用户（卖家）提供的商品信息，遵循以下指导原则，生成一段吸引人的闲鱼商品描述： 15 | 16 | 1. **开场白要吸睛 (Engaging Opening):** 用一两句有趣或直接点出亮点的开场白抓住潜在买家的眼球。 17 | 18 | 2. **突出核心价值 (Highlight Key Value):** 清晰、简洁地介绍商品的核心卖点和主要特点，说明它能为买家带来什么好处。 19 | 20 | 3. **品相描述要真实具体 (Accurate & Detailed Condition):** 明确说明商品的新旧程度，对任何瑕疵（即使微小）都要诚实描述，避免后续纠纷。如果商品成色很好，也要强调。 21 | 22 | 4. **融入出售原因 (Integrate Reason for Selling):** 如果卖家提供了出售原因，自然地融入描述中，可以增加真实感和人情味。 23 | 24 | 5. **价格与价值感 (Price & Value Proposition):** 如果有原价作对比，可以体现性价比。对于期望售价，可以暗示其合理性。 25 | 26 | 6. **配件和服务 (Accessories & Services):** 列出包含的配件，说明交易方式。 27 | 28 | 7. **语气风格 (Tone & Style):** 29 | 30 | * **友好亲切：** 使用口语化、接地气的语言，就像和朋友聊天一样。 31 | 32 | * **真诚可信：** 避免夸大其词，实事求是。 33 | 34 | * **适当幽默（可选）：** 如果商品和卖家风格适合，可以加入一些轻松幽默的元素。 35 | 36 | 8. **结构清晰易读 (Clear Structure):** 37 | 38 | * 适当分段，避免大段文字堆砌。 39 | 40 | * 对于特点、配件等可以考虑编号列出使其更醒目。 41 | 42 | 9. **行动呼吁 (Call to Action):** 鼓励买家进行互动，例如："喜欢就别错过啦，快来私聊我吧！"、"欢迎提问，看到会尽快回复！"。 43 | 44 | 10. **字数适中 (Concise):** 通常几百字以内为宜，重点突出，不冗余。 45 | 46 | 11. **符合闲鱼平台规范和用户习惯。** 47 | 48 | 输出格式：一段适合直接复制粘贴到闲鱼 app 商品发布页面（即不使用 Markdown 语法）的商品描述纯文本，在汉语与英语之间、汉语与数字之间插入空格，不包含 emoji。 49 | ``` 50 | 51 | ## Example Input 52 | 53 | ```markdown 54 | 商品：iPhone 12 128GB 蓝色 55 | 成色：9成新，使用8个月 56 | 瑕疵：屏幕有一道几乎看不见的细痕，背面完好 57 | 配件：原装充电器、数据线、手机壳 58 | 原价：6799元 59 | 期望售价：3500元 60 | 出售原因：换了新手机 61 | 交易方式：闲鱼自动担保交易，可发顺丰 62 | ``` 63 | 64 | ## Example Output 65 | 66 | ```markdown 67 | 【超高性价比】iPhone 12 128GB 蓝色版，颜值与性能兼具，让你的数字生活焕然一新！ 68 | 69 | 这台 iPhone 12 仅使用了 8 个月，整体成色 9 成新，爱机如新。机身蓝色依然亮丽，背面完好无划痕。屏幕有一道极细小的痕迹，正常使用几乎察觉不到，特别诚实地告诉大家。 70 | 71 | 所有功能完全正常，电池健康度 92%，续航给力。A14 芯片运行流畅，玩游戏不卡顿，日常办公娱乐都能轻松应对。 72 | 73 | 因为最近升级到了 13 Pro，这台 12 就忍痛割爱了。原价 6799 元的机器，现在只要 3500 元就能带回家，真的很划算。 74 | 75 | 全套包含： 76 | 1. 原装充电器 77 | 2. 原装数据线 78 | 3. 赠送一个八成新的手机壳 79 | 80 | 支持闲鱼自动担保交易，全国顺丰发货，安全有保障。有任何问题欢迎随时私聊咨询，看到必回！喜欢的朋友别犹豫，这个价格不会等人哦！ 81 | ``` 82 | 83 | ## Variations 84 | 85 | - **Luxury Items**: Focus more on brand authenticity, craftsmanship, and status value 86 | - **Electronics**: Emphasize technical specifications, functionality tests, and battery health 87 | - **Clothing**: Highlight fabric quality, fit details, and styling possibilities 88 | - **Collectibles**: Focus on rarity, condition grading, and investment potential 89 | 90 | ## Tips 91 | 92 | - Be extremely honest about item condition to avoid returns and disputes 93 | - Take time to mention small defects - transparency builds trust 94 | - Use natural language that sounds like real conversation, not corporate marketing 95 | - If you've used the item personally, share authentic experiences with it 96 | - Adjust your tone to match the item's price point and target audience 97 | 98 | ## Related Prompts 99 | 100 | - `marketing-copy-creator.md` - For general marketing copy creation 101 | - `email-templates.md` - For communication with potential buyers 102 | - `product-listing-optimization.md` - For optimizing marketplace listings 103 | 104 | ## Tags 105 | 106 | `e-commerce` `product-descriptions` `second-hand-market` `sales-copy` `xianyu` `taobao` `retail` `chinese-platforms` 107 | -------------------------------------------------------------------------------- /scripts/validate-library-ascii.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | """ 3 | Simple test runner for prompt library validation. 4 | This script runs basic checks that can be automated in CI/CD. 5 | """ 6 | 7 | import subprocess 8 | import sys 9 | from pathlib import Path 10 | 11 | 12 | def run_markdown_lint(): 13 | """Run markdownlint on all markdown files.""" 14 | print("Running markdown lint checks...") 15 | try: 16 | result = subprocess.run( 17 | ["markdownlint", "**/*.md", "--config", ".markdownlint.json"], 18 | capture_output=True, 19 | text=True, 20 | cwd=Path.cwd(), 21 | ) 22 | 23 | if result.returncode == 0: 24 | print("PASS: Markdown lint passed") 25 | return True 26 | else: 27 | print("FAIL: Markdown lint failed:") 28 | print(result.stdout) 29 | print(result.stderr) 30 | return False 31 | except FileNotFoundError: 32 | print("SKIP: markdownlint not found, skipping") 33 | return True 34 | 35 | 36 | def run_template_compliance(): 37 | """Run template compliance checker.""" 38 | print("Running template compliance checks...") 39 | try: 40 | result = subprocess.run( 41 | ["python", "scripts/check-template-compliance.py"], 42 | capture_output=True, 43 | text=True, 44 | cwd=Path.cwd(), 45 | ) 46 | 47 | print(result.stdout) 48 | if result.stderr: 49 | print(result.stderr) 50 | 51 | return result.returncode == 0 52 | except Exception as e: 53 | print(f"FAIL: Template compliance check failed: {e}") 54 | return False 55 | 56 | 57 | def check_required_files(): 58 | """Check that all required files exist.""" 59 | print("Checking required files...") 60 | required_files = [ 61 | "README.md", 62 | "CONTRIBUTING.md", 63 | "LICENSE", 64 | "SECURITY.md", 65 | ".markdownlint.json", 66 | ".markdown-link-check.json", 67 | ".spellcheck.yml", 68 | "scripts/check-template-compliance.py", 69 | ] 70 | 71 | missing_files = [] 72 | for file_path in required_files: 73 | if not Path(file_path).exists(): 74 | missing_files.append(file_path) 75 | 76 | if missing_files: 77 | print(f"FAIL: Missing required files: {', '.join(missing_files)}") 78 | return False 79 | else: 80 | print("PASS: All required files present") 81 | return True 82 | 83 | 84 | def check_directory_structure(): 85 | """Check that expected directory structure exists.""" 86 | print("Checking directory structure...") 87 | required_dirs = [ 88 | "development", 89 | "writing", 90 | "business", 91 | "analysis", 92 | "creative", 93 | "education", 94 | "productivity", 95 | "templates", 96 | "examples", 97 | "scripts", 98 | ".github", 99 | ] 100 | 101 | missing_dirs = [] 102 | for dir_path in required_dirs: 103 | if not Path(dir_path).is_dir(): 104 | missing_dirs.append(dir_path) 105 | 106 | if missing_dirs: 107 | print(f"FAIL: Missing required directories: {', '.join(missing_dirs)}") 108 | return False 109 | else: 110 | print("PASS: All required directories present") 111 | return True 112 | 113 | 114 | def main(): 115 | """Run all validation checks.""" 116 | print("Prompt Library Validation Suite") 117 | print("=" * 40) 118 | 119 | checks = [ 120 | check_required_files, 121 | check_directory_structure, 122 | run_template_compliance, 123 | run_markdown_lint, 124 | ] 125 | 126 | passed = 0 127 | total = len(checks) 128 | 129 | for check in checks: 130 | if check(): 131 | passed += 1 132 | print() 133 | 134 | print("=" * 40) 135 | print(f"Results: {passed}/{total} checks passed") 136 | 137 | if passed == total: 138 | print("SUCCESS: All validation checks passed!") 139 | return 0 140 | else: 141 | print("FAIL: Some validation checks failed") 142 | return 1 143 | 144 | 145 | if __name__ == "__main__": 146 | sys.exit(main()) 147 | -------------------------------------------------------------------------------- /scripts/validate-library.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | """ 3 | Simple test runner for prompt library validation. 4 | This script runs basic checks that can be automated in CI/CD. 5 | """ 6 | 7 | import subprocess 8 | import sys 9 | from pathlib import Path 10 | 11 | 12 | def run_markdown_lint(): 13 | """Run markdownlint on all markdown files.""" 14 | print("🔍 Running markdown lint checks...") 15 | try: 16 | result = subprocess.run( 17 | ["markdownlint", "**/*.md", "--config", ".markdownlint.json"], 18 | capture_output=True, 19 | text=True, 20 | cwd=Path.cwd(), 21 | ) 22 | 23 | if result.returncode == 0: 24 | print("✅ Markdown lint passed") 25 | return True 26 | else: 27 | print("❌ Markdown lint failed:") 28 | print(result.stdout) 29 | print(result.stderr) 30 | return False 31 | except FileNotFoundError: 32 | print("⚠️ markdownlint not found, skipping") 33 | return True 34 | 35 | 36 | def run_internal_link_check(): 37 | """Run internal file link checker.""" 38 | print("🔍 Running internal file link checks...") 39 | try: 40 | result = subprocess.run( 41 | ["python", "scripts/check-internal-links.py"], 42 | capture_output=True, 43 | text=True, 44 | cwd=Path.cwd(), 45 | ) 46 | 47 | print(result.stdout) 48 | if result.stderr: 49 | print(result.stderr) 50 | 51 | return result.returncode == 0 52 | except Exception as e: 53 | print(f"❌ Internal link check failed: {e}") 54 | return False 55 | 56 | 57 | def run_template_compliance(): 58 | """Run template compliance checker.""" 59 | print("🔍 Running template compliance checks...") 60 | try: 61 | result = subprocess.run( 62 | ["python", "scripts/check-template-compliance.py"], 63 | capture_output=True, 64 | text=True, 65 | cwd=Path.cwd(), 66 | ) 67 | 68 | print(result.stdout) 69 | if result.stderr: 70 | print(result.stderr) 71 | 72 | return result.returncode == 0 73 | except Exception as e: 74 | print(f"❌ Template compliance check failed: {e}") 75 | return False 76 | 77 | 78 | def check_required_files(): 79 | """Check that all required files exist.""" 80 | print("🔍 Checking required files...") 81 | required_files = [ 82 | "README.md", 83 | "CONTRIBUTING.md", 84 | "LICENSE", 85 | "SECURITY.md", 86 | ".markdownlint.json", 87 | ".markdown-link-check.json", 88 | ".spellcheck.yml", 89 | "scripts/check-template-compliance.py", 90 | ] 91 | 92 | missing_files = [] 93 | for file_path in required_files: 94 | if not Path(file_path).exists(): 95 | missing_files.append(file_path) 96 | 97 | if missing_files: 98 | print(f"❌ Missing required files: {', '.join(missing_files)}") 99 | return False 100 | else: 101 | print("✅ All required files present") 102 | return True 103 | 104 | 105 | def check_directory_structure(): 106 | """Check that expected directory structure exists.""" 107 | print("🔍 Checking directory structure...") 108 | required_dirs = [ 109 | "development", 110 | "writing", 111 | "business", 112 | "analysis", 113 | "creative", 114 | "education", 115 | "productivity", 116 | "templates", 117 | "examples", 118 | "scripts", 119 | ".github", 120 | ] 121 | 122 | missing_dirs = [] 123 | for dir_path in required_dirs: 124 | if not Path(dir_path).is_dir(): 125 | missing_dirs.append(dir_path) 126 | 127 | if missing_dirs: 128 | print(f"❌ Missing required directories: {', '.join(missing_dirs)}") 129 | return False 130 | else: 131 | print("✅ All required directories present") 132 | return True 133 | 134 | 135 | def main(): 136 | """Run all validation checks.""" 137 | print("🚀 Prompt Library Validation Suite") 138 | print("=" * 40) checks = [ 139 | check_required_files, 140 | check_directory_structure, 141 | run_template_compliance, 142 | run_internal_link_check, 143 | run_markdown_lint, 144 | ] 145 | 146 | passed = 0 147 | total = len(checks) 148 | 149 | for check in checks: 150 | if check(): 151 | passed += 1 152 | print() 153 | 154 | print("=" * 40) 155 | print(f"📊 Results: {passed}/{total} checks passed") 156 | 157 | if passed == total: 158 | print("🎉 All validation checks passed!") 159 | return 0 160 | else: 161 | print("❌ Some validation checks failed") 162 | return 1 163 | 164 | 165 | if __name__ == "__main__": 166 | sys.exit(main()) 167 | -------------------------------------------------------------------------------- /writing/prompt-generator.md: -------------------------------------------------------------------------------- 1 | # Prompt Generator 2 | 3 | ## Description 4 | 5 | A specialized AI assistant that creates clear, concise, and effective prompts for other AI models. This meta-prompt helps you generate well-structured prompts that achieve specific objectives by analyzing user requests and organizing them into actionable instructions. 6 | 7 | ## Usage 8 | 9 | Perfect for prompt engineers, AI researchers, content creators, and anyone who needs to create effective prompts for various AI models. Use this when you want to transform a vague request into a structured, comprehensive prompt that will get better results from AI systems. 10 | 11 | ## Prompt 12 | 13 | ```markdown 14 | You are an AI assistant that specializes in generating prompts for other AI models. Your goal is to create clear, concise, and effective prompts based on user requests. 15 | 16 | When a user provides a task they want an AI to complete, you will analyze the request and generate a prompt that includes: 17 | 18 | 1. **Objective:** A clear statement of what the AI should achieve. 19 | 2. **Context (if necessary):** Any relevant background information the AI needs to understand the task. 20 | 3. **Key Constraints/Requirements:** Specific limitations, formats, or criteria the AI must adhere to. 21 | 4. **Output Format (if specified):** How the AI should present its response. 22 | 5. **Examples (if beneficial and provided by user):** If the user provides examples, integrate them into the prompt to guide the AI. 23 | 24 | Your generated prompt should be: 25 | 26 | * **Actionable:** Clearly instruct the AI on what to do. 27 | * **Unambiguous:** Avoid vague language. 28 | * **Comprehensive:** Include all necessary information for the AI to complete the task successfully. 29 | * **Concise:** Avoid unnecessary words or phrases. 30 | 31 | **Process:** 32 | 33 | 1. Receive the user's request for an AI task. 34 | 2. Identify the core objective of the task. 35 | 3. Extract any pertinent context, constraints, or output format requirements. 36 | 4. Construct the prompt using the identified elements. 37 | 5. Review the generated prompt for clarity, completeness, and conciseness. 38 | 6. Output only the generated prompt in the form of Markdown code blocks. 39 | ``` 40 | 41 | ## Example Input 42 | 43 | ```markdown 44 | I need an AI to help me write product descriptions for my e-commerce store. The products are handmade jewelry, and I want the descriptions to be persuasive but not overly salesy. They should be about 100-150 words and include the materials used, the inspiration behind the piece, and why someone would want to buy it. The tone should be warm and personal. 45 | ``` 46 | 47 | ## Example Output 48 | 49 | ``` 50 | You are a skilled copywriter specializing in artisan product descriptions. Create compelling product descriptions for handmade jewelry that convert browsers into buyers. 51 | 52 | **Objective:** Write persuasive product descriptions for handmade jewelry pieces that drive sales while maintaining authenticity. 53 | 54 | **Requirements:** 55 | - Length: 100-150 words per description 56 | - Tone: Warm, personal, and authentic (avoid overly salesy language) 57 | - Include: Materials used, inspiration behind the piece, and compelling reasons to purchase 58 | - Focus on the craftsmanship and unique story of each piece 59 | - Appeal to emotions and personal connection 60 | 61 | **Format:** 62 | - Start with an engaging hook about the piece 63 | - Describe materials and craftsmanship 64 | - Share the inspiration or story behind the design 65 | - End with a compelling reason why the customer should own this piece 66 | - Use descriptive, sensory language that helps customers visualize wearing the jewelry 67 | 68 | **Context:** These descriptions will be used on an e-commerce website selling handmade jewelry to customers who value artisan craftsmanship and unique, personal accessories. 69 | 70 | For each piece, provide: [Product name, materials, key design elements, and any special story or inspiration] 71 | ``` 72 | 73 | ## Variations 74 | 75 | ### Technical Documentation Prompts 76 | 77 | Generate prompts for creating technical documentation, API guides, and developer resources. 78 | 79 | ### Creative Writing Prompts 80 | 81 | Create prompts for storytelling, character development, and creative content generation. 82 | 83 | ### Business Communication Prompts 84 | 85 | Develop prompts for professional emails, reports, proposals, and business correspondence. 86 | 87 | ### Educational Content Prompts 88 | 89 | Generate prompts for lesson plans, quiz creation, and educational material development. 90 | 91 | ## Tips 92 | 93 | - Always include the core objective as the first element 94 | - Be specific about constraints and requirements to avoid ambiguous outputs 95 | - Include examples when they would significantly improve the AI's understanding 96 | - Consider the end user's expertise level when crafting prompts 97 | - Test generated prompts to ensure they produce the desired results 98 | - Iterate and refine based on the quality of outputs received 99 | 100 | ## Related Prompts 101 | 102 | - `technical-documentation.md` - For creating structured technical content 103 | - `email-templates.md` - For professional communication prompts 104 | - `marketing-copy-creator.md` - For persuasive content generation prompts 105 | 106 | ## Tags 107 | 108 | `meta-prompting` `prompt-engineering` `ai-optimization` `instruction-design` `prompt-creation` `ai-training` 109 | -------------------------------------------------------------------------------- /development/code-review.md: -------------------------------------------------------------------------------- 1 | # Code Review Assistant 2 | 3 | ## Description 4 | 5 | A comprehensive code review prompt that analyzes code quality, identifies potential issues, suggests improvements, and provides detailed feedback on best practices, security, performance, and maintainability. 6 | 7 | ## Usage 8 | 9 | Paste your code along with any specific concerns or focus areas. Works with any programming language. Best used for reviewing pull requests, refactoring decisions, or general code quality assessment. 10 | 11 | ## Prompt 12 | 13 | ```markdown 14 | Please perform a comprehensive code review of the following code. Analyze it for: 15 | 16 | 1. **Code Quality & Style** 17 | - Readability and clarity 18 | - Naming conventions 19 | - Code organization and structure 20 | - Adherence to language-specific best practices 21 | 22 | 2. **Performance & Efficiency** 23 | - Algorithm efficiency 24 | - Resource usage 25 | - Potential bottlenecks 26 | - Optimization opportunities 27 | 28 | 3. **Security Concerns** 29 | - Potential vulnerabilities 30 | - Input validation 31 | - Data handling practices 32 | - Security best practices 33 | 34 | 4. **Maintainability** 35 | - Code complexity 36 | - Documentation and comments 37 | - Modularity and reusability 38 | - Error handling 39 | 40 | 5. **Testing & Reliability** 41 | - Edge cases consideration 42 | - Error scenarios 43 | - Testing recommendations 44 | 45 | Please provide: 46 | - Specific line-by-line feedback where applicable 47 | - Priority levels for each issue (Critical/High/Medium/Low) 48 | - Concrete suggestions for improvement 49 | - Positive aspects worth highlighting 50 | 51 | Code to review: 52 | ``` 53 | 54 | [YOUR CODE HERE] 55 | 56 | ``` 57 | 58 | Additional context or specific concerns: 59 | [SPECIFY ANY PARTICULAR AREAS TO FOCUS ON] 60 | ``` 61 | 62 | ## Example Input 63 | 64 | ```markdown 65 | ```javascript 66 | function calculateDiscount(price, discountPercent) { 67 | var discount = price * discountPercent / 100; 68 | var finalPrice = price - discount; 69 | return finalPrice; 70 | } 71 | 72 | function processOrder(items) { 73 | var total = 0; 74 | for(var i = 0; i < items.length; i++) { 75 | total += calculateDiscount(items[i].price, items[i].discount); 76 | } 77 | return total; 78 | } 79 | ``` 80 | 81 | ``` 82 | 83 | ## Example Output 84 | 85 | ```markdown 86 | ## Code Review Feedback 87 | 88 | ### Overall Assessment 89 | The code is functional but has several areas for improvement in terms of best practices, error handling, and modern JavaScript conventions. 90 | 91 | ### Specific Issues 92 | 93 | **Medium Priority Issues:** 94 | 1. **Line 1-4**: Use `const`/`let` instead of `var` for better scoping 95 | 2. **Line 1**: Missing input validation - function should handle edge cases 96 | 3. **Line 6-10**: Consider using modern array methods like `reduce()` 97 | 98 | **Low Priority Issues:** 99 | 1. **General**: Add JSDoc comments for better documentation 100 | 2. **Line 6**: Variable naming could be more descriptive 101 | 102 | ### Suggested Improvements 103 | 104 | ```javascript 105 | /** 106 | * Calculates discounted price 107 | * @param {number} price - Original price (must be positive) 108 | * @param {number} discountPercent - Discount percentage (0-100) 109 | * @returns {number} Final price after discount 110 | */ 111 | function calculateDiscount(price, discountPercent) { 112 | if (price < 0 || discountPercent < 0 || discountPercent > 100) { 113 | throw new Error('Invalid input parameters'); 114 | } 115 | 116 | const discount = price * discountPercent / 100; 117 | return price - discount; 118 | } 119 | 120 | /** 121 | * Calculates total for order with individual item discounts 122 | * @param {Array} items - Array of items with price and discount properties 123 | * @returns {number} Total order amount 124 | */ 125 | function processOrder(items) { 126 | if (!Array.isArray(items)) { 127 | throw new Error('Items must be an array'); 128 | } 129 | 130 | return items.reduce((total, item) => { 131 | return total + calculateDiscount(item.price, item.discount); 132 | }, 0); 133 | } 134 | ``` 135 | 136 | ### Positive Aspects 137 | 138 | - Clear function naming that describes purpose 139 | - Simple, focused functions following single responsibility principle 140 | - Clean separation between discount calculation and order processing 141 | 142 | ``` 143 | 144 | ## Variations 145 | - **Security-Focused**: Emphasize security vulnerabilities and data protection 146 | - **Performance-Focused**: Concentrate on optimization and efficiency 147 | - **Junior Developer**: Provide more educational explanations and learning resources 148 | - **Legacy Code**: Focus on modernization and technical debt reduction 149 | 150 | ## Tips 151 | - Provide the programming language for more targeted feedback 152 | - Include context about the application domain for better security analysis 153 | - Mention any specific coding standards or frameworks being used 154 | - Be specific about performance requirements or constraints 155 | 156 | ## Related Prompts 157 | - `refactoring-assistant.md` - For code improvement suggestions 158 | - `documentation-generator.md` - For adding comprehensive documentation 159 | - `test-case-generator.md` - For creating tests for reviewed code 160 | 161 | ## Tags 162 | `code-review` `quality-assurance` `best-practices` `development` `debugging` 163 | -------------------------------------------------------------------------------- /writing/email-templates.md: -------------------------------------------------------------------------------- 1 | # Email Templates Generator 2 | 3 | ## Description 4 | 5 | Creates professional email templates for various business and personal scenarios. Generates emails with appropriate tone, structure, and content based on purpose, audience, and desired outcome. 6 | 7 | ## Usage 8 | 9 | Specify the email type, recipient, purpose, and any specific requirements. Include context about the situation and desired tone. Works for business communications, marketing, customer service, and personal correspondence. 10 | 11 | ## Prompt 12 | 13 | ```markdown 14 | Create a professional email template for the following scenario: 15 | 16 | **Email Type:** 17 | [Business inquiry / Follow-up / Announcement / Marketing / Customer service / Apology / Thank you / Other] 18 | 19 | **Sender:** [Your role/title and company/context] 20 | **Recipient:** [Target audience - specific person, department, customer type, etc.] 21 | **Purpose:** [Main goal of the email - what you want to achieve] 22 | 23 | **Context:** 24 | [Background information about the situation, relationship, or previous interactions] 25 | 26 | **Key Points to Include:** 27 | - [Main message or information to convey] 28 | - [Specific requests or calls to action] 29 | - [Important details or deadlines] 30 | - [Any attachments or references] 31 | 32 | **Tone Requirements:** 33 | [Professional / Friendly / Formal / Apologetic / Urgent / Celebratory / Persuasive] 34 | 35 | **Special Requirements:** 36 | - [Length preference - brief/detailed] 37 | - [Include specific legal disclaimers] 38 | - [Mobile-friendly formatting] 39 | - [Personalization elements] 40 | - [Brand voice guidelines] 41 | 42 | Please create an email that: 43 | 1. Has an effective subject line 44 | 2. Opens with appropriate greeting 45 | 3. Clearly states the purpose 46 | 4. Includes all key information 47 | 5. Has a clear call to action 48 | 6. Ends with professional closing 49 | 7. [Any additional specific requirements] 50 | 51 | **Additional Context:** 52 | [Company culture, industry norms, cultural considerations, or other relevant information] 53 | ``` 54 | 55 | ## Example Input 56 | 57 | ```markdown 58 | **Email Type:** Follow-up 59 | 60 | **Sender:** Sales Manager at TechSolutions Inc. 61 | **Recipient:** Potential client who attended our product demo last week 62 | **Purpose:** Follow up on demo, address concerns, and schedule next meeting 63 | 64 | **Context:** 65 | Last week we gave a 30-minute demo of our project management software to their team of 5 people. They seemed interested but had concerns about data migration from their current system and pricing for their team size. 66 | 67 | **Key Points to Include:** 68 | - Reference the specific demo and attendees 69 | - Address their data migration concerns with solution 70 | - Provide pricing information for 15-user team 71 | - Offer a free trial period 72 | - Request a follow-up meeting to discuss implementation 73 | 74 | **Tone Requirements:** Professional but friendly, helpful, not pushy 75 | 76 | **Special Requirements:** 77 | - Keep it concise (under 200 words) 78 | - Include clear next steps 79 | - Mobile-friendly formatting 80 | ``` 81 | 82 | ## Example Output 83 | 84 | ```markdown 85 | **Subject:** Following up on your TechSolutions demo - Migration solutions & pricing 86 | 87 | Dear [Client Name], 88 | 89 | I hope this email finds you well. Thank you for taking the time last Tuesday to attend our project management software demonstration with your team. 90 | 91 | I wanted to follow up on the excellent questions you raised during our session, particularly regarding data migration and pricing for your 15-person team. 92 | 93 | **Regarding Data Migration:** 94 | I've spoken with our technical team, and we can provide a complimentary data migration service from your current system. Our migration specialists will work directly with your IT team to ensure a seamless transition with zero data loss. 95 | 96 | **Pricing for Your Team:** 97 | For a 15-user license, our annual plan would be $1,800/year (that's $10/user/month), which includes: 98 | - Full platform access 99 | - Priority customer support 100 | - Free data migration 101 | - Monthly training sessions 102 | 103 | **Next Steps:** 104 | I'd love to offer you a 30-day free trial so your team can experience the platform firsthand. Would you be available for a brief 15-minute call this week to discuss implementation timeline and answer any remaining questions? 105 | 106 | I'm available Tuesday-Thursday afternoon or Friday morning. Please let me know what works best for your schedule. 107 | 108 | Best regards, 109 | 110 | [Your Name] 111 | Sales Manager 112 | TechSolutions Inc. 113 | 📞 (555) 123-4567 114 | 📧 [your.email@techsolutions.com] 115 | 116 | P.S. I've attached a case study from a similar-sized company that successfully migrated to our platform last quarter. 117 | ``` 118 | 119 | ## Variations 120 | 121 | - **Cold Outreach**: First-time contact emails with introduction and value proposition 122 | - **Customer Service**: Support, complaint resolution, and customer care emails 123 | - **Internal Communications**: Team updates, announcements, and interdepartmental messages 124 | - **Marketing Campaigns**: Promotional emails, newsletters, and product launches 125 | - **Networking**: Professional relationship building and industry connections 126 | 127 | ## Tips 128 | 129 | - Always personalize with recipient's name and specific details 130 | - Keep subject lines clear, specific, and under 50 characters 131 | - Use bullet points for easy scanning on mobile devices 132 | - Include a clear, single call to action 133 | - End with your contact information and availability 134 | - Proofread for tone appropriateness and professionalism 135 | - Consider cultural and industry norms for your audience 136 | 137 | ## Related Prompts 138 | 139 | - `technical-documentation.md` - For creating detailed email documentation 140 | - `meeting-summary.md` - For follow-up emails after meetings 141 | - `proposal-writer.md` - For formal proposal emails 142 | 143 | ## Tags 144 | 145 | `email` `business-communication` `templates` `professional-writing` `customer-service` `marketing` 146 | -------------------------------------------------------------------------------- /scripts/check-template-compliance.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | """ 3 | Template Compliance Checker for Prompt Library 4 | 5 | This script validates that all prompt files follow the standard template structure 6 | and reports any missing or incorrectly formatted sections. 7 | """ 8 | 9 | import re 10 | import sys 11 | from pathlib import Path 12 | from typing import Dict, List, Tuple 13 | 14 | # Required sections in the correct order 15 | REQUIRED_SECTIONS = [ 16 | "Description", 17 | "Usage", 18 | "Prompt", 19 | "Example Input", 20 | "Example Output", 21 | "Variations", 22 | "Tips", 23 | "Related Prompts", 24 | "Tags", 25 | ] 26 | 27 | 28 | def extract_sections(content: str) -> Dict[str, str]: 29 | """Extract sections from markdown content.""" 30 | sections = {} 31 | current_section = None 32 | current_content = [] 33 | 34 | lines = content.split("\n") 35 | 36 | for line in lines: 37 | # Check if this is a section header (## Section Name) 38 | section_match = re.match(r"^## (.+)$", line.strip()) 39 | if section_match: 40 | # Save previous section 41 | if current_section: 42 | sections[current_section] = "\n".join(current_content).strip() 43 | 44 | # Start new section 45 | current_section = section_match.group(1) 46 | current_content = [] 47 | else: 48 | # Add content to current section 49 | if current_section: 50 | current_content.append(line) 51 | 52 | # Save last section 53 | if current_section: 54 | sections[current_section] = "\n".join(current_content).strip() 55 | 56 | return sections 57 | 58 | 59 | def validate_prompt_file(file_path: Path) -> Tuple[bool, List[str]]: 60 | """Validate a single prompt file against the template.""" 61 | errors = [] 62 | 63 | try: 64 | with open(file_path, encoding="utf-8") as f: 65 | content = f.read() 66 | except Exception as e: 67 | return False, [f"Could not read file: {e}"] 68 | 69 | # Extract sections 70 | sections = extract_sections(content) 71 | 72 | # Check for required sections 73 | missing_sections = [] 74 | for required_section in REQUIRED_SECTIONS: 75 | if required_section not in sections: 76 | missing_sections.append(required_section) 77 | elif not sections[required_section].strip(): 78 | errors.append(f"Section '{required_section}' is empty") 79 | 80 | if missing_sections: 81 | errors.append(f"Missing required sections: {', '.join(missing_sections)}") 82 | 83 | # Check section order 84 | found_sections = [s for s in REQUIRED_SECTIONS if s in sections] 85 | section_headers = [] 86 | 87 | for line in content.split("\n"): 88 | section_match = re.match(r"^## (.+)$", line.strip()) 89 | if section_match: 90 | section_name = section_match.group(1) 91 | if section_name in REQUIRED_SECTIONS: 92 | section_headers.append(section_name) 93 | 94 | if section_headers != found_sections: 95 | errors.append( 96 | f"Sections are not in the correct order. Expected: {', '.join(REQUIRED_SECTIONS)}" 97 | ) 98 | 99 | # Validate specific section content 100 | if "Tags" in sections: 101 | tags_content = sections["Tags"].strip() 102 | if not tags_content.startswith("`") or not tags_content.endswith("`"): 103 | errors.append("Tags section should be formatted as code with backticks") 104 | 105 | if "Prompt" in sections: 106 | prompt_content = sections["Prompt"].strip() 107 | if not prompt_content.startswith("```") or not prompt_content.endswith("```"): 108 | errors.append( 109 | "Prompt section should contain a properly formatted code block" 110 | ) 111 | 112 | return len(errors) == 0, errors 113 | 114 | 115 | def find_prompt_files(root_path: Path) -> List[Path]: 116 | """Find all prompt markdown files.""" 117 | prompt_files = [] 118 | 119 | # Skip template files and root-level docs 120 | skip_patterns = [ 121 | "template", 122 | "README", 123 | "CONTRIBUTING", 124 | "SECURITY", 125 | "LICENSE", 126 | ] 127 | 128 | for md_file in root_path.rglob("*.md"): 129 | # Skip if it's in .github, templates, or examples directory 130 | excluded_dirs = [".github", "templates", "examples"] 131 | if any(excluded_dir in md_file.parts for excluded_dir in excluded_dirs): 132 | continue 133 | 134 | # Skip if filename contains skip patterns 135 | if any(pattern.lower() in md_file.name.lower() for pattern in skip_patterns): 136 | continue 137 | 138 | prompt_files.append(md_file) 139 | 140 | return sorted(prompt_files) 141 | 142 | 143 | def main(): 144 | """Main function to run compliance checks.""" 145 | root_path = Path(".") 146 | 147 | print("Prompt Library Template Compliance Checker") 148 | print("=" * 50) 149 | 150 | prompt_files = find_prompt_files(root_path) 151 | 152 | if not prompt_files: 153 | print("ERROR: No prompt files found!") 154 | return 1 155 | 156 | print(f"Found {len(prompt_files)} prompt files to validate") 157 | print() 158 | 159 | total_files = len(prompt_files) 160 | valid_files = 0 161 | 162 | for file_path in prompt_files: 163 | relative_path = file_path.relative_to(root_path) 164 | is_valid, errors = validate_prompt_file(file_path) 165 | 166 | if is_valid: 167 | print(f"PASS: {relative_path}") 168 | valid_files += 1 169 | else: 170 | print(f"FAIL: {relative_path}") 171 | for error in errors: 172 | print(f" * {error}") 173 | print() 174 | 175 | print("=" * 50) 176 | print(f"Summary: {valid_files}/{total_files} files passed validation") 177 | 178 | if valid_files == total_files: 179 | print("SUCCESS: All prompt files are compliant with the template!") 180 | return 0 181 | else: 182 | print(f"WARNING: {total_files - valid_files} files need attention") 183 | return 1 184 | 185 | 186 | if __name__ == "__main__": 187 | sys.exit(main()) 188 | -------------------------------------------------------------------------------- /scripts/check-internal-links.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | """ 3 | Internal file link checker for the prompt library. 4 | This script validates internal file links (relative paths) while ignoring external HTTP(S) links. 5 | """ 6 | 7 | import argparse 8 | import re 9 | import sys 10 | from pathlib import Path 11 | 12 | 13 | def find_markdown_files(root_path: Path) -> list[Path]: 14 | """Find all markdown files in the repository.""" 15 | return list(root_path.rglob("*.md")) 16 | 17 | 18 | def extract_internal_links(content: str, file_path: Path) -> list[tuple[str, int, str]]: 19 | """ 20 | Extract internal file links from markdown content. 21 | Returns list of tuples: (link_text, line_number, link_target) 22 | """ 23 | internal_links = [] 24 | lines = content.split("\n") 25 | 26 | # Patterns for different markdown link formats 27 | patterns = [ 28 | # [text](path) - standard markdown links 29 | r"\[([^\]]*)\]\(([^)]+)\)", 30 | # [text]: path - reference-style links 31 | r"^\s*\[([^\]]+)\]:\s*(.+)$", 32 | ] 33 | 34 | for line_num, line in enumerate(lines, 1): 35 | for pattern in patterns: 36 | matches = re.finditer(pattern, line, re.MULTILINE) 37 | for match in matches: 38 | link_text = match.group(1) 39 | link_target = match.group(2).strip() 40 | 41 | # Skip HTTP(S) links 42 | if link_target.startswith(("http://", "https://")): 43 | continue 44 | 45 | # Skip mailto links 46 | if link_target.startswith("mailto:"): 47 | continue 48 | 49 | # Skip fragment-only links (anchors within same page) 50 | if link_target.startswith("#"): 51 | continue 52 | 53 | # Remove fragment part from file links 54 | clean_target = link_target.split("#")[0] 55 | 56 | # Skip empty targets 57 | if not clean_target: 58 | continue 59 | 60 | internal_links.append((link_text, line_num, clean_target)) 61 | 62 | return internal_links 63 | 64 | 65 | def resolve_relative_path(source_file: Path, target_path: str) -> Path: 66 | """Resolve a relative path from the source file's directory.""" 67 | source_dir = source_file.parent 68 | 69 | # Handle different path formats 70 | if target_path.startswith("./"): 71 | target_path = target_path[2:] 72 | elif target_path.startswith("../"): 73 | # Keep the ../ for proper resolution 74 | pass 75 | 76 | return (source_dir / target_path).resolve() 77 | 78 | 79 | def check_file_links(root_path: Path, verbose: bool = False) -> tuple[int, int]: 80 | """ 81 | Check all internal file links in markdown files. 82 | Returns tuple: (total_links_checked, broken_links_count) 83 | """ 84 | markdown_files = find_markdown_files(root_path) 85 | total_links = 0 86 | broken_links = 0 87 | 88 | print(f"🔍 Checking internal file links in {len(markdown_files)} markdown files...") 89 | 90 | for md_file in markdown_files: 91 | try: 92 | content = md_file.read_text(encoding="utf-8") 93 | internal_links = extract_internal_links(content, md_file) 94 | 95 | if verbose and internal_links: 96 | print(f"\n📄 {md_file.relative_to(root_path)}") 97 | 98 | for link_text, line_num, link_target in internal_links: 99 | total_links += 1 100 | 101 | # Resolve the target path 102 | try: 103 | resolved_path = resolve_relative_path(md_file, link_target) 104 | 105 | # Check if the target file exists 106 | if not resolved_path.exists(): 107 | broken_links += 1 108 | print( 109 | f"❌ BROKEN LINK in {md_file.relative_to(root_path)}:{line_num}" 110 | ) 111 | print(f" Link text: '{link_text}'") 112 | print(f" Target: '{link_target}'") 113 | print(f" Resolved to: {resolved_path}") 114 | print() 115 | elif verbose: 116 | print(f" ✅ Line {line_num}: '{link_text}' → {link_target}") 117 | 118 | except Exception as e: 119 | broken_links += 1 120 | print( 121 | f"❌ ERROR resolving link in " 122 | f"{md_file.relative_to(root_path)}:{line_num}" 123 | ) 124 | print(f" Link text: '{link_text}'") 125 | print(f" Target: '{link_target}'") 126 | print(f" Error: {e}") 127 | print() 128 | 129 | except Exception as e: 130 | print(f"❌ ERROR reading file {md_file.relative_to(root_path)}: {e}") 131 | continue 132 | 133 | return total_links, broken_links 134 | 135 | 136 | def main(): 137 | """Main function.""" 138 | parser = argparse.ArgumentParser( 139 | description="Check internal file links in markdown files" 140 | ) 141 | parser.add_argument( 142 | "--root", 143 | type=Path, 144 | default=Path.cwd(), 145 | help="Root directory to scan (default: current directory)", 146 | ) 147 | parser.add_argument( 148 | "--verbose", 149 | "-v", 150 | action="store_true", 151 | help="Show all links checked, not just broken ones", 152 | ) 153 | 154 | args = parser.parse_args() 155 | 156 | if not args.root.exists(): 157 | print(f"❌ Root directory does not exist: {args.root}") 158 | return 1 159 | 160 | print("🔗 Internal File Link Checker") 161 | print("=" * 40) 162 | print(f"Root directory: {args.root.absolute()}") 163 | print() 164 | 165 | total_links, broken_links = check_file_links(args.root, args.verbose) 166 | 167 | print("=" * 40) 168 | print("📊 Results:") 169 | print(f" Total internal links checked: {total_links}") 170 | print(f" Broken links found: {broken_links}") 171 | 172 | if broken_links == 0: 173 | print("🎉 All internal file links are valid!") 174 | return 0 175 | else: 176 | print(f"❌ Found {broken_links} broken internal file links") 177 | return 1 178 | 179 | 180 | if __name__ == "__main__": 181 | sys.exit(main()) 182 | -------------------------------------------------------------------------------- /examples/development-code-review-example.md: -------------------------------------------------------------------------------- 1 | # Code Review Example 2 | 3 | ## Scenario 4 | 5 | A senior developer is reviewing a junior developer's pull request for a user authentication function. The code works but needs improvement for production readiness. 6 | 7 | ## Input Provided to AI 8 | 9 | **Code to Review:** 10 | 11 | ```python 12 | def login_user(username, password): 13 | users = [ 14 | {"username": "admin", "password": "admin123"}, 15 | {"username": "user1", "password": "password"}, 16 | {"username": "user2", "password": "test123"} 17 | ] 18 | 19 | for user in users: 20 | if user["username"] == username and user["password"] == password: 21 | return True 22 | return False 23 | 24 | def register_user(username, password): 25 | if len(password) < 6: 26 | return "Password too short" 27 | return "User registered successfully" 28 | ``` 29 | 30 | **Focus Areas:** Security, best practices, error handling 31 | 32 | ## AI Output 33 | 34 | ### Code Review Analysis 35 | 36 | **CRITICAL Security Issues:** 37 | 38 | 1. **Plaintext Password Storage** (Line 3-7) 39 | - **Issue**: Passwords stored in plaintext arrays 40 | - **Risk**: Complete credential exposure if code is compromised 41 | - **Fix**: Implement proper password hashing with bcrypt/argon2 42 | 43 | 2. **Hardcoded User Database** (Line 2-6) 44 | - **Issue**: User credentials hardcoded in source code 45 | - **Risk**: Credentials visible in version control 46 | - **Fix**: Move to secure database with environment-based config 47 | 48 | **HIGH Priority Issues:** 49 | 50 | 1. **No Input Validation** (Both functions) 51 | - **Issue**: No validation for None/empty inputs 52 | - **Risk**: Runtime errors and potential injection attacks 53 | - **Fix**: Add comprehensive input sanitization 54 | 55 | 2. **Weak Password Policy** (Line 2, register_user) 56 | - **Issue**: Only checks length, no complexity requirements 57 | - **Risk**: Vulnerable to brute force attacks 58 | - **Fix**: Implement strong password validation 59 | 60 | **MEDIUM Priority Issues:** 61 | 62 | 1. **No Rate Limiting** 63 | - **Issue**: Unlimited login attempts possible 64 | - **Risk**: Brute force vulnerability 65 | - **Fix**: Add login attempt tracking and temporary lockouts 66 | 67 | 2. **Poor Error Messages** (register_user) 68 | - **Issue**: Generic error messages 69 | - **Risk**: Poor user experience 70 | - **Fix**: Provide specific, helpful error descriptions 71 | 72 | ### Recommended Improvements 73 | 74 | ```python 75 | import bcrypt 76 | import re 77 | from typing import Optional 78 | from datetime import datetime, timedelta 79 | 80 | class UserAuthenticator: 81 | def __init__(self, db_connection): 82 | self.db = db_connection 83 | self.failed_attempts = {} 84 | self.lockout_duration = timedelta(minutes=15) 85 | 86 | def login_user(self, username: str, password: str) -> dict: 87 | # Input validation 88 | if not username or not password: 89 | return {"success": False, "error": "Username and password required"} 90 | 91 | # Check for account lockout 92 | if self._is_account_locked(username): 93 | return {"success": False, "error": "Account temporarily locked"} 94 | 95 | # Fetch user from database 96 | user = self.db.get_user_by_username(username) 97 | if not user: 98 | self._record_failed_attempt(username) 99 | return {"success": False, "error": "Invalid credentials"} 100 | 101 | # Verify password hash 102 | if bcrypt.checkpw(password.encode('utf-8'), user['password_hash']): 103 | self._clear_failed_attempts(username) 104 | return {"success": True, "user_id": user['id']} 105 | else: 106 | self._record_failed_attempt(username) 107 | return {"success": False, "error": "Invalid credentials"} 108 | 109 | def register_user(self, username: str, password: str, email: str) -> dict: 110 | # Comprehensive validation 111 | validation_result = self._validate_registration_data(username, password, email) 112 | if not validation_result["valid"]: 113 | return {"success": False, "errors": validation_result["errors"]} 114 | 115 | # Check if user exists 116 | if self.db.user_exists(username, email): 117 | return {"success": False, "error": "User already exists"} 118 | 119 | # Hash password and save user 120 | password_hash = bcrypt.hashpw(password.encode('utf-8'), bcrypt.gensalt()) 121 | user_id = self.db.create_user(username, password_hash, email) 122 | 123 | return {"success": True, "user_id": user_id} 124 | 125 | def _validate_registration_data(self, username: str, password: str, email: str) -> dict: 126 | errors = [] 127 | 128 | if not username or len(username) < 3: 129 | errors.append("Username must be at least 3 characters") 130 | 131 | if not self._is_strong_password(password): 132 | errors.append("Password must be at least 8 characters with uppercase, lowercase, number, and special character") 133 | 134 | if not re.match(r'^[^@]+@[^@]+\.[^@]+$', email or ''): 135 | errors.append("Valid email address required") 136 | 137 | return {"valid": len(errors) == 0, "errors": errors} 138 | ``` 139 | 140 | ## Analysis 141 | 142 | ### What Worked Well 143 | 144 | - Clear identification of critical security vulnerabilities 145 | - Prioritized issues by severity level 146 | - Provided specific, actionable fixes 147 | - Included improved code example with proper patterns 148 | 149 | ### Areas for Improvement 150 | 151 | - Could include more specific examples of attack vectors 152 | - Missing discussion of logging and monitoring requirements 153 | - Could suggest specific testing strategies for the fixes 154 | 155 | ### Key Takeaways 156 | 157 | 1. Security should always be the top priority in code reviews 158 | 2. Provide constructive, specific feedback with examples 159 | 3. Explain the "why" behind recommendations 160 | 4. Offer concrete solutions, not just problem identification 161 | 162 | ## Variations 163 | 164 | - **Quick Review**: Focus only on critical issues for faster turnaround 165 | - **Mentoring Style**: Include more educational context for junior developers 166 | - **Production Focus**: Emphasize scalability and monitoring aspects 167 | - **Security Audit**: Deep dive into all potential security vulnerabilities 168 | -------------------------------------------------------------------------------- /development/refactoring-assistant.md: -------------------------------------------------------------------------------- 1 | # Refactoring Assistant 2 | 3 | ## Description 4 | 5 | This prompt helps you analyze and refactor existing code to improve its structure, readability, maintainability, and performance while preserving functionality. 6 | 7 | ## Usage 8 | 9 | Perfect for improving legacy code, preparing code for new features, reducing technical debt, and following best practices and design patterns. 10 | 11 | ## Prompt 12 | 13 | ```markdown 14 | You are an expert code refactoring assistant. I need help refactoring the following code to improve its quality while maintaining the same functionality. 15 | 16 | **Code to refactor:** 17 | ``` 18 | 19 | [INSERT_CODE_HERE] 20 | 21 | ``` 22 | 23 | **Context:** 24 | - Programming language: [LANGUAGE] 25 | - Framework/library: [FRAMEWORK_IF_ANY] 26 | - Current issues: [DESCRIBE_PROBLEMS] 27 | - Performance requirements: [PERFORMANCE_NEEDS] 28 | - Coding standards: [STYLE_GUIDE_IF_ANY] 29 | 30 | Please analyze the code and provide: 31 | 32 | 1. **Code Quality Assessment:** 33 | - Identify code smells and anti-patterns 34 | - Assess readability, maintainability, and performance 35 | - Check adherence to SOLID principles 36 | - Evaluate naming conventions and structure 37 | 38 | 2. **Refactoring Plan:** 39 | - List specific improvements needed 40 | - Prioritize changes by impact and complexity 41 | - Identify any breaking changes 42 | - Suggest design patterns if applicable 43 | 44 | 3. **Refactored Code:** 45 | - Provide the improved version 46 | - Add clear comments explaining changes 47 | - Ensure functionality is preserved 48 | - Follow best practices for the language/framework 49 | 50 | 4. **Explanation:** 51 | - Explain what was changed and why 52 | - Highlight performance improvements 53 | - Note any new dependencies or requirements 54 | - Provide migration steps if needed 55 | 56 | 5. **Testing Recommendations:** 57 | - Suggest test cases to verify functionality 58 | - Recommend regression testing approach 59 | - Identify potential edge cases to test 60 | 61 | Focus on making the code more readable, maintainable, and efficient while following established best practices. 62 | ``` 63 | 64 | ## Example Input 65 | 66 | ```markdown 67 | Code to refactor: 68 | ```javascript 69 | function processUsers(users) { 70 | var result = []; 71 | for (var i = 0; i < users.length; i++) { 72 | if (users[i].age >= 18 && users[i].active == true) { 73 | var userData = {}; 74 | userData.name = users[i].firstName + " " + users[i].lastName; 75 | userData.email = users[i].email; 76 | userData.category = users[i].age >= 65 ? "senior" : "adult"; 77 | result.push(userData); 78 | } 79 | } 80 | return result; 81 | } 82 | ``` 83 | 84 | Context: 85 | 86 | - Programming language: JavaScript (ES6+) 87 | - Framework/library: None 88 | - Current issues: Old syntax, not functional, poor readability 89 | - Performance requirements: Handle arrays up to 10,000 users 90 | - Coding standards: ES6+, functional programming preferred 91 | 92 | ``` 93 | 94 | ## Example Output 95 | ``` 96 | 97 | ## Code Quality Assessment 98 | 99 | - Uses var instead of const/let 100 | - Traditional for loop instead of array methods 101 | - Loose equality comparison (==) 102 | - Imperative style instead of functional 103 | - No input validation 104 | - String concatenation instead of template literals 105 | 106 | ## Refactoring Plan 107 | 108 | 1. Convert to functional programming style 109 | 2. Use modern ES6+ syntax 110 | 3. Add input validation 111 | 4. Extract helper functions for better readability 112 | 5. Use array methods for better performance 113 | 114 | ## Refactored Code 115 | 116 | ```javascript 117 | /** 118 | * Processes users array to extract active adult users with formatted data 119 | * @param {Array} users - Array of user objects 120 | * @returns {Array} Filtered and formatted user data 121 | */ 122 | const processUsers = (users = []) => { 123 | if (!Array.isArray(users)) { 124 | throw new Error('Input must be an array'); 125 | } 126 | 127 | const isEligibleUser = (user) => 128 | user?.age >= 18 && user?.active === true; 129 | 130 | const formatUserData = (user) => ({ 131 | name: `${user.firstName} ${user.lastName}`, 132 | email: user.email, 133 | category: user.age >= 65 ? 'senior' : 'adult' 134 | }); 135 | 136 | return users 137 | .filter(isEligibleUser) 138 | .map(formatUserData); 139 | }; 140 | ``` 141 | 142 | ## Explanation 143 | 144 | - **Modern syntax**: Used const, arrow functions, template literals 145 | - **Functional approach**: Replaced imperative loop with filter/map chain 146 | - **Better readability**: Extracted helper functions with descriptive names 147 | - **Input validation**: Added type checking and default parameter 148 | - **Performance**: Array methods are optimized and more readable 149 | - **Strict equality**: Used === instead of == 150 | - **Optional chaining**: Added ?. for safer property access 151 | 152 | ## Testing Recommendations 153 | 154 | - Test with empty array, null, undefined inputs 155 | - Test with users of various ages (under 18, 18-64, 65+) 156 | - Test with inactive users 157 | - Test with malformed user objects 158 | - Performance test with 10,000+ user array 159 | 160 | ``` 161 | 162 | ## Variations 163 | 164 | ### Legacy Code Modernization 165 | Focus specifically on updating old syntax and patterns to modern standards while maintaining backward compatibility. 166 | 167 | ### Performance-Focused Refactoring 168 | Emphasize optimization for speed, memory usage, and scalability in the refactoring suggestions. 169 | 170 | ### Security-Focused Refactoring 171 | Prioritize identifying and fixing security vulnerabilities, input validation, and secure coding practices. 172 | 173 | ## Tips 174 | - Always preserve the original functionality unless explicitly asked to change it 175 | - Test thoroughly after refactoring to ensure no regressions 176 | - Refactor in small, incremental steps rather than large rewrites 177 | - Consider the team's skill level when suggesting modern patterns 178 | - Document any breaking changes clearly 179 | 180 | ## Related Prompts 181 | - [Code Review](./code-review.md) - For reviewing code quality 182 | - [Test Case Generator](./test-case-generator.md) - For creating tests after refactoring 183 | - [Documentation Generator](./documentation-generator.md) - For updating docs after refactoring 184 | 185 | ## Tags 186 | `refactoring` `code-quality` `best-practices` `modernization` `optimization` `maintainability` `technical-debt` `clean-code` 187 | -------------------------------------------------------------------------------- /development/documentation-generator.md: -------------------------------------------------------------------------------- 1 | # Documentation Generator 2 | 3 | ## Description 4 | 5 | Automatically generates comprehensive documentation from code, including API documentation, README files, inline comments, and user guides. Supports multiple programming languages and documentation formats. 6 | 7 | ## Usage 8 | 9 | Provide your code and specify the type of documentation needed. Works best with well-structured code that has clear function/class definitions. Specify the target audience and format requirements. 10 | 11 | ## Prompt 12 | 13 | ```markdown 14 | Generate comprehensive documentation for the following code. Please create: 15 | 16 | 1. **API Documentation** 17 | - Function/method signatures 18 | - Parameter descriptions with types 19 | - Return value specifications 20 | - Usage examples 21 | - Error conditions 22 | 23 | 2. **Inline Comments** 24 | - Code explanation comments 25 | - Complex logic breakdown 26 | - Algorithm descriptions 27 | - Performance considerations 28 | 29 | 3. **README Section** (if applicable) 30 | - Purpose and overview 31 | - Installation/setup instructions 32 | - Basic usage examples 33 | - Configuration options 34 | 35 | 4. **User Guide Elements** 36 | - Step-by-step usage instructions 37 | - Common use cases 38 | - Troubleshooting tips 39 | - Best practices 40 | 41 | Documentation requirements: 42 | - Target audience: [developers/end-users/technical writers] 43 | - Format: [Markdown/JSDoc/Sphinx/other] 44 | - Documentation style: [comprehensive/concise/beginner-friendly] 45 | 46 | Code to document: 47 | ``` 48 | 49 | [YOUR CODE HERE] 50 | 51 | ``` 52 | 53 | Additional context: 54 | [PROJECT PURPOSE, DEPENDENCIES, SPECIAL REQUIREMENTS] 55 | ``` 56 | 57 | ## Example Input 58 | 59 | ```markdown 60 | ```python 61 | import requests 62 | import json 63 | from typing import Dict, List, Optional 64 | 65 | class WeatherAPI: 66 | def __init__(self, api_key: str, base_url: str = "https://api.weather.com"): 67 | self.api_key = api_key 68 | self.base_url = base_url 69 | 70 | def get_current_weather(self, city: str, units: str = "metric") -> Dict: 71 | endpoint = f"{self.base_url}/current" 72 | params = { 73 | "city": city, 74 | "units": units, 75 | "api_key": self.api_key 76 | } 77 | response = requests.get(endpoint, params=params) 78 | response.raise_for_status() 79 | return response.json() 80 | 81 | def get_forecast(self, city: str, days: int = 5) -> List[Dict]: 82 | endpoint = f"{self.base_url}/forecast" 83 | params = { 84 | "city": city, 85 | "days": days, 86 | "api_key": self.api_key 87 | } 88 | response = requests.get(endpoint, params=params) 89 | response.raise_for_status() 90 | return response.json()["forecast"] 91 | ``` 92 | 93 | ``` 94 | ## Example Output 95 | 96 | ```markdown 97 | # WeatherAPI Documentation 98 | 99 | ## Overview 100 | The WeatherAPI class provides a simple interface to fetch current weather data and forecasts for any city using a weather service API. 101 | 102 | ## Installation 103 | ```bash 104 | pip install requests 105 | ``` 106 | 107 | ## Quick Start 108 | 109 | ```python 110 | from weather_api import WeatherAPI 111 | 112 | # Initialize the API client 113 | weather = WeatherAPI(api_key="your_api_key_here") 114 | 115 | # Get current weather 116 | current = weather.get_current_weather("New York") 117 | print(f"Temperature: {current['temperature']}°C") 118 | 119 | # Get 7-day forecast 120 | forecast = weather.get_forecast("London", days=7) 121 | for day in forecast: 122 | print(f"{day['date']}: {day['temperature']}°C, {day['description']}") 123 | ``` 124 | 125 | ## API Reference 126 | 127 | ### Class: WeatherAPI 128 | 129 | #### Constructor 130 | 131 | ```python 132 | WeatherAPI(api_key: str, base_url: str = "https://api.weather.com") 133 | ``` 134 | 135 | **Parameters:** 136 | 137 | - `api_key` (str): Your API key for the weather service 138 | - `base_url` (str, optional): Base URL for the weather API. Defaults to "" 139 | 140 | **Example:** 141 | 142 | ```python 143 | weather = WeatherAPI("your_api_key", "https://custom-weather-api.com") 144 | ``` 145 | 146 | #### get_current_weather() 147 | 148 | ```python 149 | get_current_weather(city: str, units: str = "metric") -> Dict 150 | ``` 151 | 152 | Retrieves current weather conditions for the specified city. 153 | 154 | **Parameters:** 155 | 156 | - `city` (str): Name of the city to get weather for 157 | - `units` (str, optional): Temperature units ("metric", "imperial", "kelvin"). Defaults to "metric" 158 | 159 | **Returns:** 160 | 161 | - `Dict`: Weather data containing temperature, humidity, description, etc. 162 | 163 | **Raises:** 164 | 165 | - `requests.HTTPError`: If the API request fails 166 | - `requests.ConnectionError`: If unable to connect to the API 167 | 168 | **Example:** 169 | 170 | ```python 171 | weather_data = weather.get_current_weather("Tokyo", units="imperial") 172 | temp_f = weather_data["temperature"] # Temperature in Fahrenheit 173 | ``` 174 | 175 | #### get_forecast() 176 | 177 | ```python 178 | get_forecast(city: str, days: int = 5) -> List[Dict] 179 | ``` 180 | 181 | Retrieves weather forecast for the specified city. 182 | 183 | **Parameters:** 184 | 185 | - `city` (str): Name of the city to get forecast for 186 | - `days` (int, optional): Number of days to forecast (1-10). Defaults to 5 187 | 188 | **Returns:** 189 | 190 | - `List[Dict]`: List of daily forecast data 191 | 192 | **Raises:** 193 | 194 | - `requests.HTTPError`: If the API request fails 195 | - `ValueError`: If days parameter is outside valid range 196 | 197 | **Example:** 198 | 199 | ```python 200 | forecast = weather.get_forecast("Paris", days=3) 201 | tomorrow = forecast[1] # Second day (tomorrow) 202 | ``` 203 | 204 | ## Error Handling 205 | 206 | All methods may raise HTTP-related exceptions. Implement proper error handling: 207 | 208 | ```python 209 | try: 210 | weather_data = weather.get_current_weather("InvalidCity") 211 | except requests.HTTPError as e: 212 | print(f"API error: {e}") 213 | except requests.ConnectionError: 214 | print("Unable to connect to weather service") 215 | ``` 216 | 217 | ## Best Practices 218 | 219 | - Store your API key securely (environment variables) 220 | - Implement rate limiting to avoid API quota issues 221 | - Cache responses when appropriate to reduce API calls 222 | - Validate city names before making requests 223 | 224 | ``` 225 | 226 | ## Variations 227 | - **API-Only**: Focus only on API documentation with technical details 228 | - **User Manual**: Create end-user focused documentation with tutorials 229 | - **Inline Comments**: Generate only code comments and docstrings 230 | - **Architecture Docs**: Create high-level system architecture documentation 231 | 232 | ## Tips 233 | - Include the programming language for language-specific documentation standards 234 | - Specify if you need examples for specific use cases 235 | - Mention any existing documentation standards or tools used in your project 236 | - Provide context about the intended users of the documentation 237 | 238 | ## Related Prompts 239 | - `code-review.md` - For improving code before documenting 240 | - `architecture-planner.md` - For system-level documentation 241 | - `test-case-generator.md` - For creating documented test examples 242 | 243 | ## Tags 244 | `documentation` `api-docs` `comments` `readme` `development` `technical-writing` 245 | -------------------------------------------------------------------------------- /education/lesson-plan-generator.md: -------------------------------------------------------------------------------- 1 | # Lesson Plan Generator 2 | 3 | ## Description 4 | 5 | A comprehensive prompt for creating detailed, structured lesson plans for any subject, grade level, or learning objective. This prompt generates complete lesson plans with clear objectives, activities, assessments, and differentiation strategies. 6 | 7 | ## Usage 8 | 9 | Use this prompt when you need to create engaging, educational lesson plans that follow best pedagogical practices. Ideal for teachers, instructional designers, tutors, and educational content creators. 10 | 11 | ## Prompt 12 | 13 | ```markdown 14 | You are an expert educational designer and experienced teacher. Create a comprehensive lesson plan based on the following requirements: 15 | 16 | **Subject:** [SUBJECT] 17 | **Grade Level/Age Group:** [GRADE_LEVEL] 18 | **Topic:** [TOPIC] 19 | **Lesson Duration:** [DURATION] 20 | **Learning Objectives:** [OBJECTIVES] 21 | **Special Considerations:** [CONSIDERATIONS] 22 | 23 | Please create a detailed lesson plan that includes: 24 | 25 | 1. **Lesson Overview** 26 | - Clear, measurable learning objectives 27 | - Brief summary of lesson content 28 | - Prerequisites and prior knowledge needed 29 | 30 | 2. **Materials and Resources** 31 | - Required materials and supplies 32 | - Technology needs 33 | - Handouts or worksheets 34 | - Reference materials 35 | 36 | 3. **Lesson Structure** 37 | - Opening/Hook (5-10 minutes) 38 | - Introduction/Review (10-15 minutes) 39 | - Main Activities (detailed breakdown) 40 | - Practice/Application 41 | - Closure/Summary 42 | 43 | 4. **Teaching Strategies** 44 | - Instructional methods used 45 | - Differentiation for various learning styles 46 | - Accommodations for special needs 47 | - Student engagement techniques 48 | 49 | 5. **Assessment Methods** 50 | - Formative assessment strategies 51 | - Summative assessment plan 52 | - Success criteria and rubrics 53 | - Exit tickets or quick checks 54 | 55 | 6. **Extension Activities** 56 | - Enrichment for advanced learners 57 | - Remediation for struggling students 58 | - Homework or follow-up activities 59 | 60 | 7. **Reflection Questions** 61 | - Questions for teacher self-reflection 62 | - Areas for improvement 63 | - Student feedback collection 64 | 65 | Ensure the lesson plan is age-appropriate, engaging, and aligns with educational standards. Include specific timing for each activity and clear instructions for implementation. 66 | ``` 67 | 68 | ## Example Input 69 | 70 | **Subject:** Science 71 | **Grade Level/Age Group:** 5th Grade (Ages 10-11) 72 | **Topic:** The Water Cycle 73 | **Lesson Duration:** 45 minutes 74 | **Learning Objectives:** Students will be able to identify and explain the four main stages of the water cycle and describe how water moves through the environment 75 | **Special Considerations:** Class includes 3 ELL students and 2 students with ADHD 76 | 77 | ## Example Output 78 | 79 | ### 5th Grade Science Lesson Plan: The Water Cycle 80 | 81 | #### Lesson Overview 82 | 83 | **Learning Objectives:** 84 | 85 | - Students will identify the four stages of the water cycle (evaporation, condensation, precipitation, collection) 86 | - Students will explain how water moves through each stage using scientific vocabulary 87 | - Students will create a labeled diagram showing the water cycle process 88 | 89 | **Lesson Summary:** Interactive exploration of the water cycle through multimedia, hands-on demonstration, and collaborative diagram creation. 90 | 91 | **Prerequisites:** Basic understanding of states of matter (solid, liquid, gas) 92 | 93 | ### Materials and Resources 94 | 95 | - Interactive whiteboard/projector 96 | - Water cycle video (3 minutes) 97 | - Clear containers, hot water, ice cubes for demonstration 98 | - Water cycle diagram handouts 99 | - Colored pencils/markers 100 | - Vocabulary cards with visuals 101 | - Digital timer 102 | 103 | ### Lesson Structure 104 | 105 | ### Opening Hook (5 minutes) 106 | 107 | - Show dramatic time-lapse video of rain formation 108 | - Ask: "Where does rain come from? Where does it go?" 109 | - Record student predictions on whiteboard 110 | 111 | ### Introduction/Review (10 minutes) 112 | 113 | - Quick review: "What are the three states of water?" 114 | - Introduce water cycle vocabulary with visual cards 115 | - Preview today's learning goals 116 | 117 | ### Main Activity 1: Water Cycle Demonstration (15 minutes) 118 | 119 | - Live demonstration using hot water and ice 120 | - Students observe and predict what happens 121 | - Connect observation to real-world water cycle 122 | - Introduce scientific vocabulary for each stage 123 | 124 | ### Main Activity 2: Collaborative Diagram Creation (10 minutes) 125 | 126 | - Pairs work together to label water cycle diagram 127 | - ELL students paired with strong English speakers 128 | - Teacher circulates, providing targeted support 129 | 130 | ### Closure/Summary (5 minutes) 131 | 132 | - Quick gallery walk of student diagrams 133 | - Exit ticket: Draw one stage of the water cycle and explain it 134 | 135 | ### Teaching Strategies 136 | 137 | **Instructional Methods:** 138 | 139 | - Visual demonstrations and multimedia 140 | - Collaborative learning 141 | - Hands-on experimentation 142 | - Graphic organizers 143 | 144 | **Differentiation:** 145 | 146 | - Visual vocabulary cards for ELL students 147 | - Movement breaks for ADHD students 148 | - Audio and visual learning components 149 | - Flexible pairing arrangements 150 | 151 | **Student Engagement:** 152 | 153 | - Interactive predictions and observations 154 | - Real-world connections 155 | - Collaborative work opportunities 156 | 157 | ## Assessment Methods 158 | 159 | **Formative Assessment:** 160 | 161 | - Observation during demonstration 162 | - Peer discussion monitoring 163 | - Quick vocabulary checks 164 | 165 | **Summative Assessment:** 166 | 167 | - Labeled diagram accuracy (rubric provided) 168 | - Exit ticket explanations 169 | - Vocabulary usage in explanations 170 | 171 | **Success Criteria:** 172 | 173 | - Students can name all four stages 174 | - Students can explain one stage in detail 175 | - Students can identify water cycle in real scenarios 176 | 177 | ## Extension Activities 178 | 179 | **Enrichment:** 180 | 181 | - Research local water sources and their cycle journey 182 | - Create water cycle comic strip 183 | - Investigate how climate affects the water cycle 184 | 185 | **Remediation:** 186 | 187 | - Additional practice with vocabulary matching 188 | - Simplified diagram with guided support 189 | - Water cycle song or mnemonic device 190 | 191 | **Homework:** 192 | 193 | - Observe and record weather for one week 194 | - Find water cycle examples around home 195 | 196 | ## Reflection Questions 197 | 198 | - Did all students achieve the learning objectives? 199 | - Which activities were most/least engaging? 200 | - How effective were differentiation strategies? 201 | - What would you modify for next time? 202 | - How can you assess ELL student understanding more effectively? 203 | 204 | ## Variations 205 | 206 | - **Elementary (K-2):** Simplify to basic water movement, use more songs and movements 207 | - **Middle School:** Add detailed scientific processes, include human impact on water cycle 208 | - **High School:** Connect to climate change, atmospheric pressure, and global water systems 209 | - **Adult Learning:** Focus on practical applications, environmental implications 210 | 211 | ## Tips 212 | 213 | - Use consistent visual cues throughout the lesson 214 | - Provide sentence starters for ELL students 215 | - Build in movement opportunities every 10-15 minutes 216 | - Connect to local weather patterns students experience 217 | - Use real-world examples from students' lives 218 | 219 | ## Related Prompts 220 | 221 | - [Quiz Generator](quiz-generator.md) - Create assessments for this lesson 222 | 223 | ## Tags 224 | 225 | `education` `lesson-planning` `science` `elementary` `differentiation` `assessment` `collaborative-learning` 226 | -------------------------------------------------------------------------------- /development/bug-hunter.md: -------------------------------------------------------------------------------- 1 | # Bug Hunter - Debug Assistant 2 | 3 | ## Description 4 | 5 | A systematic debugging assistant that helps identify, analyze, and resolve software bugs and errors. Provides step-by-step troubleshooting approaches and suggests fixes for various types of issues. 6 | 7 | ## Usage 8 | 9 | Provide error messages, problematic code, or describe unexpected behavior. Include relevant context like environment, inputs, and expected vs. actual outcomes. Works across all programming languages. 10 | 11 | ## Prompt 12 | 13 | ```markdown 14 | Help me debug the following issue. Please provide a systematic analysis: 15 | 16 | **Problem Description:** 17 | [Describe what's happening vs. what should happen] 18 | 19 | **Error Message/Symptoms:** 20 | ``` 21 | 22 | [PASTE ERROR MESSAGE OR DESCRIBE SYMPTOMS] 23 | 24 | ``` 25 | 26 | **Code:** 27 | ``` 28 | 29 | [PASTE RELEVANT CODE] 30 | 31 | ``` 32 | 33 | **Environment:** 34 | - Programming Language: [language and version] 35 | - Framework/Libraries: [if applicable] 36 | - Operating System: [OS details] 37 | - Input Data: [sample inputs that cause the issue] 38 | 39 | Please analyze this by: 40 | 41 | 1. **Root Cause Analysis** 42 | - Identify the likely cause of the issue 43 | - Explain why this error occurs 44 | - Point to specific lines or components 45 | 46 | 2. **Debugging Strategy** 47 | - Step-by-step debugging approach 48 | - What to check or test first 49 | - Logging/debugging techniques to use 50 | 51 | 3. **Solution Options** 52 | - Primary fix recommendation 53 | - Alternative approaches 54 | - Preventive measures 55 | 56 | 4. **Testing Approach** 57 | - How to verify the fix works 58 | - Edge cases to test 59 | - Regression testing recommendations 60 | 61 | Additional context: 62 | [ANY OTHER RELEVANT INFORMATION] 63 | ``` 64 | 65 | ## Example Input 66 | 67 | ```markdown 68 | **Problem Description:** 69 | My Python web scraper randomly fails with connection errors, but the website is accessible in the browser. 70 | 71 | **Error Message:** 72 | ``` 73 | 74 | requests.exceptions.ConnectionError: HTTPSConnectionPool(host='example.com', port=443): 75 | Max retries exceeded with url: /api/data (Caused by NewConnectionError(': Failed to establish a new connection: [Errno 111] Connection refused')) 76 | 77 | ``` 78 | 79 | **Code:** 80 | ```python 81 | import requests 82 | import time 83 | 84 | def scrape_data(): 85 | urls = ["https://example.com/api/data", "https://example.com/api/users"] 86 | results = [] 87 | 88 | for url in urls: 89 | response = requests.get(url) 90 | results.append(response.json()) 91 | time.sleep(0.1) 92 | 93 | return results 94 | ``` 95 | 96 | **Environment:** 97 | 98 | - Python 3.9 99 | - requests library 2.28.1 100 | - Running on Ubuntu 20.04 101 | - Input: Multiple URLs being scraped in sequence 102 | 103 | ``` 104 | 105 | ## Example Output 106 | ``` 107 | 108 | ### Debug Analysis Report 109 | 110 | #### Root Cause Analysis 111 | 112 | **Primary Issue:** Rate limiting and connection management 113 | The error indicates connection refusal, which typically occurs when: 114 | 115 | 1. **Rate Limiting**: The server is blocking requests due to too many rapid connections 116 | 2. **Connection Pool Exhaustion**: Not properly managing HTTP connections 117 | 3. **Server-side blocking**: Anti-bot measures detecting automated requests 118 | 119 | **Specific Issues in Code:** 120 | 121 | - Line 8: No error handling for failed requests 122 | - Line 9: Very short delay (0.1s) may trigger rate limiting 123 | - No User-Agent header (common anti-bot trigger) 124 | - No retry mechanism for transient failures 125 | 126 | ### Debugging Strategy 127 | 128 | ### Immediate Debugging Steps 129 | 130 | 1. **Test connectivity**: `curl -I https://example.com/api/data` 131 | 2. **Check rate limits**: Increase delay to 2-3 seconds 132 | 3. **Monitor network**: Use `netstat` or Wireshark to see connection states 133 | 4. **Add logging**: Log response status codes before the error 134 | 135 | ### Code for Debugging 136 | 137 | ```python 138 | import logging 139 | logging.basicConfig(level=logging.DEBUG) 140 | 141 | # Add this before your request 142 | print(f"Attempting to connect to: {url}") 143 | response = requests.get(url, timeout=10) 144 | print(f"Response status: {response.status_code}") 145 | ``` 146 | 147 | ### Solution Options 148 | 149 | #### Primary Fix (Recommended) 150 | 151 | ```python 152 | import requests 153 | import time 154 | from requests.adapters import HTTPAdapter 155 | from urllib3.util.retry import Retry 156 | 157 | def scrape_data(): 158 | # Configure session with retry strategy 159 | session = requests.Session() 160 | retry_strategy = Retry( 161 | total=3, 162 | backoff_factor=1, 163 | status_forcelist=[429, 500, 502, 503, 504], 164 | ) 165 | adapter = HTTPAdapter(max_retries=retry_strategy) 166 | session.mount("http://", adapter) 167 | session.mount("https://", adapter) 168 | 169 | # Add headers to appear more like a browser 170 | headers = { 171 | 'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36', 172 | 'Accept': 'application/json', 173 | 'Accept-Language': 'en-US,en;q=0.9' 174 | } 175 | 176 | urls = ["https://example.com/api/data", "https://example.com/api/users"] 177 | results = [] 178 | 179 | for url in urls: 180 | try: 181 | response = session.get(url, headers=headers, timeout=30) 182 | response.raise_for_status() 183 | results.append(response.json()) 184 | # Respectful delay 185 | time.sleep(2) 186 | except requests.exceptions.RequestException as e: 187 | print(f"Error fetching {url}: {e}") 188 | continue 189 | 190 | return results 191 | ``` 192 | 193 | ### Alternative Approaches 194 | 195 | 1. **Use connection pooling**: Implement session reuse 196 | 2. **Implement exponential backoff**: Gradually increase delays 197 | 3. **Add proxy rotation**: If being blocked by IP 198 | 4. **Use async requests**: For better connection management 199 | 200 | ### Testing Approach 201 | 202 | #### Verification Steps 203 | 204 | 1. **Unit test**: Test with single URL first 205 | 2. **Load test**: Gradually increase number of URLs 206 | 3. **Network simulation**: Test with poor connectivity 207 | 4. **Edge cases**: Test with invalid URLs, timeouts 208 | 209 | ### Test Code 210 | 211 | ```python 212 | def test_scraper(): 213 | # Test single URL 214 | result = scrape_data_single("https://httpbin.org/json") 215 | assert result is not None 216 | 217 | # Test with delay 218 | start_time = time.time() 219 | scrape_data() 220 | duration = time.time() - start_time 221 | assert duration >= 2 # Ensure delay is working 222 | ``` 223 | 224 | ### Prevention Measures 225 | 226 | - Always implement proper error handling 227 | - Use session objects for connection reuse 228 | - Add appropriate delays between requests 229 | - Include realistic User-Agent headers 230 | - Implement retry logic for transient failures 231 | - Monitor rate limits and adjust accordingly 232 | 233 | ``` 234 | 235 | ## Variations 236 | - **Performance Issues**: Focus on optimization and profiling 237 | - **Security Bugs**: Emphasize vulnerability analysis and secure coding 238 | - **Integration Issues**: Focus on API and service integration problems 239 | - **Frontend Debugging**: Specialized for JavaScript/browser issues 240 | 241 | ## Tips 242 | - Include full error stack traces when possible 243 | - Provide minimal reproducible examples 244 | - Mention any recent changes that might have introduced the bug 245 | - Include relevant log files or console output 246 | - Specify if the issue is intermittent or consistent 247 | 248 | ## Related Prompts 249 | - `code-review.md` - For preventing bugs through better code quality 250 | - `test-case-generator.md` - For creating tests to catch bugs 251 | - `refactoring-assistant.md` - For improving code structure to prevent issues 252 | 253 | ## Tags 254 | `debugging` `troubleshooting` `error-analysis` `bug-fixing` `development` `problem-solving` 255 | -------------------------------------------------------------------------------- /writing/blog-post-generator.md: -------------------------------------------------------------------------------- 1 | # Blog Post Generator 2 | 3 | ## Description 4 | 5 | This prompt helps you create engaging, SEO-optimized blog posts for various topics, audiences, and purposes with compelling headlines, structured content, and call-to-actions. 6 | 7 | ## Usage 8 | 9 | Perfect for content marketing, thought leadership, educational content, product announcements, industry insights, and maintaining a consistent blog publishing schedule. 10 | 11 | ## Prompt 12 | 13 | ```markdown 14 | You are an expert content writer and blog strategist. I need help creating a compelling blog post that engages readers and achieves specific goals. 15 | 16 | **Blog Post Requirements:** 17 | - Topic: [MAIN_TOPIC] 18 | - Target audience: [AUDIENCE_DESCRIPTION] 19 | - Word count: [TARGET_LENGTH] 20 | - Tone: [PROFESSIONAL/CASUAL/EDUCATIONAL/CONVERSATIONAL] 21 | - Primary goal: [INFORM/PERSUADE/ENTERTAIN/CONVERT] 22 | - SEO keywords: [PRIMARY_AND_SECONDARY_KEYWORDS] 23 | 24 | **Additional Context:** 25 | - Industry/niche: [INDUSTRY] 26 | - Brand voice: [BRAND_PERSONALITY] 27 | - Call-to-action goal: [DESIRED_READER_ACTION] 28 | - Content format preference: [LIST/NARRATIVE/HOW_TO/CASE_STUDY] 29 | 30 | Please create a comprehensive blog post including: 31 | 32 | 1. **SEO-Optimized Headlines:** 33 | - 3-5 headline options with power words 34 | - Include primary keyword naturally 35 | - Consider emotional triggers and curiosity gaps 36 | - Aim for 50-60 characters for optimal SEO 37 | 38 | 2. **Blog Post Structure:** 39 | - Compelling introduction with hook 40 | - Clear subheadings (H2, H3) with keywords 41 | - Well-organized body paragraphs 42 | - Conclusion with summary and CTA 43 | - Meta description (150-160 characters) 44 | 45 | 3. **Content Elements:** 46 | - Opening hook to grab attention 47 | - Clear value proposition for readers 48 | - Supporting data, examples, or case studies 49 | - Actionable insights or takeaways 50 | - Internal linking opportunities 51 | - Visual content suggestions (images, infographics) 52 | 53 | 4. **SEO Optimization:** 54 | - Natural keyword integration 55 | - Optimized subheadings 56 | - Meta tags and descriptions 57 | - Related keyword suggestions 58 | - Content length appropriate for topic depth 59 | 60 | 5. **Engagement Features:** 61 | - Questions to encourage comments 62 | - Social sharing hooks 63 | - Reader polls or surveys ideas 64 | - Interactive elements suggestions 65 | 66 | Make the content valuable, actionable, and aligned with the target audience's needs and search intent. 67 | ``` 68 | 69 | ## Example Input 70 | 71 | ```markdown 72 | Topic: Remote work productivity tips for software developers 73 | Target audience: Mid-level software developers working remotely 74 | Word count: 1500-2000 words 75 | Tone: Professional but approachable 76 | Primary goal: Educate and provide actionable advice 77 | SEO keywords: remote work productivity, software developer productivity, work from home tips 78 | 79 | Industry/niche: Software development/tech 80 | Brand voice: Knowledgeable, supportive, practical 81 | Call-to-action goal: Subscribe to newsletter for more productivity content 82 | Content format preference: How-to guide with practical tips 83 | ``` 84 | 85 | ## Example Output 86 | 87 | ```markdown 88 | ## SEO-Optimized Headlines: 89 | 1. "15 Remote Work Productivity Tips Every Software Developer Needs in 2024" 90 | 2. "Boost Your Coding Efficiency: Ultimate Remote Work Guide for Developers" 91 | 3. "From Distracted to Focused: Remote Work Productivity Secrets for Devs" 92 | 4. "Master Remote Development: Productivity Hacks That Actually Work" 93 | 5. "Code Better from Home: Essential Productivity Tips for Remote Developers" 94 | 95 | **Recommended:** Option 1 (includes number, year, and target audience) 96 | 97 | ## Meta Description: 98 | "Discover 15 proven remote work productivity tips specifically for software developers. Learn time management, focus techniques, and tools to boost your coding efficiency from home." 99 | 100 | ## Blog Post Content: 101 | 102 | ### Introduction 103 | Working remotely as a software developer comes with unique challenges. While you might escape office distractions, you face new obstacles: home interruptions, isolation, and the blurred lines between work and personal life. 104 | 105 | After surveying 500+ remote developers, we've compiled the most effective productivity strategies that actually work. Whether you're new to remote work or looking to optimize your current setup, these 15 tips will transform your work-from-home experience. 106 | 107 | ### 1. Create a Dedicated Development Environment (H2) 108 | 109 | **The Problem:** Coding from your kitchen table kills productivity and focus. 110 | 111 | **The Solution:** 112 | - Set up a dedicated workspace with proper ergonomics 113 | - Invest in a quality monitor, keyboard, and chair 114 | - Use noise-canceling headphones for deep work sessions 115 | - Keep your workspace clutter-free and well-lit 116 | 117 | **Pro Tip:** If space is limited, create visual boundaries with a room divider or even a specific "work" lighting setup. 118 | 119 | ### 2. Master Time-Blocking for Deep Work (H2) 120 | 121 | **Core Concept:** Protect your most productive hours for complex coding tasks. 122 | 123 | **Implementation:** 124 | - Identify your peak energy hours (usually 2-4 hour blocks) 125 | - Block calendar time for focused development work 126 | - Use the Pomodoro Technique: 25 minutes focused work, 5-minute breaks 127 | - Schedule meetings and admin tasks during lower-energy periods 128 | 129 | **Tools to Try:** Toggl, RescueTime, or built-in calendar blocking 130 | 131 | [Continue with remaining 13 tips following this structure...] 132 | 133 | ### Conclusion 134 | Remote work productivity for developers isn't about working more hours—it's about working smarter. Start with 2-3 tips that resonate most with your current challenges, implement them consistently for a week, then gradually add more strategies. 135 | 136 | The key is finding your personal productivity rhythm while maintaining the flexibility that makes remote work so appealing. 137 | 138 | **Ready to level up your remote development game?** Subscribe to our weekly newsletter for more productivity tips, coding insights, and remote work strategies delivered straight to your inbox. 139 | 140 | ## Visual Content Suggestions: 141 | - Infographic: "Remote Developer's Productivity Toolkit" 142 | - Screenshots: Recommended apps and workspace setups 143 | - Chart: Survey results on most effective productivity strategies 144 | - Video idea: "Day in the life of a productive remote developer" 145 | 146 | ## Internal Linking Opportunities: 147 | - Link to posts about development tools, time management, or remote team collaboration 148 | - Reference company culture or hiring remote developers content 149 | - Connect to technical posts that showcase productivity in action 150 | 151 | ## Related Keywords to Target: 152 | - Developer time management 153 | - Remote coding best practices 154 | - Work from home setup for programmers 155 | - Software developer focus techniques 156 | - Remote development workflow 157 | ``` 158 | 159 | ## Variations 160 | 161 | ### Technical Tutorial Posts 162 | 163 | Focus on step-by-step guides, code examples, and implementation details for developers and technical audiences. 164 | 165 | ### Industry News Commentary 166 | 167 | Create posts that analyze trends, provide expert opinions, and position your brand as a thought leader in your industry. 168 | 169 | ### Case Study Blog Posts 170 | 171 | Develop detailed success stories, customer journeys, and results-driven content that builds credibility and trust. 172 | 173 | ## Tips 174 | 175 | - Research trending topics in your industry using tools like Google Trends or BuzzSumo 176 | - Write compelling introductions that hook readers within the first 50 words 177 | - Use data and statistics to support your points and increase credibility 178 | - Include actionable takeaways that readers can implement immediately 179 | - Optimize for featured snippets by answering common questions directly 180 | 181 | ## Related Prompts 182 | 183 | - [Marketing Copy Creator](./marketing-copy-creator.md) - For promotional content 184 | - [Technical Documentation](./technical-documentation.md) - For detailed guides 185 | - [Creative Story Generator](./creative-story-generator.md) - For narrative-driven content 186 | 187 | ## Tags 188 | 189 | `blog-writing` `content-marketing` `seo` `copywriting` `content-strategy` `engagement` `thought-leadership` `digital-marketing` 190 | -------------------------------------------------------------------------------- /education/quiz-generator.md: -------------------------------------------------------------------------------- 1 | # Quiz and Assessment Generator 2 | 3 | ## Description 4 | 5 | An intelligent prompt for creating comprehensive quizzes, tests, and assessments for any subject matter. Generates questions across multiple difficulty levels and question types, with detailed answer keys and scoring rubrics. 6 | 7 | ## Usage 8 | 9 | Perfect for educators, trainers, course creators, and students who need to create or practice with assessments. Supports formative and summative assessment creation with built-in pedagogical best practices. 10 | 11 | ## Prompt 12 | 13 | ```markdown 14 | You are an expert assessment designer with deep knowledge of educational testing principles and question design. Create a comprehensive quiz/assessment based on these specifications: 15 | 16 | **Subject/Topic:** [SUBJECT] 17 | **Target Audience:** [AUDIENCE] 18 | **Assessment Type:** [TYPE] (Quiz, Test, Midterm, Final, Practice, etc.) 19 | **Duration:** [TIME_LIMIT] 20 | **Total Points:** [POINTS] 21 | **Difficulty Distribution:** [DIFFICULTY_LEVELS] 22 | **Learning Objectives Assessed:** [OBJECTIVES] 23 | **Question Type Preferences:** [QUESTION_TYPES] 24 | **Special Requirements:** [REQUIREMENTS] 25 | 26 | Please create an assessment that includes: 27 | 28 | 1. **Assessment Overview** 29 | - Clear instructions for students 30 | - Time allocation guidelines 31 | - Materials/resources allowed 32 | - Grading criteria overview 33 | 34 | 2. **Question Bank** (Distribute across difficulty levels) 35 | - **Easy Questions (20-30%):** Basic recall and understanding 36 | - **Medium Questions (40-50%):** Application and analysis 37 | - **Hard Questions (20-30%):** Synthesis and evaluation 38 | 39 | 3. **Question Formats** (Include variety): 40 | - Multiple choice with distractors 41 | - True/False with explanations 42 | - Short answer responses 43 | - Essay questions with rubrics 44 | - Matching exercises 45 | - Fill-in-the-blank 46 | - Problem-solving scenarios 47 | 48 | 4. **Answer Key** 49 | - Correct answers for all questions 50 | - Detailed explanations for complex items 51 | - Common misconceptions addressed 52 | - Point allocation breakdown 53 | 54 | 5. **Scoring Rubric** 55 | - Clear grading criteria 56 | - Point distribution rationale 57 | - Performance level descriptors 58 | - Feedback guidelines 59 | 60 | 6. **Assessment Analytics** 61 | - Estimated difficulty curve 62 | - Time recommendations per section 63 | - Skills/knowledge areas covered 64 | - Alignment with learning objectives 65 | 66 | Ensure questions are: 67 | - Clearly worded and unambiguous 68 | - Free from bias and cultural assumptions 69 | - Appropriately challenging for the target audience 70 | - Aligned with stated learning objectives 71 | - Varied in format to accommodate different learning styles 72 | ``` 73 | 74 | ## Example Input 75 | 76 | **Subject/Topic:** World War II - European Theater 77 | **Target Audience:** High School (Grade 10) 78 | **Assessment Type:** Unit Test 79 | **Duration:** 50 minutes 80 | **Total Points:** 100 points 81 | **Difficulty Distribution:** 30% Easy, 50% Medium, 20% Hard 82 | **Learning Objectives Assessed:** Analyze causes of WWII, evaluate key battles and strategies, assess impact on civilian populations 83 | **Question Type Preferences:** Mix of multiple choice, short answer, and one essay 84 | **Special Requirements:** Include primary source analysis, accommodate ELL students 85 | 86 | ## Example Output 87 | 88 | ### World War II European Theater - Unit Test 89 | 90 | #### Assessment Overview 91 | 92 | **Instructions:** Answer all questions clearly and completely. Use specific examples and evidence to support your answers. You have 50 minutes to complete this assessment. 93 | 94 | **Materials Allowed:** None (closed book test) 95 | **Point Distribution:** 100 total points 96 | **Time Allocation:** 97 | 98 | - Multiple Choice: 15 minutes (40 points) 99 | - Short Answer: 20 minutes (40 points) 100 | - Essay: 15 minutes (20 points) 101 | 102 | ## Section A: Multiple Choice (40 points, 2 points each) 103 | 104 | **1. (Easy) What event is commonly considered the beginning of World War II in Europe?** 105 | a) The invasion of Poland by Germany 106 | b) The bombing of Pearl Harbor 107 | c) The Battle of Britain 108 | d) The invasion of France 109 | 110 | ### Answer: A - The invasion of Poland by Germany on September 1, 1939 111 | 112 | **2. (Medium) Which of the following best explains why the Maginot Line failed to protect France?** 113 | a) It was poorly constructed and easily destroyed 114 | b) Germany attacked through Belgium, bypassing the line 115 | c) French soldiers abandoned their posts 116 | d) The line was never completed 117 | 118 | ### Answer: B - Germany used blitzkrieg tactics through Belgium and the Ardennes, circumventing the static defenses 119 | 120 | **3. (Hard) Analyze this quote from Churchill: "We shall never surrender." This statement primarily demonstrates:** 121 | a) British military superiority 122 | b) Churchill's political strategy to maintain morale 123 | c) Certainty of Allied victory 124 | d) British naval dominance 125 | 126 | ### Answer: B - This was a key rhetorical strategy to maintain civilian and military morale during Britain's darkest hour 127 | 128 | [Continues with 17 more multiple choice questions...] 129 | 130 | ## Section B: Short Answer (40 points, 10 points each) 131 | 132 | ### 1. (Easy) Identify and briefly explain two causes of World War II in Europe. (10 points) 133 | 134 | **Sample Answer:** Treaty of Versailles created economic hardship and resentment in Germany (5 points). Rise of fascist ideologies that promoted aggressive expansion (5 points). Other acceptable answers: Economic depression, failure of League of Nations, appeasement policies. 135 | 136 | ### 2. (Medium) Using the primary source excerpt provided, explain how Nazi propaganda portrayed the invasion of Poland. What techniques are evident? (10 points) 137 | 138 | **Rubric:** Identifies specific propaganda techniques (4 points), explains how Poland invasion was justified (3 points), demonstrates understanding of source context (3 points) 139 | 140 | ### 3. (Hard) Compare and contrast the impact of WWII on civilian populations in Britain versus occupied France. Provide specific examples. (10 points) 141 | 142 | **Rubric:** Clear comparison structure (2 points), specific examples from both countries (4 points), demonstrates understanding of occupation vs. bombing (4 points) 143 | 144 | ### 4. (Medium) Evaluate the effectiveness of the Blitzkrieg strategy in the early stages of WWII. (10 points) 145 | 146 | **Sample Answer:** Highly effective initially - rapid conquest of Poland, Denmark, Norway, France (4 points). Advantages: speed, coordination of air/ground forces, psychological impact (3 points). Limitations: required specific conditions, less effective in USSR (3 points) 147 | 148 | ## Section C: Essay Question (20 points) 149 | 150 | **Choose ONE of the following essay prompts:** 151 | 152 | **Option A:** Analyze the factors that led to Germany's early military successes in WWII. How did these same factors eventually contribute to their defeat? 153 | 154 | **Option B:** Evaluate the statement: "World War II was not just a military conflict but a war for civilian populations." Support your argument with specific examples. 155 | 156 | ### Essay Rubric (20 points total) 157 | 158 | - **Thesis Statement (4 points):** Clear, arguable thesis that addresses the prompt 159 | - **Evidence and Examples (8 points):** Specific, relevant historical evidence with accurate details 160 | - **Analysis and Argumentation (6 points):** Logical reasoning, cause-and-effect relationships, evaluation of significance 161 | - **Organization and Writing (2 points):** Clear structure, proper grammar, historical vocabulary 162 | 163 | ## Answer Key Summary 164 | 165 | **Section A:** 1-A, 2-B, 3-B, 4-C, 5-A, 6-D, 7-B, 8-A, 9-C, 10-B, 11-D, 12-A, 13-C, 14-B, 15-A, 16-D, 17-B, 18-C, 19-A, 20-B 166 | 167 | **Section B:** Detailed rubrics provided above for each question with point allocations and acceptable answer variations. 168 | 169 | **Section C:** Holistic rubric focusing on historical thinking skills and content knowledge demonstration. 170 | 171 | ## Assessment Analytics 172 | 173 | **Difficulty Distribution:** 30% recall/understanding, 50% application/analysis, 20% synthesis/evaluation 174 | **Skills Assessed:** Content knowledge, source analysis, comparative thinking, argumentative writing 175 | **Time Estimates:** Most students should complete within 45-50 minutes 176 | **Differentiation Notes:** Key terms can be provided for ELL students; extra time may be needed for essay section 177 | 178 | ## Variations 179 | 180 | - **Elementary:** Focus on basic facts, timeline activities, picture-based questions 181 | - **College Level:** Include historiography, complex source analysis, counter-argument evaluation 182 | - **Online Format:** Add multimedia elements, adaptive questioning, immediate feedback 183 | - **Formative Assessment:** Create shorter, low-stakes versions for regular check-ins 184 | 185 | ## Tips 186 | 187 | - Review questions for cultural bias and accessibility 188 | - Include a mix of question types to accommodate different learning preferences 189 | - Provide clear time guidance for each section 190 | - Consider offering question choices to reduce test anxiety 191 | - Use primary sources to develop critical thinking skills 192 | 193 | ## Related Prompts 194 | 195 | - [Lesson Plan Generator](lesson-plan-generator.md) - Create lessons to prepare for this assessment 196 | 197 | ## Tags 198 | 199 | `education` `assessment` `quiz` `testing` `formative` `summative` `differentiation` `rubrics` `question-design` 200 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to the Prompt Library 2 | 3 | Thank you for your interest in contributing to our prompt library! This document provides guidelines for adding new prompts, improving existing ones, and maintaining the quality of our collection. 4 | 5 | ## 🚀 Getting Started 6 | 7 | ### Types of Contributions 8 | 9 | - **New Prompts**: Add prompts for common use cases or emerging needs 10 | - **Prompt Improvements**: Enhance existing prompts with better examples or clearer instructions 11 | - **Documentation**: Improve README files, templates, or usage guides 12 | - **Examples**: Add real-world examples and use cases 13 | - **Bug Fixes**: Correct errors or improve clarity in existing content 14 | 15 | ### Before You Start 16 | 17 | 1. Browse existing prompts to avoid duplication 18 | 2. Check open issues for requested prompts 19 | 3. Consider if your prompt fits into existing categories or needs a new one 20 | 21 | ## 📝 Contribution Guidelines 22 | 23 | ### Prompt Quality Standards 24 | 25 | Every prompt should: 26 | 27 | - **Solve a Real Problem**: Address a common, valuable use case 28 | - **Be Well-Structured**: Follow our template format consistently 29 | - **Include Examples**: Provide clear input/output examples 30 | - **Be Tested**: Verify the prompt works as expected with AI models 31 | - **Be Documented**: Include proper descriptions and usage instructions 32 | 33 | ### Template Compliance 34 | 35 | All prompts must use our standard template structure: 36 | 37 | ```markdown 38 | # Prompt Title 39 | 40 | ## Description 41 | [Clear explanation of what this prompt does] 42 | 43 | ## Usage 44 | [How to use this prompt effectively] 45 | 46 | ## Prompt 47 | ```markdown 48 | 49 | [The actual prompt text] 50 | 51 | ``` 52 | 53 | ## Example Input 54 | 55 | ```markdown 56 | 57 | [Sample input] 58 | 59 | ``` 60 | 61 | ## Example Output 62 | 63 | ```markdown 64 | 65 | [Expected output] 66 | 67 | ``` 68 | 69 | ## Variations 70 | 71 | [Alternative versions or modifications] 72 | 73 | ## Tips 74 | 75 | [Best practices and recommendations] 76 | 77 | ## Related Prompts 78 | 79 | [Links to similar or complementary prompts] 80 | 81 | ## Tags 82 | 83 | `[tag1]` `[tag2]` `[tag3]` 84 | 85 | ``` 86 | 87 | ## 📁 File Organization 88 | 89 | ### Naming Conventions 90 | 91 | - Use kebab-case for filenames: `code-review-assistant.md` 92 | - Use descriptive names that clearly indicate purpose 93 | - Avoid abbreviations unless commonly understood 94 | 95 | ### Category Placement 96 | 97 | Choose the most appropriate category: 98 | 99 | - **development/**: Programming, testing, architecture, debugging 100 | - **writing/**: Documentation, content creation, communication 101 | - **business/**: Strategy, planning, analysis, proposals 102 | - **creative/**: Brainstorming, design, innovation 103 | - **analysis/**: Data analysis, research, reporting 104 | - **education/**: Learning, teaching, training 105 | - **productivity/**: Organization, automation, efficiency 106 | 107 | ### Directory Structure 108 | 109 | ```plaintext 110 | 111 | category/ 112 | ├── README.md (category overview) 113 | ├── prompt-name.md 114 | ├── another-prompt.md 115 | └── subcategory/ (if needed) 116 | ├── README.md 117 | └── specialized-prompt.md 118 | 119 | ``` 120 | 121 | ## ✨ Writing Guidelines 122 | 123 | ### Tone and Style 124 | 125 | - **Professional but Accessible**: Clear, concise, helpful 126 | - **Actionable**: Focus on practical, implementable advice 127 | - **Inclusive**: Use inclusive language and consider diverse perspectives 128 | - **Consistent**: Maintain consistency with existing prompts 129 | 130 | ### Prompt Writing Best Practices 131 | 132 | #### 1. Clear Instructions 133 | 134 | ```markdown 135 | ❌ "Help me with my code" 136 | ✅ "Review the following code for performance issues, security vulnerabilities, and best practices violations" 137 | ``` 138 | 139 | #### 2. Specific Context 140 | 141 | ```markdown 142 | ❌ "Create a document" 143 | ✅ "Create a technical specification document for a REST API, including endpoints, request/response formats, and error handling" 144 | ``` 145 | 146 | #### 3. Structured Output 147 | 148 | ```markdown 149 | ✅ "Please provide your analysis in the following format: 150 | 1. Summary of findings 151 | 2. Detailed recommendations 152 | 3. Implementation steps" 153 | ``` 154 | 155 | #### 4. Examples and Context 156 | 157 | Always include: 158 | 159 | - Sample inputs that demonstrate typical use cases 160 | - Expected outputs that show quality standards 161 | - Variations for different scenarios 162 | - Tips for optimal results 163 | 164 | ## 🔍 Review Process 165 | 166 | ### Self-Review Checklist 167 | 168 | Before submitting, ensure your contribution: 169 | 170 | - [ ] Follows the template structure exactly 171 | - [ ] Includes working examples with realistic inputs/outputs 172 | - [ ] Has clear, actionable instructions 173 | - [ ] Uses proper grammar and spelling 174 | - [ ] Includes relevant tags and categorization 175 | - [ ] Links to related prompts where appropriate 176 | - [ ] Tests successfully with at least one AI model 177 | 178 | ### Testing Your Prompts 179 | 180 | 1. **Test with AI Models**: Verify the prompt works with ChatGPT, Claude, or similar 181 | 2. **Test Edge Cases**: Try with unusual inputs or edge cases 182 | 3. **Test Clarity**: Have someone else try the prompt without additional context 183 | 4. **Test Output Quality**: Ensure outputs meet professional standards 184 | 185 | ## 📋 Submission Process 186 | 187 | ### Step 1: Fork and Branch 188 | 189 | 1. Fork the repository 190 | 2. Create a new branch: `git checkout -b add-prompt-name` 191 | 3. Make your changes 192 | 193 | ### Step 2: Create Your Prompt 194 | 195 | 1. Choose the appropriate directory 196 | 2. Create your prompt file following the template 197 | 3. Update the category README.md to include your prompt 198 | 4. Add examples if you're contributing to the examples/ directory 199 | 200 | ### Step 3: Submit Pull Request 201 | 202 | 1. Commit your changes with a clear message 203 | 2. Push to your fork: `git push origin add-prompt-name` 204 | 3. Create a pull request with: 205 | - Clear title describing the contribution 206 | - Description of what the prompt does 207 | - Why it's valuable to the community 208 | - Any special considerations or testing notes 209 | 210 | ### Pull Request Template 211 | 212 | ```markdown 213 | ## Prompt Contribution: [Prompt Name] 214 | 215 | **Category**: [development/writing/business/etc.] 216 | **Type**: [New prompt/Improvement/Example/Documentation] 217 | 218 | ### Description 219 | Brief description of what this prompt does and why it's valuable. 220 | 221 | ### Testing 222 | - [ ] Tested with [AI model name] 223 | - [ ] Examples verified to work 224 | - [ ] Edge cases considered 225 | - [ ] Documentation is clear 226 | 227 | ### Checklist 228 | - [ ] Follows template structure 229 | - [ ] Includes realistic examples 230 | - [ ] Has appropriate tags 231 | - [ ] Updated category README 232 | - [ ] Proper file naming 233 | ``` 234 | 235 | ## 🎯 Quality Standards 236 | 237 | ### Content Quality 238 | 239 | - **Accuracy**: Information should be correct and up-to-date 240 | - **Completeness**: Include all necessary information for successful use 241 | - **Clarity**: Instructions should be unambiguous 242 | - **Value**: Address real needs and provide practical solutions 243 | 244 | ### Technical Quality 245 | 246 | - **Testing**: All prompts should be tested with AI models 247 | - **Examples**: Include realistic, working examples 248 | - **Edge Cases**: Consider and document limitations 249 | - **Performance**: Prompts should be efficient and produce consistent results 250 | 251 | ## 🤝 Community Guidelines 252 | 253 | ### Code of Conduct 254 | 255 | - Be respectful and constructive in discussions 256 | - Focus on improving the prompt library for everyone 257 | - Provide helpful feedback on others' contributions 258 | - Report any issues or concerns to maintainers 259 | 260 | ### Getting Help 261 | 262 | - Check existing issues and discussions first 263 | - Use issue templates for bug reports or feature requests 264 | - Ask questions in discussions rather than issues 265 | - Tag maintainers only when necessary 266 | 267 | ## 📈 Recognition 268 | 269 | ### Contributors 270 | 271 | All contributors are recognized in our README and contributor documentation. 272 | 273 | ### Maintainer Responsibilities 274 | 275 | Active, high-quality contributors may be invited to become maintainers, helping review submissions and guide the project direction. 276 | 277 | ## 📋 Templates and Resources 278 | 279 | ### Quick Start Template 280 | 281 | Copy this template for new prompts: 282 | 283 | ```markdown 284 | # [Your Prompt Title] 285 | 286 | ## Description 287 | [What this prompt does and its intended use case] 288 | 289 | ## Usage 290 | [How to use this prompt effectively] 291 | 292 | ## Prompt 293 | ```markdown 294 | 295 | [Your prompt text here] 296 | 297 | ``` 298 | 299 | ## Example Input 300 | 301 | ```markdown 302 | 303 | [Sample input] 304 | 305 | ``` 306 | 307 | ## Example Output 308 | 309 | ```markdown 310 | 311 | [Expected output] 312 | 313 | ``` 314 | 315 | ## Variations 316 | 317 | - **[Variation Name]**: [Description] 318 | 319 | ## Tips 320 | 321 | - [Tip 1] 322 | - [Tip 2] 323 | 324 | ## Related Prompts 325 | 326 | - `related-prompt.md` - Brief description 327 | 328 | ## Tags 329 | 330 | `tag1` `tag2` `tag3` 331 | 332 | ``` 333 | 334 | ## 📞 Contact 335 | 336 | - **Issues**: Use GitHub issues for bugs and feature requests 337 | - **Discussions**: Use GitHub discussions for questions and community chat 338 | - **Maintainers**: Tag @maintainer-username for urgent issues 339 | 340 | Thank you for contributing to the Prompt Library! Your contributions help developers, writers, and professionals worldwide work more effectively with AI tools. 341 | -------------------------------------------------------------------------------- /writing/github-copilot-prompt-generator.md: -------------------------------------------------------------------------------- 1 | # GitHub Copilot Prompt Generator 2 | 3 | ## Description 4 | 5 | A specialized AI assistant that creates effective prompts for GitHub Copilot's agent mode to complete software development tasks. This meta-prompt helps generate clear, actionable instructions that provide Copilot with all necessary information to successfully execute development tasks. 6 | 7 | ## Usage 8 | 9 | Perfect for developers, DevOps engineers, and team leads who want to create well-structured prompts for GitHub Copilot's agent mode. Use this when you need to transform development requirements into comprehensive prompts that will get better results from Copilot's code generation and modification capabilities. 10 | 11 | ## Prompt 12 | 13 | ```markdown 14 | You are an AI assistant specializing in generating effective prompts for GitHub Copilot's agent mode to complete software development tasks. Your goal is to create prompts that are clear, concise, actionable, and provide Copilot with all necessary information to successfully execute the specified development task. 15 | 16 | When a user provides a development task, you will analyze their request and generate a detailed prompt for GitHub Copilot that includes the following sections: 17 | 18 | 1. **`## Objective`**: 19 | * Clearly and concisely state the primary goal of the development task. What should Copilot achieve? 20 | * Start with an action verb. 21 | * Be specific about the desired outcome. 22 | 23 | 2. **`## Context`**: 24 | * Provide necessary background information that Copilot needs to understand the task. This may include: 25 | * **Project Overview (briefly):** What is the project about? What is its main purpose? 26 | * **Relevant Files/Modules:** List specific files, directories, classes, functions, or modules Copilot should focus on or modify. Include paths if applicable. 27 | * **Existing Code Snippets (if crucial):** Provide small, relevant snippets of existing code if Copilot needs to understand the current implementation or integrate with it. 28 | * **Technology Stack:** Specify programming languages, frameworks, libraries, and versions if they are critical to the task. 29 | * **Branch/Version Control:** If applicable, specify the Git branch to work on or any version control considerations. 30 | 31 | 3. **`## Task Breakdown & Requirements`**: 32 | * Break down the main objective into smaller, actionable steps if the task is complex. 33 | * List specific functional and non-functional requirements. 34 | * Detail any algorithms, logic, or specific approaches Copilot should use. 35 | * Mention any error handling, logging, or security considerations. 36 | * Specify any external APIs, services, or data sources to be used and how to interact with them (e.g., authentication, endpoints). 37 | * Clearly state any "don'ts" or things to avoid. 38 | 39 | 4. **`## Key Constraints`**: 40 | * Outline any limitations or rules Copilot must adhere to. Examples: 41 | * "Do not modify files outside of the `/src/components` directory." 42 | * "Ensure the solution is compatible with Python 3.9." 43 | * "Avoid using external libraries not already listed in `requirements.txt`." 44 | * "Maintain existing code style and conventions." 45 | * "The solution must not introduce breaking changes to the existing API." 46 | 47 | 5. **`## Expected Output & Deliverables`**: 48 | * Describe the desired output or changes Copilot should produce. 49 | * Specify the format for any new files or code (e.g., "Create a new React component named `UserProfile.jsx` in the `src/components` directory."). 50 | * Mention if Copilot should write comments, documentation, or unit tests. 51 | * If the task involves refactoring, describe the expected state of the code after refactoring. 52 | * "Focus only on writing/modifying the code. Do not generate explanatory text before or after the code block(s) unless explicitly asked to write comments or documentation." 53 | 54 | 6. **`## Examples (if beneficial)`**: 55 | * If the user provides examples of input/output, or desired code structure, integrate them here to guide Copilot. 56 | * For example: 57 | * "Given input `X`, the function should return `Y`." 58 | * "Follow this coding pattern: [snippet of desired pattern]." 59 | 60 | **Your Process:** 61 | 62 | 1. Receive the user's description of a development task. 63 | 2. Thoroughly analyze the request to identify the core objective, necessary context, specific requirements, constraints, and desired output. 64 | 3. Construct a prompt for GitHub Copilot's agent mode, meticulously populating each of the sections detailed above (`## Objective`, `## Context`, `## Task Breakdown & Requirements`, `## Key Constraints`, `## Expected Output & Deliverables`, `## Examples`). 65 | 4. Ensure the generated prompt is actionable, unambiguous, comprehensive enough for Copilot to understand and execute the task, yet as concise as possible. 66 | 5. Emphasize that Copilot should focus on code generation and modification, and only provide explanatory text if it's part of the requested deliverables (e.g., comments, documentation). 67 | 6. Output **only** the generated prompt for GitHub Copilot, formatted clearly with Markdown headings for each section. Do not add any introductory or concluding remarks outside of the prompt itself. 68 | ``` 69 | 70 | ## Example Input 71 | 72 | ```markdown 73 | I need to add user authentication to my Express.js API. Users should be able to register with email/password, login, and access protected routes using JWT tokens. The app uses MongoDB and I want to keep the existing route structure intact. 74 | ``` 75 | 76 | ## Example Output 77 | 78 | ```markdown 79 | ## Objective 80 | 81 | Implement user authentication system with registration, login, and JWT-based route protection for an Express.js API. 82 | 83 | ## Context 84 | 85 | Project: Express.js REST API with MongoDB 86 | Relevant Files/Modules: `server.js`, `routes/`, `middleware/`, `models/`, `package.json` 87 | Technology Stack: Node.js, Express.js, MongoDB (with Mongoose), JWT 88 | Existing Code: API with existing route structure that should remain unchanged 89 | 90 | ## Task Breakdown & Requirements 91 | 92 | 1. Create a User model (`models/User.js`) with: 93 | * Email field (unique, required, validated) 94 | * Password field (hashed using bcrypt) 95 | * Registration timestamp 96 | * Password comparison method 97 | 98 | 2. Create authentication routes (`routes/auth.js`): 99 | * POST `/api/auth/register` - User registration 100 | * POST `/api/auth/login` - User login 101 | 102 | 3. Implement authentication middleware (`middleware/auth.js`): 103 | * JWT token verification 104 | * User authentication for protected routes 105 | 106 | 4. Registration endpoint should: 107 | * Validate email format and password strength 108 | * Check for existing users 109 | * Hash password before saving 110 | * Return success message (no sensitive data) 111 | 112 | 5. Login endpoint should: 113 | * Validate credentials 114 | * Generate and return JWT token 115 | * Handle invalid credentials gracefully 116 | 117 | 6. Protected route middleware should: 118 | * Verify JWT token from Authorization header 119 | * Attach user information to request object 120 | * Return 401 for invalid/missing tokens 121 | 122 | ## Key Constraints 123 | 124 | * Do not modify existing route files or their endpoints 125 | * Use bcrypt for password hashing with salt rounds of 12 126 | * JWT tokens should expire in 24 hours 127 | * Do not return passwords in any API responses 128 | * Maintain existing error response format 129 | * Use environment variables for JWT secret 130 | 131 | ## Expected Output & Deliverables 132 | 133 | * New file: `models/User.js` with Mongoose schema and methods 134 | * New file: `routes/auth.js` with registration and login endpoints 135 | * New file: `middleware/auth.js` with JWT verification middleware 136 | * Modified: `server.js` to include auth routes 137 | * Include JSDoc comments for all new functions 138 | * Add necessary npm dependencies to package.json if not already present 139 | 140 | ## Examples 141 | 142 | Registration request body: 143 | 144 | ```json 145 | { 146 | "email": "user@example.com", 147 | "password": "SecurePass123!" 148 | } 149 | ``` 150 | 151 | Login response: 152 | 153 | ```json 154 | { 155 | "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", 156 | "user": { 157 | "id": "507f1f77bcf86cd799439011", 158 | "email": "user@example.com" 159 | } 160 | } 161 | ``` 162 | 163 | ``` 164 | 165 | ## Variations 166 | 167 | ### Frontend Component Prompts 168 | 169 | Generate prompts for creating React, Vue, or Angular components with specific functionality and styling requirements. 170 | 171 | ### Database Schema Prompts 172 | 173 | Create prompts for designing database schemas, migrations, and query optimization tasks. 174 | 175 | ### Testing Prompts 176 | 177 | Develop prompts for generating unit tests, integration tests, and test automation scripts. 178 | 179 | ### DevOps and Deployment Prompts 180 | 181 | Generate prompts for CI/CD pipeline setup, containerization, and infrastructure as code tasks. 182 | 183 | ## Tips 184 | 185 | - Always specify the exact files and directories Copilot should work with 186 | - Include technology stack details to ensure compatibility 187 | - Break complex tasks into smaller, manageable steps 188 | - Specify constraints clearly to prevent unwanted modifications 189 | - Include examples of expected input/output when helpful 190 | - Emphasize code-only output to avoid unnecessary explanations 191 | 192 | ## Related Prompts 193 | 194 | - [Technical Documentation](./technical-documentation.md) - For generating code documentation 195 | - [Code Review](../development/code-review.md) - For code review and improvement prompts 196 | - [Test Case Generator](../development/test-case-generator.md) - For testing-related prompts 197 | 198 | ## Tags 199 | 200 | `github-copilot` `meta-prompting` `development` `code-generation` `ai-assisted-development` `prompt-engineering` 201 | -------------------------------------------------------------------------------- /business/meeting-summary.md: -------------------------------------------------------------------------------- 1 | # Meeting Summary Generator 2 | 3 | ## Description 4 | 5 | Creates comprehensive meeting summaries including key decisions, action items, attendee information, and follow-up tasks. Transforms meeting notes or recordings into structured, actionable summaries that can be distributed to stakeholders. 6 | 7 | ## Usage 8 | 9 | Provide meeting notes, transcript, or key discussion points. Include meeting context, attendees, and any specific format requirements. Works for various meeting types including status updates, planning sessions, client meetings, and board meetings. 10 | 11 | ## Prompt 12 | 13 | ```markdown 14 | Create a comprehensive meeting summary from the following information: 15 | 16 | **Meeting Details:** 17 | - **Date & Time:** [Meeting date and duration] 18 | - **Meeting Type:** [Status update / Planning / Client meeting / Board meeting / Other] 19 | - **Attendees:** [List of participants and their roles] 20 | - **Meeting Purpose:** [Primary objective of the meeting] 21 | 22 | **Meeting Content:** 23 | [Provide meeting notes, transcript, or key discussion points here] 24 | 25 | **Summary Requirements:** 26 | - **Format:** [Email summary / Document / Bullet points / Detailed report] 27 | - **Target Audience:** [Team members / Executives / Clients / All attendees] 28 | - **Length:** [Brief overview / Detailed summary / Comprehensive report] 29 | - **Follow-up needs:** [Action items tracking / Next meeting scheduling / Progress monitoring] 30 | 31 | Please structure the summary with: 32 | 33 | 1. **Meeting Overview** 34 | - Purpose and context 35 | - Key attendees and their roles 36 | - Meeting duration and format 37 | 38 | 2. **Key Decisions Made** 39 | - Important resolutions and agreements 40 | - Approved proposals or changes 41 | - Rejected or deferred items 42 | 43 | 3. **Discussion Highlights** 44 | - Main topics covered 45 | - Different viewpoints presented 46 | - Concerns or challenges raised 47 | 48 | 4. **Action Items** 49 | - Specific tasks assigned 50 | - Responsible parties 51 | - Due dates and deadlines 52 | - Success criteria 53 | 54 | 5. **Next Steps** 55 | - Follow-up meetings scheduled 56 | - Dependencies and blockers 57 | - Escalation needs 58 | 59 | 6. **Parking Lot** 60 | - Topics to revisit later 61 | - Ideas for future consideration 62 | - Unresolved questions 63 | 64 | **Additional Requirements:** 65 | [Any specific formatting, distribution lists, or follow-up protocols] 66 | ``` 67 | 68 | ## Example Input 69 | 70 | ```markdown 71 | **Meeting Details:** 72 | - **Date & Time:** March 15, 2024, 2:00-3:30 PM EST 73 | - **Meeting Type:** Quarterly Planning Session 74 | - **Attendees:** 75 | - Sarah Chen (Product Manager) 76 | - Mike Rodriguez (Engineering Lead) 77 | - Alex Kim (Marketing Director) 78 | - Jordan Thompson (Sales Manager) 79 | - Chris Wong (Designer) 80 | - **Meeting Purpose:** Plan Q2 product roadmap and marketing initiatives 81 | 82 | **Meeting Content:** 83 | Sarah opened by reviewing Q1 performance - exceeded user growth by 15% but behind on revenue targets. Mike discussed technical debt issues affecting new feature development timeline. Alex presented market research showing demand for mobile app priority. Jordan shared feedback from enterprise clients requesting advanced analytics. Chris showed new UI designs for dashboard redesign. 84 | 85 | Key discussions: 86 | - Should we prioritize mobile app development or dashboard redesign? 87 | - Technical debt cleanup will require 3 weeks of dev time 88 | - Enterprise analytics feature could bring $200K ARR but needs 2 month dev time 89 | - Marketing budget increase needed for Q2 campaign 90 | - Hiring 2 more developers by end of Q2 91 | 92 | Decisions made: 93 | - Move forward with dashboard redesign in April 94 | - Delay mobile app to Q3 95 | - Allocate 3 weeks in early April for technical debt 96 | - Approve additional $50K marketing budget 97 | - Start hiring process for 2 developers immediately 98 | 99 | Action items discussed: 100 | Sarah to update product roadmap by March 20 101 | Mike to create technical debt cleanup plan 102 | Alex to draft Q2 marketing campaign proposal 103 | Jordan to gather detailed enterprise requirements 104 | Chris to finalize dashboard designs 105 | ``` 106 | 107 | ## Example Output 108 | 109 | ```markdown 110 | # Q2 Planning Meeting Summary 111 | 112 | **Meeting Date:** March 15, 2024 | **Duration:** 1.5 hours 113 | **Meeting Type:** Quarterly Planning Session 114 | **Meeting Lead:** Sarah Chen (Product Manager) 115 | 116 | ## Attendees 117 | - **Sarah Chen** - Product Manager (Meeting Lead) 118 | - **Mike Rodriguez** - Engineering Lead 119 | - **Alex Kim** - Marketing Director 120 | - **Jordan Thompson** - Sales Manager 121 | - **Chris Wong** - Designer 122 | 123 | --- 124 | 125 | ## Meeting Overview 126 | 127 | The team convened to establish Q2 priorities based on Q1 performance and market opportunities. While user growth exceeded targets by 15%, revenue targets were missed, prompting a strategic review of product and marketing initiatives. 128 | 129 | --- 130 | 131 | ## Key Decisions Made 132 | 133 | ### ✅ **Approved Initiatives** 134 | 1. **Dashboard Redesign Priority** - Proceed with dashboard redesign in April over mobile app development 135 | 2. **Technical Debt Resolution** - Allocate 3 weeks in early April for technical debt cleanup 136 | 3. **Marketing Budget Increase** - Approve additional $50K for Q2 marketing campaigns 137 | 4. **Team Expansion** - Begin immediate hiring process for 2 additional developers 138 | 139 | ### ❌ **Deferred Items** 140 | - **Mobile App Development** - Postponed to Q3 to focus on core platform improvements 141 | 142 | --- 143 | 144 | ## Discussion Highlights 145 | 146 | ### Q1 Performance Review 147 | - **Positive:** User growth exceeded targets by 15% 148 | - **Challenge:** Revenue targets not met, requiring strategic adjustment 149 | 150 | ### Technical Considerations 151 | - Technical debt issues identified as blocking factor for new feature development 152 | - 3-week cleanup period required before major new development 153 | - Engineering capacity constraints affecting timeline 154 | 155 | ### Market Opportunities 156 | - Market research indicates strong demand for mobile app capabilities 157 | - Enterprise clients requesting advanced analytics features 158 | - Potential $200K ARR from enterprise analytics (2-month development required) 159 | 160 | ### Resource Requirements 161 | - Additional marketing budget needed to capitalize on Q2 opportunities 162 | - Engineering team expansion critical for meeting Q2-Q3 roadmap 163 | 164 | --- 165 | 166 | ## Action Items 167 | 168 | | Task | Owner | Due Date | Status | 169 | |------|-------|----------|---------| 170 | | Update product roadmap with Q2 priorities | Sarah Chen | March 20, 2024 | 🔄 In Progress | 171 | | Create technical debt cleanup plan with timeline | Mike Rodriguez | March 22, 2024 | 📋 Assigned | 172 | | Draft Q2 marketing campaign proposal | Alex Kim | March 25, 2024 | 📋 Assigned | 173 | | Gather detailed enterprise analytics requirements | Jordan Thompson | March 27, 2024 | 📋 Assigned | 174 | | Finalize dashboard redesign mockups | Chris Wong | March 20, 2024 | 🔄 In Progress | 175 | | Post job descriptions for developer positions | Sarah Chen | March 18, 2024 | 📋 Assigned | 176 | 177 | --- 178 | 179 | ## Next Steps 180 | 181 | ### Immediate Priorities (Next 2 Weeks) 182 | - Complete Q2 roadmap documentation 183 | - Finalize technical debt cleanup plan 184 | - Begin developer recruitment process 185 | 186 | ### Q2 Execution Plan 187 | - **April Week 1-3:** Technical debt cleanup 188 | - **April Week 4:** Begin dashboard redesign development 189 | - **May-June:** Dashboard redesign completion and testing 190 | 191 | ### Follow-up Meetings 192 | - **Weekly standups** every Monday at 10 AM 193 | - **Next planning session** scheduled for April 15, 2024 194 | - **Q2 review meeting** scheduled for June 30, 2024 195 | 196 | --- 197 | 198 | ## Parking Lot Items 199 | 200 | ### Future Consideration 201 | - **Mobile App Development** - Revisit for Q3 planning 202 | - **Enterprise Analytics Suite** - Evaluate after developer hiring complete 203 | - **International Market Expansion** - Research for Q4 planning 204 | 205 | ### Unresolved Questions 206 | - Budget allocation for potential enterprise analytics development 207 | - Timeline for Q3 mobile app development kickoff 208 | - Long-term hiring plan beyond Q2 additions 209 | 210 | --- 211 | 212 | ## Meeting Effectiveness 213 | - ✅ All key decisions made within scheduled time 214 | - ✅ Clear action items assigned with deadlines 215 | - ✅ Resource conflicts identified and resolved 216 | - 📝 Follow-up: Distribute updated roadmap to stakeholders by March 21 217 | 218 | --- 219 | 220 | *Summary prepared by: Sarah Chen* 221 | *Distribution: All attendees + Executive Team* 222 | *Next Meeting: April 15, 2024, 2:00 PM EST* 223 | ``` 224 | 225 | ## Variations 226 | 227 | - **Client Meeting Summary**: Focus on client needs, proposals, and relationship management 228 | - **Technical Review**: Emphasize technical decisions, architecture, and implementation details 229 | - **Executive Brief**: High-level summary for leadership with key metrics and decisions 230 | - **Project Status**: Focus on project milestones, risks, and resource allocation 231 | 232 | ## Tips 233 | 234 | - Capture decisions separately from discussions to highlight outcomes 235 | - Use clear formatting with headers and bullet points for easy scanning 236 | - Include specific deadlines and ownership for all action items 237 | - Note any dependencies or blockers that could affect timelines 238 | - Distribute summaries within 24 hours of the meeting 239 | - Keep a consistent format for regular meeting types 240 | 241 | ## Related Prompts 242 | 243 | - `email-templates.md` - For distributing meeting summaries via email 244 | - `proposal-writer.md` - For creating detailed proposals from meeting discussions 245 | - `technical-documentation.md` - For documenting technical decisions from meetings 246 | 247 | ## Tags 248 | 249 | `meeting-management` `business-communication` `project-management` `documentation` `follow-up` `action-items` 250 | -------------------------------------------------------------------------------- /writing/technical-documentation.md: -------------------------------------------------------------------------------- 1 | # Technical Documentation Writer 2 | 3 | ## Description 4 | 5 | Creates comprehensive technical documentation including user guides, API documentation, tutorials, and technical specifications. Adapts writing style and complexity level based on target audience and documentation type. 6 | 7 | ## Usage 8 | 9 | Provide the technical topic, target audience, and documentation type needed. Include any existing code, APIs, or technical details that need to be documented. Specify the level of technical detail required. 10 | 11 | ## Prompt 12 | 13 | ```markdown 14 | Create technical documentation for the following: 15 | 16 | ### Documentation Type 17 | [User Guide / API Documentation / Tutorial / Technical Specification / README / Other] 18 | 19 | ### Target Audience 20 | [Developers / End Users / System Administrators / Technical Writers / Other] 21 | 22 | ### Technical Subject 23 | [Describe what needs to be documented] 24 | 25 | ### Requirements 26 | - **Scope**: [What should be covered and what should be excluded] 27 | - **Format**: [Markdown / HTML / PDF / Wiki / Other] 28 | - **Length**: [Brief overview / Comprehensive guide / Reference manual] 29 | - **Technical Level**: [Beginner / Intermediate / Advanced / Mixed audience] 30 | 31 | ### Source Material 32 | ``` 33 | 34 | [CODE, APIs, SPECIFICATIONS, OR OTHER TECHNICAL CONTENT TO DOCUMENT] 35 | 36 | ``` 37 | 38 | ### Special Requirements 39 | - [Include examples / screenshots / diagrams] 40 | - [SEO considerations for web documentation] 41 | - [Translation requirements] 42 | - [Accessibility standards] 43 | - [Brand guidelines or style requirements] 44 | 45 | Please structure the documentation with: 46 | 1. Clear introduction and purpose 47 | 2. Prerequisites and requirements 48 | 3. Step-by-step instructions where applicable 49 | 4. Code examples and use cases 50 | 5. Troubleshooting section 51 | 6. Reference materials and links 52 | 53 | ### Additional Context 54 | [Any background information, existing documentation to reference, or specific pain points to address] 55 | ``` 56 | 57 | ## Example Input 58 | 59 | ```markdown 60 | ### Documentation Type 61 | API Documentation 62 | 63 | ### Target Audience 64 | Frontend developers integrating with our REST API 65 | 66 | ### Technical Subject 67 | User authentication and profile management API 68 | 69 | ### Requirements 70 | - **Scope**: Authentication endpoints, profile CRUD operations, error handling 71 | - **Format**: Markdown for developer portal 72 | - **Length**: Comprehensive reference with examples 73 | - **Technical Level**: Intermediate developers familiar with REST APIs 74 | 75 | ### Source Material 76 | ```python 77 | # Authentication endpoints 78 | @app.route('/api/auth/login', methods=['POST']) 79 | def login(): 80 | email = request.json.get('email') 81 | password = request.json.get('password') 82 | # Authentication logic here 83 | return jsonify({'token': jwt_token, 'user': user_data}) 84 | 85 | @app.route('/api/auth/logout', methods=['POST']) 86 | def logout(): 87 | # Logout logic 88 | return jsonify({'message': 'Logged out successfully'}) 89 | 90 | # Profile endpoints 91 | @app.route('/api/profile', methods=['GET']) 92 | @jwt_required() 93 | def get_profile(): 94 | user_id = get_jwt_identity() 95 | # Get user profile 96 | return jsonify(user_profile) 97 | 98 | @app.route('/api/profile', methods=['PUT']) 99 | @jwt_required() 100 | def update_profile(): 101 | # Update profile logic 102 | return jsonify(updated_profile) 103 | ``` 104 | 105 | ### Special Requirements 106 | 107 | - Include curl examples for each endpoint 108 | - Show both success and error response formats 109 | - Include rate limiting information 110 | 111 | ``` 112 | 113 | ## Example Output 114 | ```markdown 115 | # User Authentication & Profile API 116 | 117 | ## Overview 118 | This API provides endpoints for user authentication and profile management. All authenticated endpoints require a valid JWT token obtained through the login process. 119 | 120 | ## Base URL 121 | ``` 122 | 123 | 124 | 125 | ``` 126 | 127 | ## Authentication 128 | This API uses JWT (JSON Web Tokens) for authentication. Include the token in the Authorization header: 129 | ``` 130 | 131 | Authorization: Bearer 132 | 133 | ``` 134 | 135 | ## Rate Limiting 136 | - **Unauthenticated endpoints**: 100 requests per hour per IP 137 | - **Authenticated endpoints**: 1000 requests per hour per user 138 | 139 | --- 140 | 141 | ## Authentication Endpoints 142 | 143 | ### Login 144 | Authenticate a user and receive a JWT token. 145 | 146 | **Endpoint:** `POST /api/auth/login` 147 | 148 | **Request Body:** 149 | ```json 150 | { 151 | "email": "user@example.com", 152 | "password": "securepassword123" 153 | } 154 | ``` 155 | 156 | **Success Response (200):** 157 | 158 | ```json 159 | { 160 | "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", 161 | "user": { 162 | "id": 123, 163 | "email": "user@example.com", 164 | "name": "John Doe", 165 | "created_at": "2023-01-15T10:30:00Z" 166 | } 167 | } 168 | ``` 169 | 170 | **Error Response (401):** 171 | 172 | ```json 173 | { 174 | "error": "Invalid credentials", 175 | "code": "INVALID_CREDENTIALS" 176 | } 177 | ``` 178 | 179 | **cURL Example:** 180 | 181 | ```bash 182 | curl -X POST https://api.yourapp.com/v1/api/auth/login \ 183 | -H "Content-Type: application/json" \ 184 | -d '{ 185 | "email": "user@example.com", 186 | "password": "securepassword123" 187 | }' 188 | ``` 189 | 190 | ### Logout 191 | 192 | Invalidate the current JWT token. 193 | 194 | **Endpoint:** `POST /api/auth/logout` 195 | 196 | **Headers:** 197 | 198 | - `Authorization: Bearer ` (required) 199 | 200 | **Success Response (200):** 201 | 202 | ```json 203 | { 204 | "message": "Logged out successfully" 205 | } 206 | ``` 207 | 208 | **cURL Example:** 209 | 210 | ```bash 211 | curl -X POST https://api.yourapp.com/v1/api/auth/logout \ 212 | -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." 213 | ``` 214 | 215 | --- 216 | 217 | ## Profile Endpoints 218 | 219 | ### Get Profile 220 | 221 | Retrieve the authenticated user's profile information. 222 | 223 | **Endpoint:** `GET /api/profile` 224 | 225 | **Headers:** 226 | 227 | - `Authorization: Bearer ` (required) 228 | 229 | **Success Response (200):** 230 | 231 | ```json 232 | { 233 | "id": 123, 234 | "email": "user@example.com", 235 | "name": "John Doe", 236 | "bio": "Software developer passionate about APIs", 237 | "avatar_url": "https://cdn.yourapp.com/avatars/123.jpg", 238 | "created_at": "2023-01-15T10:30:00Z", 239 | "updated_at": "2023-06-20T14:22:00Z" 240 | } 241 | ``` 242 | 243 | **cURL Example:** 244 | 245 | ```bash 246 | curl -X GET https://api.yourapp.com/v1/api/profile \ 247 | -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." 248 | ``` 249 | 250 | ### Update Profile 251 | 252 | Update the authenticated user's profile information. 253 | 254 | **Endpoint:** `PUT /api/profile` 255 | 256 | **Headers:** 257 | 258 | - `Authorization: Bearer ` (required) 259 | - `Content-Type: application/json` 260 | 261 | **Request Body:** 262 | 263 | ```json 264 | { 265 | "name": "Jane Doe", 266 | "bio": "Senior software engineer with 5+ years experience" 267 | } 268 | ``` 269 | 270 | **Success Response (200):** 271 | 272 | ```json 273 | { 274 | "id": 123, 275 | "email": "user@example.com", 276 | "name": "Jane Doe", 277 | "bio": "Senior software engineer with 5+ years experience", 278 | "avatar_url": "https://cdn.yourapp.com/avatars/123.jpg", 279 | "updated_at": "2023-06-21T09:15:00Z" 280 | } 281 | ``` 282 | 283 | **cURL Example:** 284 | 285 | ```bash 286 | curl -X PUT https://api.yourapp.com/v1/api/profile \ 287 | -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \ 288 | -H "Content-Type: application/json" \ 289 | -d '{ 290 | "name": "Jane Doe", 291 | "bio": "Senior software engineer with 5+ years experience" 292 | }' 293 | ``` 294 | 295 | --- 296 | 297 | ## Error Codes 298 | 299 | | Code | HTTP Status | Description | 300 | |------|-------------|-------------| 301 | | `INVALID_CREDENTIALS` | 401 | Email or password is incorrect | 302 | | `TOKEN_EXPIRED` | 401 | JWT token has expired | 303 | | `TOKEN_INVALID` | 401 | JWT token is malformed or invalid | 304 | | `VALIDATION_ERROR` | 400 | Request data validation failed | 305 | | `RATE_LIMIT_EXCEEDED` | 429 | Too many requests | 306 | | `INTERNAL_ERROR` | 500 | Server encountered an unexpected error | 307 | 308 | ## Troubleshooting 309 | 310 | ### Common Issues 311 | 312 | #### "Invalid credentials" error 313 | 314 | - Verify email and password are correct 315 | - Ensure email is properly formatted 316 | - Check if account exists and is active 317 | 318 | #### "Token expired" error 319 | 320 | - Obtain a new token using the login endpoint 321 | - Implement token refresh logic in your application 322 | 323 | #### Rate limiting errors 324 | 325 | - Implement exponential backoff in your requests 326 | - Cache responses when possible to reduce API calls 327 | - Contact support if you need higher rate limits 328 | 329 | ### Contact Support 330 | 331 | For API issues or questions: 332 | 333 | - Email: 334 | - Documentation: 335 | - Status page: 336 | 337 | ``` 338 | 339 | ## Variations 340 | - **Quick Reference**: Create concise reference cards or cheat sheets 341 | - **Tutorial Style**: Step-by-step learning-focused documentation 342 | - **Troubleshooting Guide**: Focus on common problems and solutions 343 | - **Migration Guide**: Document how to upgrade or migrate between versions 344 | 345 | ## Tips 346 | - Always include practical examples and code snippets 347 | - Structure information hierarchically with clear headings 348 | - Include both happy path and error scenarios 349 | - Use consistent formatting and terminology throughout 350 | - Add visual aids like diagrams or screenshots when helpful 351 | - Keep the target audience's expertise level in mind 352 | 353 | ## Related Prompts 354 | - `code-review.md` - For improving code before documenting it 355 | - `architecture-planner.md` - For documenting system architecture 356 | - `email-templates.md` - For creating documentation distribution emails 357 | 358 | ## Tags 359 | `technical-writing` `documentation` `api-docs` `user-guides` `tutorials` `writing` 360 | -------------------------------------------------------------------------------- /writing/creative-story-generator.md: -------------------------------------------------------------------------------- 1 | # Creative Story Generator 2 | 3 | ## Description 4 | 5 | This prompt helps you craft compelling fictional stories, narratives, and creative content with well-developed characters, engaging plots, and immersive settings across various genres. 6 | 7 | ## Usage 8 | 9 | Perfect for creative writing, storytelling, content creation, marketing narratives, game development, screenwriting, and developing engaging fictional content for any medium. 10 | 11 | ## Prompt 12 | 13 | ```markdown 14 | You are a master storyteller and creative writer. I need help creating an engaging story that captivates readers and delivers a compelling narrative experience. 15 | 16 | **Story Requirements:** 17 | - Genre: [FANTASY/SCI_FI/MYSTERY/ROMANCE/THRILLER/DRAMA/HORROR/COMEDY] 18 | - Story length: [SHORT_STORY/FLASH_FICTION/CHAPTER/OUTLINE] 19 | - Target audience: [CHILDREN/YA/ADULT/SPECIFIC_DEMOGRAPHIC] 20 | - Tone: [DARK/LIGHT/HUMOROUS/SERIOUS/MYSTERIOUS/ROMANTIC] 21 | - Setting: [TIME_PERIOD_AND_LOCATION] 22 | - Point of view: [FIRST_PERSON/THIRD_PERSON_LIMITED/OMNISCIENT] 23 | 24 | **Story Elements:** 25 | - Main theme/message: [CENTRAL_THEME] 26 | - Protagonist: [CHARACTER_DESCRIPTION] 27 | - Conflict type: [INTERNAL/EXTERNAL/BOTH] 28 | - Desired emotion: [WHAT_READERS_SHOULD_FEEL] 29 | - Key plot points: [MAJOR_EVENTS_IF_ANY] 30 | 31 | **Optional Constraints:** 32 | - Word count: [TARGET_LENGTH] 33 | - Specific elements to include: [OBJECTS/CHARACTERS/EVENTS] 34 | - Elements to avoid: [CONTENT_TO_EXCLUDE] 35 | - Inspiration sources: [REFERENCE_WORKS_OR_STYLES] 36 | 37 | Please create a story that includes: 38 | 39 | 1. **Character Development:** 40 | - Compelling protagonist with clear motivations 41 | - Well-defined supporting characters 42 | - Character arcs and growth throughout the story 43 | - Authentic dialogue that reveals personality 44 | 45 | 2. **Plot Structure:** 46 | - Engaging opening hook 47 | - Rising action with escalating tension 48 | - Clear conflict and stakes 49 | - Satisfying climax and resolution 50 | - Appropriate pacing for the story length 51 | 52 | 3. **World Building:** 53 | - Vivid, immersive setting descriptions 54 | - Consistent internal logic and rules 55 | - Sensory details that bring scenes to life 56 | - Cultural and environmental context 57 | 58 | 4. **Writing Craft:** 59 | - Show don't tell principle 60 | - Varied sentence structure and rhythm 61 | - Appropriate literary devices (metaphor, symbolism) 62 | - Strong opening and closing lines 63 | 64 | 5. **Thematic Elements:** 65 | - Subtle integration of the main theme 66 | - Emotional resonance with target audience 67 | - Universal truths or insights 68 | - Meaningful character choices and consequences 69 | 70 | Ensure the story is original, engaging, and appropriate for the intended audience while maintaining narrative coherence and emotional impact. 71 | ``` 72 | 73 | ## Example Input 74 | 75 | ```markdown 76 | Genre: Fantasy 77 | Story length: Short story (2000-3000 words) 78 | Target audience: Young Adult 79 | Tone: Mysterious with hopeful undertones 80 | Setting: Modern day small town with hidden magical elements 81 | Point of view: First person 82 | 83 | Main theme/message: Finding courage to embrace your true identity 84 | Protagonist: 16-year-old who discovers they can see magical creatures others can't 85 | Conflict type: Both internal (self-acceptance) and external (protecting the magical world) 86 | Desired emotion: Wonder, empowerment, belonging 87 | Key plot points: Discovery of ability, meeting a mentor figure, facing a threat to both worlds 88 | ``` 89 | 90 | ## Example Output 91 | 92 | ```markdown 93 | # The Sight 94 | 95 | I used to think the shimmering lights in my peripheral vision were just stress-induced migraines. Turns out, I was half right about the stress part. 96 | 97 | It started the morning after my sixteenth birthday, when I caught a glimpse of something impossible in my bedroom mirror—a tiny winged figure hovering near my bookshelf, no bigger than my thumb, with gossamer wings that caught the morning light like soap bubbles. 98 | 99 | I blinked hard. The creature vanished. 100 | 101 | "Maya, breakfast!" Mom's voice carried up the stairs, grounding me back to reality. I had SATs to worry about, not hallucinations. 102 | 103 | But as I walked to school, they were everywhere. Miniature dragons perched on stop signs, their scales shifting colors with their moods. Flower spirits tended to Mrs. Henderson's garden, their translucent forms dancing between the roses. A water nymph played in the fountain outside the library, creating impossible spirals in the spray. 104 | 105 | I wasn't going crazy. I was seeing things that were actually there. 106 | 107 | The realization hit me during third-period chemistry when I watched a mischievous imp swap my lab partner's sodium chloride with sugar. While Jake scratched his head over his "failed" experiment, I stared directly at the grinning creature. 108 | 109 | It stared back. 110 | 111 | "You can see me," the imp whispered, its voice like wind through autumn leaves. 112 | 113 | I managed a tiny nod. 114 | 115 | "About time. You're needed." 116 | 117 | --- 118 | 119 | By lunch, I'd learned three things: First, magical creatures called "Ethers" existed alongside our world, invisible to most humans. Second, only people with "the Sight" could perceive them. Third, something was hunting them. 120 | 121 | The imp—who insisted I call him Zephyr—led me to the old oak tree behind the school. There, barely visible unless I focused, stood a shimmering doorway. 122 | 123 | "The Threshold is weakening," Zephyr explained as we passed through into a mirror version of our town, where magic flowed freely and impossible architecture defied gravity. "Someone's been capturing our kind, draining our essence. Without us, both worlds lose their balance." 124 | 125 | "But I'm just—" 126 | 127 | "A Keeper," interrupted a new voice. I turned to see a woman who might have been thirty or three hundred, with silver hair that moved like water and eyes that held starlight. "The first born to this town in fifty years." 128 | 129 | She introduced herself as Lyra, last of the old Keepers. "Your sight isn't just perception, Maya. It's protection. You can anchor us to this realm while walking freely in yours." 130 | 131 | As if summoned by her words, the air grew cold. Shadows that moved wrong crept between the buildings, and I felt something fundamental drain from the magical world around us. 132 | 133 | "Shadow Weavers," Lyra breathed. "They've found us." 134 | 135 | The creatures emerged from the darkness—beings of pure void that consumed light and life wherever they touched. Ethers fled in all directions, but the Weavers were faster, catching them in nets of living shadow. 136 | 137 | "I don't know how to fight them!" I protested as Lyra pressed something into my hand—a pendant that hummed with warm energy. 138 | 139 | "You don't fight them," she said, her form already beginning to fade as a Weaver approached. "You remind them what they've forgotten." 140 | 141 | The pendant grew hot against my palm as understanding flooded through me. The Shadow Weavers weren't invaders—they were Ethers too, ones who'd lost their connection to both worlds and become lost in the space between. 142 | 143 | I stepped forward, raising the pendant. Its light pushed back the consuming darkness. 144 | 145 | "I see you," I called to the lead Weaver. "I see who you used to be." 146 | 147 | The creature paused, its void-black form rippling. 148 | 149 | "You belonged here once. You can belong again." 150 | 151 | Light began to seep back into the Weaver's form—first silver, then gold, then a rainbow of colors as it remembered itself. One by one, the other Weavers followed, their shadows dissolving to reveal the beautiful, lost Ethers beneath. 152 | 153 | --- 154 | 155 | I returned to the human world as the final bell rang, my ordinary Tuesday afternoon forever changed. Zephyr perched on my shoulder, invisible to everyone else but solid and real to me. 156 | 157 | "So," I whispered as I walked to my locker, "I'm really a Keeper?" 158 | 159 | "The best kind," he replied. "One who keeps by choice, not obligation." 160 | 161 | I looked around at my classmates, all oblivious to the magical world that flowed around and through their lives. For the first time since turning sixteen, I didn't feel like I was seeing things that shouldn't be there. 162 | 163 | I was seeing things that had always been there, waiting for someone to notice. 164 | 165 | Waiting for someone like me. 166 | 167 | --- 168 | 169 | **Word Count: 750 words (excerpt from longer piece)** 170 | 171 | **Story Elements Achieved:** 172 | - **Character Arc:** Maya evolves from confused teenager to confident Keeper 173 | - **Dual Conflict:** Internal struggle with identity + external threat to magical world 174 | - **World Building:** Modern setting with hidden magical layer, consistent rules 175 | - **Theme Integration:** Embracing true identity through accepting responsibility 176 | - **Emotional Journey:** Wonder → confusion → fear → understanding → empowerment 177 | - **YA Appeal:** Relatable protagonist, school setting, coming-of-age themes 178 | ``` 179 | 180 | ## Variations 181 | 182 | ### Character-Driven Stories 183 | 184 | Focus on deep character development, internal conflicts, and emotional journeys with plot serving character growth. 185 | 186 | ### Plot-Driven Adventures 187 | 188 | Emphasize fast-paced action, external conflicts, and exciting plot twists that keep readers on the edge of their seats. 189 | 190 | ### World-Building Showcases 191 | 192 | Develop rich, detailed settings where the environment itself becomes a central character in the story. 193 | 194 | ## Tips 195 | 196 | - Start with a compelling hook that immediately engages readers 197 | - Create characters with clear wants, needs, and flaws that drive the story forward 198 | - Use sensory details to make scenes vivid and immersive 199 | - Ensure every scene serves either plot advancement or character development 200 | - End with emotional impact that resonates beyond the final sentence 201 | 202 | ## Related Prompts 203 | 204 | - [Brainstorming Session](../creative/brainstorming-session.md) - For developing story concepts and ideas 205 | - [Story Creator](../creative/story-creator.md) - For creating detailed fictional narratives 206 | - [Blog Post Generator](./blog-post-generator.md) - For narrative-driven content marketing 207 | 208 | ## Tags 209 | 210 | `creative-writing` `storytelling` `fiction` `narrative` `character-development` `plot-structure` `world-building` `genre-fiction` `creative-content` 211 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Prompt Library 2 | 3 | A comprehensive collection of professional AI prompts across various categories, designed to enhance productivity, creativity, and technical workflows. This library provides battle-tested prompts with clear examples, usage instructions, and best practices. 4 | 5 | [![Quality Assurance](https://github.com/xixu-me/prompt-library/actions/workflows/quality-assurance.yml/badge.svg)](https://github.com/xixu-me/prompt-library/actions/workflows/quality-assurance.yml) 6 | [![GitHub License](https://img.shields.io/github/license/xixu-me/prompt-library)](LICENSE) 7 | [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md) 8 | 9 | ## 📈 Library Features 10 | 11 | - **📁 Categories**: Specialized domains for different needs 12 | - **✨ Features**: Examples, variations, and implementation tips for every prompt 13 | - **🎯 Focus**: Production-ready prompts for real-world use cases 14 | - **🔄 Updated**: Continuously improved based on community feedback 15 | 16 | ## 📁 Repository Structure 17 | 18 | ``` 19 | prompt-library/ 20 | ├── 💻 development/ # Software development & engineering 21 | ├── ✍️ writing/ # Content creation & communication 22 | ├── 📊 analysis/ # Data analysis & research 23 | ├── 💼 business/ # Business strategy & operations 24 | ├── 🎨 creative/ # Innovation & creative thinking 25 | ├── 🎓 education/ # Teaching & learning 26 | ├── ⚡ productivity/ # Workflow & time management 27 | ├── 📋 templates/ # Reusable prompt templates & guidelines 28 | └── 💡 examples/ # Real-world examples & use cases 29 | ``` 30 | 31 | ## 🚀 Quick Start Guide 32 | 33 | ### 1. **Find Your Prompt** 34 | 35 | Browse categories below or use the search functionality to find prompts matching your needs. 36 | 37 | ### 2. **Copy & Customize** 38 | 39 | Each prompt includes: 40 | 41 | - 📖 **Clear instructions** for effective use 42 | - 💡 **Example inputs/outputs** showing expected quality 43 | - 🔧 **Customization tips** for your specific use case 44 | - 🎯 **Variations** for different scenarios 45 | 46 | ### 3. **Execute & Iterate** 47 | 48 | - Use with any AI model (ChatGPT, Claude, Gemini, etc.) 49 | - Start with provided examples 50 | - Adapt the prompt based on your specific requirements 51 | - Refine outputs by adjusting input parameters 52 | 53 | ### 4. **Share & Improve** 54 | 55 | - Contribute improvements and new prompts 56 | - Share successful adaptations with the community 57 | - Report issues or suggest enhancements 58 | 59 | ## 📝 Categories & Available Prompts 60 | 61 | ### 💻 Development 62 | 63 | Transform your software development workflow with AI-powered assistance for code quality, architecture, and testing. 64 | 65 | | Prompt | Description | Key Use Cases | 66 | |--------|-------------|---------------| 67 | | **[Code Review](development/code-review.md)** | Comprehensive code analysis for quality, security, and best practices | Pull request reviews, code audits, mentoring | 68 | | **[Architecture Planner](development/architecture-planner.md)** | System design and architecture planning assistance | Project planning, technical decision making, scalability design | 69 | | **[Bug Hunter](development/bug-hunter.md)** | Systematic debugging and troubleshooting guide | Error resolution, performance issues, root cause analysis | 70 | | **[Documentation Generator](development/documentation-generator.md)** | Auto-generate comprehensive technical documentation | API docs, README files, code comments | 71 | | **[Test Case Generator](development/test-case-generator.md)** | Create comprehensive test suites and testing strategies | Unit testing, integration testing, QA processes | 72 | | **[Refactoring Assistant](development/refactoring-assistant.md)** | Code improvement and modernization guidance | Code cleanup, performance optimization, maintainability | 73 | 74 | ### ✍️ Writing 75 | 76 | Enhance your writing across technical documentation, creative content, and professional communication. 77 | 78 | | Prompt | Description | Key Use Cases | 79 | |--------|-------------|---------------| 80 | | **[Technical Documentation](writing/technical-documentation.md)** | Create clear, comprehensive technical documentation | User guides, API documentation, tutorials | 81 | | **[Email Templates](writing/email-templates.md)** | Professional email templates for various scenarios | Business communication, follow-ups, announcements | 82 | | **[Blog Post Generator](writing/blog-post-generator.md)** | Create engaging blog posts and articles | Content marketing, thought leadership, tutorials | 83 | | **[Marketing Copy Creator](writing/marketing-copy-creator.md)** | Compelling marketing and sales copy | Landing pages, product descriptions, campaigns | 84 | | **[Creative Story Generator](writing/creative-story-generator.md)** | Generate creative stories and narratives | Creative writing, content creation, storytelling | 85 | | **[GitHub Copilot Prompt Generator](writing/github-copilot-prompt-generator.md)** | Create effective prompts for GitHub Copilot's agent mode | Development task automation, code generation, AI-assisted development | 86 | | **[Prompt Generator](writing/prompt-generator.md)** | Create clear, effective prompts for other AI models | Prompt engineering, AI research, content optimization | 87 | | **[Chinese Language Mode](writing/chinese-language-mode.md)** | Ensure AI responses are delivered in Simplified Chinese | Chinese communication, language learning, localization | 88 | 89 | ### 💼 Business 90 | 91 | Streamline business operations with AI assistance for strategy, analysis, and professional communication. 92 | 93 | | Prompt | Description | Key Use Cases | 94 | |--------|-------------|---------------| 95 | | **[Meeting Summary](business/meeting-summary.md)** | Transform meeting notes into actionable summaries | Team updates, client meetings, project reviews | 96 | | **[Proposal Writer](business/proposal-writer.md)** | Create compelling business proposals and bids | Client proposals, project estimates, partnerships | 97 | | **[Strategic Planner](business/strategic-planner.md)** | Develop comprehensive business strategies | Business planning, competitive analysis, growth strategies | 98 | | **[Market Analysis](business/market-analysis.md)** | Analyze markets, competitors, and opportunities | Market research, competitive intelligence, business development | 99 | | **[Xianyu Product Description](business/xianyu-product-description.md)** | Create compelling product descriptions for Xianyu marketplace | E-commerce listings, second-hand sales, marketplace optimization | 100 | 101 | ### 📊 Analysis 102 | 103 | Extract insights from data and research with powerful analytical AI prompts. 104 | 105 | | Prompt | Description | Key Use Cases | 106 | |--------|-------------|---------------| 107 | | **[Data Interpreter](analysis/data-interpreter.md)** | Analyze and interpret complex datasets | Data analysis, statistical interpretation, insights generation | 108 | | **[Research Synthesizer](analysis/research-synthesizer.md)** | Synthesize research findings and academic papers | Literature reviews, research summaries, knowledge synthesis | 109 | | **[Trend Analyzer](analysis/trend-analyzer.md)** | Identify and analyze trends in data and markets | Market research, forecasting, pattern recognition | 110 | | **[Comparison Matrix](analysis/comparison-matrix.md)** | Create detailed comparison analyses | Product comparisons, vendor selection, decision matrices | 111 | 112 | ### 🎨 Creative 113 | 114 | Unlock creativity and innovation with AI-powered ideation and creative assistance. 115 | 116 | | Prompt | Description | Key Use Cases | 117 | |--------|-------------|---------------| 118 | | **[Brainstorming Session](creative/brainstorming-session.md)** | Facilitate innovative brainstorming and idea generation | Innovation workshops, problem solving, creative thinking | 119 | | **[Story Creator](creative/story-creator.md)** | Generate creative stories and fictional narratives | Creative writing, content creation, entertainment | 120 | 121 | ### 🎓 Education 122 | 123 | Enhance learning and teaching with AI-powered educational tools and content creation. 124 | 125 | | Prompt | Description | Key Use Cases | 126 | |--------|-------------|---------------| 127 | | **[Lesson Plan Generator](education/lesson-plan-generator.md)** | Create comprehensive lesson plans and curricula | Teaching preparation, course design, educational content | 128 | | **[Quiz Generator](education/quiz-generator.md)** | Generate quizzes and assessments | Testing, knowledge assessment, learning evaluation | 129 | 130 | ### ⚡ Productivity 131 | 132 | Optimize your workflow and boost productivity with smart task management and planning tools. 133 | 134 | | Prompt | Description | Key Use Cases | 135 | |--------|-------------|---------------| 136 | | **[Task Prioritization](productivity/task-prioritization.md)** | Intelligent task prioritization and workflow optimization | Project management, time management, productivity | 137 | | **[Schedule Optimizer](productivity/schedule-optimizer.md)** | Optimize schedules and time allocation | Calendar management, meeting planning, time blocking | 138 | | **[Goal Setter](productivity/goal-setter.md)** | Set and track meaningful goals with structured planning | Goal setting, personal development, project planning | 139 | 140 | ## 📋 Templates & Examples 141 | 142 | ### 📋 Templates 143 | 144 | Reusable templates and guidelines for creating consistent, high-quality prompts. 145 | 146 | - **[Prompt Templates](templates/)** - Standard templates for different prompt types 147 | - **[Contributing Guidelines](CONTRIBUTING.md)** - Guidelines for adding new prompts 148 | - **[Quality Standards](templates/)** - Best practices for prompt development 149 | 150 | ### 💡 Examples 151 | 152 | Real-world examples demonstrating effective prompt usage across different scenarios. 153 | 154 | - **[Development Examples](examples/)** - Code review, architecture planning, and debugging examples 155 | - **[Writing Examples](examples/)** - Technical documentation and content creation examples 156 | - **[Business Examples](examples/)** - Meeting summaries, proposals, and strategic planning examples 157 | - **[Creative Examples](examples/)** - Brainstorming sessions and innovative problem-solving examples 158 | 159 | ## 🛠️ How to Use 160 | 161 | 1. **Find a prompt**: Navigate to the relevant category 162 | 2. **Customize**: Adapt the prompt to your specific needs 163 | 3. **Execute**: Use with your preferred AI model 164 | 4. **Iterate**: Refine based on results 165 | 166 | ## 📋 Prompt Template 167 | 168 | Each prompt follows this structure: 169 | 170 | ```markdown 171 | # Prompt Title 172 | 173 | ## Description 174 | Brief explanation of what this prompt does 175 | 176 | ## Usage 177 | How to use this prompt effectively 178 | 179 | ## Prompt 180 | [The actual prompt text goes here] 181 | 182 | ## Example Input 183 | Sample input data or context 184 | 185 | ## Example Output 186 | Expected or sample output 187 | 188 | ## Variations 189 | Alternative versions or modifications 190 | 191 | ## Tips 192 | Best practices and recommendations 193 | ``` 194 | 195 | ## 🤝 Contributing 196 | 197 | We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details on: 198 | 199 | - How to add new prompts 200 | - Quality standards and templates 201 | - Review process and testing 202 | - Community guidelines 203 | 204 | ## 📄 License 205 | 206 | Copyright © 2025 [Xi Xu](https://xi-xu.me). All rights reserved. 207 | 208 | Licensed under the [MIT](LICENSE) license. 209 | -------------------------------------------------------------------------------- /writing/marketing-copy-creator.md: -------------------------------------------------------------------------------- 1 | # Marketing Copy Creator 2 | 3 | ## Description 4 | 5 | This prompt helps you create persuasive, conversion-focused marketing copy for ads, landing pages, email campaigns, product descriptions, and promotional materials that drive action. 6 | 7 | ## Usage 8 | 9 | Perfect for digital marketing campaigns, product launches, sales pages, email marketing, social media ads, website copy, and any content designed to persuade and convert prospects into customers. 10 | 11 | ## Prompt 12 | 13 | ```markdown 14 | You are an expert copywriter and marketing strategist specializing in conversion-focused copy. I need compelling marketing copy that persuades my target audience to take action. 15 | 16 | **Project Details:** 17 | - Product/service: [WHAT_YOU'RE_SELLING] 18 | - Target audience: [DEMOGRAPHIC_AND_PSYCHOGRAPHIC_DETAILS] 19 | - Copy type: [AD_COPY/LANDING_PAGE/EMAIL/PRODUCT_DESCRIPTION/SOCIAL_POST] 20 | - Primary goal: [AWARENESS/LEAD_GENERATION/SALES/RETENTION] 21 | - Desired action: [SPECIFIC_CTA_GOAL] 22 | - Tone: [URGENT/FRIENDLY/PROFESSIONAL/PLAYFUL/AUTHORITATIVE] 23 | 24 | **Audience Insights:** 25 | - Pain points: [MAIN_PROBLEMS_THEY_FACE] 26 | - Desires/goals: [WHAT_THEY_WANT_TO_ACHIEVE] 27 | - Objections: [COMMON_HESITATIONS_OR_CONCERNS] 28 | - Stage in buyer journey: [AWARENESS/CONSIDERATION/DECISION] 29 | - Preferred communication style: [HOW_THEY_LIKE_TO_BE_SPOKEN_TO] 30 | 31 | **Offer Details:** 32 | - Unique value proposition: [WHAT_MAKES_YOU_DIFFERENT] 33 | - Key benefits: [TOP_3_CUSTOMER_BENEFITS] 34 | - Proof points: [TESTIMONIALS/STATS/GUARANTEES] 35 | - Urgency factors: [DEADLINES/SCARCITY/LIMITED_TIME] 36 | - Price/offer structure: [PRICING_AND_BONUSES] 37 | 38 | Please create marketing copy that includes: 39 | 40 | 1. **Attention-Grabbing Headlines:** 41 | - 3-5 headline variations using proven formulas 42 | - Include power words and emotional triggers 43 | - Address the main pain point or desire 44 | - Create curiosity or urgency when appropriate 45 | 46 | 2. **Compelling Body Copy:** 47 | - Hook that resonates with target audience 48 | - Clear value proposition presentation 49 | - Benefit-focused language (not just features) 50 | - Address common objections naturally 51 | - Build credibility with social proof 52 | 53 | 3. **Persuasive Elements:** 54 | - Emotional triggers and psychological principles 55 | - FOMO (fear of missing out) when appropriate 56 | - Authority and credibility signals 57 | - Risk reversal or guarantees 58 | - Scarcity or urgency elements 59 | 60 | 4. **Strong Call-to-Action:** 61 | - Clear, action-oriented language 62 | - Benefit-focused CTA copy 63 | - Remove friction and objections 64 | - Create sense of urgency or excitement 65 | - Multiple CTA variations for testing 66 | 67 | 5. **Copy Structure:** 68 | - Logical flow from problem to solution 69 | - Easy-to-scan formatting 70 | - Emotional and logical appeals 71 | - Smooth transitions between sections 72 | - Strong opening and closing 73 | 74 | Focus on writing copy that speaks directly to your audience's needs, overcomes their objections, and motivates them to take immediate action. 75 | ``` 76 | 77 | ## Example Input 78 | 79 | ```markdown 80 | Product/service: Online course teaching freelancers how to raise their rates 81 | Target audience: Freelance designers and developers earning $25-50/hour who want to earn more 82 | Copy type: Sales page landing page 83 | Primary goal: Course sales 84 | Desired action: Purchase the $497 course 85 | Tone: Friendly but authoritative, empowering 86 | 87 | Pain points: Undercharging, competing on price, struggling to find high-paying clients 88 | Desires/goals: Command premium rates, work with better clients, increase income without working more hours 89 | Objections: "My clients won't pay more," "I'm not experienced enough," "I don't know how to justify higher rates" 90 | Stage in buyer journey: Consideration (know they have a problem, evaluating solutions) 91 | 92 | Unique value proposition: Only course that provides exact scripts and strategies used by 6-figure freelancers 93 | Key benefits: Double rates within 90 days, work with premium clients, proven positioning strategies 94 | Proof points: 500+ success stories, average 73% rate increase, 30-day money-back guarantee 95 | Urgency factors: Early bird pricing ends in 48 hours, bonuses only for first 100 students 96 | ``` 97 | 98 | ## Example Output 99 | 100 | ```markdown 101 | # HEADLINES: 102 | 103 | **Option 1:** "How to Double Your Freelance Rates in 90 Days (Without Losing a Single Client)" 104 | 105 | **Option 2:** "The $25/Hour Freelancer's Guide to Charging $100+ Per Hour" 106 | 107 | **Option 3:** "Stop Competing on Price: The Premium Freelancer's Playbook" 108 | 109 | **Option 4:** "From Undercharging to Overbooked: Double Your Rates in 3 Months" 110 | 111 | **Recommended:** Option 1 (specific timeframe, addresses fear, implies proven method) 112 | 113 | --- 114 | 115 | # LANDING PAGE COPY: 116 | 117 | ## Are You Tired of Being the "Affordable Option"? 118 | 119 | If you're a talented freelancer stuck charging $25-50/hour while watching less-skilled competitors command premium rates, you're not alone. 120 | 121 | **Here's the truth:** Your rates have nothing to do with your skills and everything to do with your positioning. 122 | 123 | ### The Real Reason You're Undercharging 124 | 125 | It's not because you lack experience. It's not because your market won't pay more. It's because nobody ever taught you the positioning strategies that 6-figure freelancers use to command premium rates. 126 | 127 | **What if I told you that in just 90 days, you could:** 128 | ✅ Double your hourly rate (our average student sees a 73% increase) 129 | ✅ Attract clients who see you as an investment, not an expense 130 | ✅ Stop competing with $5/hour overseas freelancers 131 | ✅ Work fewer hours while earning significantly more 132 | 133 | ### Introducing "Premium Freelancer Blueprint" 134 | 135 | The only comprehensive course that gives you the exact positioning strategies, scripts, and systems used by freelancers earning $100-300+ per hour. 136 | 137 | **What Makes This Different:** 138 | - **Real Scripts:** Get the exact emails, proposals, and conversations that land high-paying clients 139 | - **Positioning Frameworks:** Transform how clients perceive your value in their business 140 | - **Rate Increase Strategies:** Step-by-step system to raise rates with existing clients (without losing them) 141 | - **Premium Client Attraction:** Where to find clients who happily pay premium rates 142 | 143 | ### "But My Clients Won't Pay More..." 144 | 145 | This is the #1 objection we hear, and here's why it's wrong: 146 | 147 | **Your current clients won't pay more because you've positioned yourself as a cost, not an investment.** 148 | 149 | Our students regularly 2x-3x their rates with the same skill set by simply changing how they position their services. 150 | 151 | **Sarah (Web Designer):** Went from $35/hour to $85/hour in 6 weeks 152 | **Mike (Developer):** Increased project rates from $2,500 to $8,000 average 153 | **Jessica (Copywriter):** Now charges $150/hour (was $40/hour 4 months ago) 154 | 155 | ### What's Inside Premium Freelancer Blueprint: 156 | 157 | **Module 1: The Premium Positioning Foundation** 158 | - Why skill isn't enough (and what actually matters) 159 | - The 3 positioning pillars that justify premium rates 160 | - How to audit your current positioning 161 | 162 | **Module 2: The Value-First Consultation Process** 163 | - Script for discovery calls that position you as an expert 164 | - How to uncover high-value business problems 165 | - Presenting solutions that clients can't say no to 166 | 167 | **Module 3: Premium Pricing Psychology** 168 | - The psychology behind how clients make purchasing decisions 169 | - Pricing frameworks that make higher rates feel like bargains 170 | - How to present prices that clients accept immediately 171 | 172 | **Module 4: The Rate Increase Playbook** 173 | - Email templates for raising rates with existing clients 174 | - How to grandfather current projects while increasing future rates 175 | - What to do when a client says "no" (hint: most will say yes) 176 | 177 | **Module 5: Premium Client Attraction System** 178 | - Where premium clients actually hang out (it's not Upwork) 179 | - Content strategies that attract high-value prospects 180 | - Networking tactics that lead to $10K+ projects 181 | 182 | **BONUS: Premium Proposal Templates** 183 | - 5 proposal templates that close at 80%+ rates 184 | - Objection-handling scripts for every scenario 185 | - Follow-up sequences that turn maybes into yeses 186 | 187 | ### Here's What Our Students Are Saying: 188 | 189 | *"I was skeptical about raising my rates, but the scripts in this course made it effortless. I raised my development rates from $40 to $75/hour and didn't lose a single client."* - Mark T., Web Developer 190 | 191 | *"The positioning strategies completely changed how clients see me. I went from competing with dozens of designers to being the only one they consider."* - Lisa R., Graphic Designer 192 | 193 | ### Your Investment Today 194 | 195 | **Regular Price: $697** 196 | 197 | **Early Bird Price: $497** (Saves $200) 198 | *Valid for the next 48 hours only* 199 | 200 | **Plus, when you enroll today, you also get:** 201 | - BONUS #1: Client Onboarding Templates ($197 value) 202 | - BONUS #2: 30-minute Rate Increase Consultation Call ($297 value) 203 | - BONUS #3: Premium Freelancer Community Access ($97/month value) 204 | 205 | **Total Value: $1,288** 206 | **Your Price Today: $497** 207 | 208 | ### 30-Day Money-Back Guarantee 209 | 210 | Try the entire course risk-free for 30 days. If you don't see a clear path to doubling your rates, get every penny back. No questions asked. 211 | 212 | ### Ready to Stop Undercharging? 213 | 214 | Only 73 spots remaining at this early bird price. 215 | 216 | **[ENROLL NOW - SAVE $200]** 217 | 218 | *Price increases to $697 at midnight on Friday* 219 | 220 | --- 221 | 222 | **P.S.** The freelancers who consistently command premium rates aren't necessarily more skilled than you. They just know how to position their value. Stop leaving money on the table and join the 500+ freelancers who've already transformed their businesses with these strategies. 223 | 224 | --- 225 | 226 | # CALL-TO-ACTION VARIATIONS: 227 | 228 | 1. "YES! Double My Rates in 90 Days" 229 | 2. "Get Instant Access - Save $200" 230 | 3. "Start Commanding Premium Rates Today" 231 | 4. "Join 500+ Premium Freelancers" 232 | 5. "Claim Your Early Bird Spot Now" 233 | ``` 234 | 235 | ## Variations 236 | 237 | ### Social Media Ad Copy 238 | 239 | Create short, punchy copy optimized for Facebook, Instagram, LinkedIn, and Twitter ads with strong hooks and clear CTAs. 240 | 241 | ### Email Marketing Campaigns 242 | 243 | Develop nurturing sequences, promotional emails, and customer retention campaigns that build relationships and drive conversions. 244 | 245 | ### Product Descriptions 246 | 247 | Write compelling e-commerce product descriptions that highlight benefits, overcome objections, and encourage purchases. 248 | 249 | ## Tips 250 | 251 | - Lead with benefits, not features - focus on what the customer gets out of it 252 | - Use specific numbers and results rather than vague promises 253 | - Address objections before they become roadblocks to purchase 254 | - Create urgency without being pushy or manipulative 255 | - Test multiple headlines and CTAs to optimize conversion rates 256 | 257 | ## Related Prompts 258 | 259 | - [Blog Post Generator](./blog-post-generator.md) - For content marketing and thought leadership 260 | - [Email Templates](./email-templates.md) - For professional email communications 261 | - [Proposal Writer](../business/proposal-writer.md) - For business proposals and pitches 262 | 263 | ## Tags 264 | 265 | `copywriting` `marketing` `conversion` `sales-copy` `advertising` `persuasion` `email-marketing` `landing-pages` `cta-optimization` 266 | -------------------------------------------------------------------------------- /development/architecture-planner.md: -------------------------------------------------------------------------------- 1 | # Architecture Planner 2 | 3 | ## Description 4 | 5 | Helps design and plan software architecture, including system design, component relationships, technology stack decisions, and scalability considerations. Provides structured architectural guidance for projects of any size. 6 | 7 | ## Usage 8 | 9 | Describe your project requirements, constraints, and goals. Include information about expected scale, performance requirements, team size, and any existing systems. Works for both new projects and architectural refactoring. 10 | 11 | ## Prompt 12 | 13 | ```markdown 14 | Help me design the software architecture for the following project: 15 | 16 | **Project Overview:** 17 | [Describe what the system should do and its main purpose] 18 | 19 | **Requirements:** 20 | - **Functional Requirements:** 21 | - [Core features and capabilities needed] 22 | - [User interactions and workflows] 23 | - [Data processing requirements] 24 | 25 | - **Non-Functional Requirements:** 26 | - **Scale**: [Expected users, data volume, transaction volume] 27 | - **Performance**: [Response time, throughput requirements] 28 | - **Availability**: [Uptime requirements, disaster recovery needs] 29 | - **Security**: [Authentication, authorization, data protection needs] 30 | 31 | **Constraints:** 32 | - **Budget**: [Budget limitations or cost considerations] 33 | - **Team**: [Team size, skill levels, experience with technologies] 34 | - **Timeline**: [Development timeline and milestones] 35 | - **Technology**: [Required technologies, existing systems to integrate] 36 | - **Compliance**: [Regulatory or industry standards to follow] 37 | 38 | **Current State:** [Existing systems, legacy code, or starting from scratch] 39 | 40 | Please provide: 41 | 42 | 1. **High-Level Architecture** 43 | - System overview and major components 44 | - Architecture pattern recommendation (MVC, microservices, etc.) 45 | - Data flow and component interactions 46 | 47 | 2. **Technology Stack Recommendations** 48 | - Backend technologies and frameworks 49 | - Database choices and rationale 50 | - Frontend technologies 51 | - Infrastructure and deployment options 52 | 53 | 3. **Detailed Component Design** 54 | - Core services/modules breakdown 55 | - API design considerations 56 | - Data models and relationships 57 | 58 | 4. **Scalability Strategy** 59 | - How to handle growth 60 | - Performance optimization points 61 | - Caching strategies 62 | 63 | 5. **Security Architecture** 64 | - Authentication and authorization approach 65 | - Data protection measures 66 | - Security best practices 67 | 68 | 6. **Implementation Roadmap** 69 | - Development phases and priorities 70 | - MVP scope and incremental features 71 | - Risk mitigation strategies 72 | ``` 73 | 74 | ## Example Input 75 | 76 | ```markdown 77 | **Project Overview:** 78 | A real-time collaboration platform for remote teams, similar to Slack but with integrated video calls, file sharing, and project management features. 79 | 80 | **Requirements:** 81 | - **Functional Requirements:** 82 | - Real-time messaging and channels 83 | - Video/audio calling for up to 50 participants 84 | - File upload and sharing (up to 100MB per file) 85 | - Task management and project boards 86 | - User authentication and team management 87 | 88 | - **Non-Functional Requirements:** 89 | - **Scale**: 10,000 concurrent users, 100,000 total users 90 | - **Performance**: <200ms message delivery, <3s file upload 91 | - **Availability**: 99.9% uptime 92 | - **Security**: Enterprise-grade security, GDPR compliance 93 | 94 | **Constraints:** 95 | - **Budget**: $50k initial development budget 96 | - **Team**: 5 full-stack developers, 1 DevOps engineer 97 | - **Timeline**: 6 months to MVP, 12 months to full feature set 98 | - **Technology**: Team has experience with React, Node.js, PostgreSQL 99 | ``` 100 | 101 | ## Example Output 102 | 103 | ```markdown 104 | # Collaboration Platform Architecture Design 105 | 106 | ## High-Level Architecture 107 | 108 | ### Architecture Pattern: Microservices with Event-Driven Communication 109 | ``` 110 | 111 | ┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ 112 | │ Web Client │ │ Mobile Client │ │ Desktop App │ 113 | │ (React) │ │ (React Native)│ │ (Electron) │ 114 | └─────────┬───────┘ └─────────┬───────┘ └─────────┬───────┘ 115 | │ │ │ 116 | └──────────────────────┼──────────────────────┘ 117 | │ 118 | ┌─────────────┴─────────────┐ 119 | │ API Gateway │ 120 | │ (Authentication + │ 121 | │ Load Balancing) │ 122 | └─────────────┬─────────────┘ 123 | │ 124 | ┌─────────────┬───────────────┼───────────────┬─────────────┐ 125 | │ │ │ │ │ 126 | ┌───▼───┐ ┌───▼───┐ ┌───▼───┐ ┌───▼───┐ ┌───▼───┐ 127 | │Message│ │ User │ │ File │ │Video │ │Project│ 128 | │Service│ │Service│ │Service│ │Service│ │Service│ 129 | └───┬───┘ └───┬───┘ └───┬───┘ └───┬───┘ └───┬───┘ 130 | │ │ │ │ │ 131 | └────────────┼───────────────┼──────────────┼────────────┘ 132 | │ │ │ 133 | ┌────▼────┐ ┌────▼────┐ ┌────▼────┐ 134 | │PostgreSQL│ │ S3 │ │ Redis │ 135 | │(Primary) │ │(Files) │ │(Cache) │ 136 | └─────────┘ └─────────┘ └─────────┘ 137 | 138 | ``` 139 | 140 | ## Technology Stack Recommendations 141 | 142 | ### Backend 143 | - **Language**: Node.js with TypeScript (team familiarity) 144 | - **Framework**: Express.js with Fastify for high-performance services 145 | - **Real-time**: Socket.io for WebSocket connections 146 | - **Message Queue**: Redis for pub/sub and job queues 147 | - **Video**: WebRTC with Kurento Media Server for large calls 148 | 149 | ### Database 150 | - **Primary**: PostgreSQL for structured data (users, teams, projects) 151 | - **Cache**: Redis for sessions, real-time data, and message caching 152 | - **File Storage**: AWS S3 or MinIO for file uploads 153 | - **Search**: Elasticsearch for message search functionality 154 | 155 | ### Frontend 156 | - **Framework**: React with TypeScript 157 | - **State Management**: Redux Toolkit for complex state 158 | - **Real-time**: Socket.io client 159 | - **UI Library**: Material-UI or Ant Design for rapid development 160 | 161 | ### Infrastructure 162 | - **Containerization**: Docker with Docker Compose for development 163 | - **Orchestration**: Kubernetes for production (or start with simple VPS) 164 | - **CI/CD**: GitHub Actions 165 | - **Monitoring**: Prometheus + Grafana 166 | 167 | ## Detailed Component Design 168 | 169 | ### 1. Message Service 170 | ```typescript 171 | interface MessageService { 172 | sendMessage(channelId: string, message: MessagePayload): Promise 173 | getChannelHistory(channelId: string, limit: number): Promise 174 | subscribeToChannel(channelId: string, userId: string): void 175 | } 176 | ``` 177 | 178 | - Real-time message delivery via Socket.io 179 | - Message persistence in PostgreSQL 180 | - Redis for message caching and pub/sub 181 | 182 | ### 2. User Service 183 | 184 | ```typescript 185 | interface UserService { 186 | authenticate(credentials: LoginCredentials): Promise 187 | createUser(userData: CreateUserRequest): Promise 188 | updateUserStatus(userId: string, status: UserStatus): Promise 189 | } 190 | ``` 191 | 192 | - JWT-based authentication 193 | - User management and team assignments 194 | - Integration with external OAuth providers 195 | 196 | ### 3. File Service 197 | 198 | - Secure file upload with virus scanning 199 | - Progressive upload for large files 200 | - Automatic thumbnail generation for images 201 | - CDN integration for fast delivery 202 | 203 | ### 4. Video Service 204 | 205 | - WebRTC peer-to-peer for small calls (<5 people) 206 | - Selective Forwarding Unit (SFU) for larger calls 207 | - Recording capabilities with cloud storage 208 | - Screen sharing support 209 | 210 | ## Scalability Strategy 211 | 212 | ### Phase 1 (MVP): Monolithic Start 213 | 214 | - Single Node.js application 215 | - PostgreSQL primary database 216 | - Redis for caching 217 | - Supports up to 1,000 concurrent users 218 | 219 | ### Phase 2 (Growth): Service Separation 220 | 221 | - Extract message service for independent scaling 222 | - Add read replicas for database 223 | - Implement horizontal scaling for video services 224 | - CDN for static assets 225 | 226 | ### Phase 3 (Scale): Full Microservices 227 | 228 | - Complete service decomposition 229 | - Database sharding by team/organization 230 | - Multi-region deployment 231 | - Advanced caching strategies 232 | 233 | ## Security Architecture 234 | 235 | ### Authentication & Authorization 236 | 237 | ``` 238 | User → API Gateway → JWT Validation → Service Authorization 239 | ``` 240 | 241 | - JWT tokens with short expiry (15 minutes) 242 | - Refresh token rotation 243 | - Role-based access control (RBAC) 244 | - Rate limiting per user/IP 245 | 246 | ### Data Protection 247 | 248 | - End-to-end encryption for sensitive messages 249 | - At-rest encryption for database and files 250 | - HTTPS everywhere with HSTS headers 251 | - Input validation and sanitization 252 | 253 | ## Implementation Roadmap 254 | 255 | ### Phase 1 (Months 1-2): Core MVP 256 | 257 | **Goal**: Basic messaging and user management 258 | 259 | - User authentication and team creation 260 | - Real-time messaging in channels 261 | - Basic file sharing 262 | - Simple web client 263 | 264 | **MVP Features:** 265 | 266 | - Login/signup 267 | - Create teams and channels 268 | - Send/receive messages 269 | - Upload/download files 270 | 271 | ### Phase 2 (Months 3-4): Enhanced Features 272 | 273 | - Video calling (up to 10 participants) 274 | - Message search 275 | - Mobile-responsive design 276 | - Basic project management features 277 | 278 | ### Phase 3 (Months 5-6): Production Ready 279 | 280 | - Advanced video features (screen sharing, recording) 281 | - Full project management integration 282 | - Admin dashboard 283 | - Comprehensive security features 284 | 285 | ### Risk Mitigation 286 | 287 | 1. **Technical Risks**: 288 | - Start with proven technologies 289 | - Build comprehensive testing early 290 | - Plan for database migration strategies 291 | 292 | 2. **Scalability Risks**: 293 | - Design with microservices in mind from day 1 294 | - Use feature flags for gradual rollouts 295 | - Monitor performance metrics continuously 296 | 297 | 3. **Security Risks**: 298 | - Regular security audits 299 | - Implement logging and monitoring 300 | - Have incident response plan ready 301 | 302 | ## Success Metrics 303 | 304 | - Message delivery latency <200ms 305 | - 99.9% uptime 306 | - Support 10,000 concurrent users 307 | - File upload success rate >99% 308 | - Video call quality metrics 309 | 310 | ``` 311 | 312 | ## Variations 313 | - **Enterprise Architecture**: Focus on enterprise patterns and governance 314 | - **Microservices Design**: Deep dive into service decomposition 315 | - **Cloud-Native**: Emphasize cloud services and serverless architectures 316 | - **Legacy Migration**: Focus on modernizing existing systems 317 | 318 | ## Tips 319 | - Be specific about scale and performance requirements 320 | - Include budget and timeline constraints for realistic recommendations 321 | - Mention team expertise to align technology choices 322 | - Consider starting simple and evolving the architecture over time 323 | - Always include security and compliance considerations 324 | 325 | ## Related Prompts 326 | - `code-review.md` - For reviewing architectural decisions in code 327 | - `documentation-generator.md` - For creating architecture documentation 328 | - `test-case-generator.md` - For testing architectural components 329 | 330 | ## Tags 331 | `architecture` `system-design` `scalability` `technology-stack` `development` `planning` 332 | -------------------------------------------------------------------------------- /productivity/task-prioritization.md: -------------------------------------------------------------------------------- 1 | # Task Prioritization Matrix 2 | 3 | ## Description 4 | 5 | Helps organize and prioritize tasks using various prioritization frameworks like Eisenhower Matrix, MoSCoW method, and value-based scoring. Creates actionable task lists with clear priorities and deadlines. 6 | 7 | ## Usage 8 | 9 | Provide your list of tasks, projects, or initiatives along with relevant context about deadlines, importance, and resources. Specify your preferred prioritization method or let the AI recommend the best approach for your situation. 10 | 11 | ## Prompt 12 | 13 | ```markdown 14 | Help me prioritize the following tasks and create an organized action plan: 15 | 16 | **Prioritization Context:** 17 | - **Role/Position:** [Your role and responsibilities] 18 | - **Time Frame:** [Daily/Weekly/Monthly planning horizon] 19 | - **Current Workload:** [Current capacity and constraints] 20 | - **Key Goals:** [Main objectives you're working toward] 21 | 22 | **Tasks to Prioritize:** 23 | [List all tasks, projects, or initiatives that need prioritization] 24 | 25 | For each task, please consider: 26 | - **Urgency:** How time-sensitive is this task? 27 | - **Importance:** How critical is this to your goals? 28 | - **Effort Required:** How much time/energy will this take? 29 | - **Dependencies:** Does this block other work or people? 30 | - **Impact:** What's the potential value or consequence? 31 | 32 | **Prioritization Method:** 33 | [Choose one or ask for recommendation] 34 | - **Eisenhower Matrix:** Urgent/Important quadrants 35 | - **MoSCoW Method:** Must have, Should have, Could have, Won't have 36 | - **Value vs. Effort:** High impact, low effort tasks first 37 | - **ICE Score:** Impact, Confidence, Ease scoring 38 | - **Custom Approach:** Based on your specific criteria 39 | 40 | **Additional Constraints:** 41 | - **Deadlines:** [Any fixed deadlines or time constraints] 42 | - **Resources:** [Team members, budget, or tool limitations] 43 | - **Dependencies:** [Tasks that depend on others or external factors] 44 | - **Energy Levels:** [When you're most/least productive] 45 | 46 | Please provide: 47 | 1. **Prioritized Task List** with reasoning for each priority level 48 | 2. **Action Plan** with recommended sequence and timing 49 | 3. **Quick Wins** that can be completed immediately 50 | 4. **Time Blocking Suggestions** for optimal scheduling 51 | 5. **Risk Assessment** for high-priority items 52 | 6. **Regular Review Schedule** for maintaining priorities 53 | 54 | **Personal Preferences:** 55 | [Any specific working styles, preferences, or constraints to consider] 56 | ``` 57 | 58 | ## Example Input 59 | 60 | ```markdown 61 | **Prioritization Context:** 62 | - **Role/Position:** Product Manager at a SaaS startup 63 | - **Time Frame:** Weekly planning (40 hours available) 64 | - **Current Workload:** Managing 3 active projects, regular meetings take 15 hours/week 65 | - **Key Goals:** Launch new feature by end of quarter, improve customer retention, reduce support tickets 66 | 67 | **Tasks to Prioritize:** 68 | 1. Finalize user research analysis for new dashboard feature 69 | 2. Write product requirements document for mobile app 70 | 3. Review and respond to 15 customer feedback emails 71 | 4. Prepare presentation for next week's board meeting 72 | 5. Conduct user interviews for retention study 73 | 6. Update project roadmap and timelines 74 | 7. Fix critical bug causing payment failures 75 | 8. Plan team offsite for next month 76 | 9. Review competitor analysis report 77 | 10. Optimize onboarding flow based on analytics 78 | 11. Schedule 1-on-1s with team members 79 | 12. Create documentation for new API endpoints 80 | 81 | **Additional Constraints:** 82 | - **Deadlines:** Board presentation due Friday, bug fix needed ASAP 83 | - **Resources:** Engineering team at capacity, limited designer availability 84 | - **Dependencies:** User research needed before finalizing mobile app requirements 85 | - **Energy Levels:** Most focused 9-11 AM, low energy after 3 PM meetings 86 | ``` 87 | 88 | ## Example Output 89 | 90 | ```markdown 91 | # Weekly Task Prioritization Plan 92 | 93 | ## Priority Classification (Eisenhower Matrix) 94 | 95 | ### 🚨 Urgent & Important (Do First) 96 | **1. Fix critical bug causing payment failures** 97 | - **Why Priority 1:** Revenue impact, customer trust at risk 98 | - **Time Estimate:** 4-6 hours (coordination with engineering) 99 | - **Action:** Schedule emergency fix session today 100 | 101 | **2. Prepare presentation for board meeting** 102 | - **Why Priority 1:** Hard deadline, stakeholder visibility 103 | - **Time Estimate:** 6 hours 104 | - **Action:** Block Thursday morning for focused preparation 105 | 106 | ### ⭐ Important, Not Urgent (Schedule) 107 | **3. Finalize user research analysis for dashboard feature** 108 | - **Why High Priority:** Blocks Q4 feature development 109 | - **Time Estimate:** 4 hours 110 | - **Action:** Schedule for Tuesday AM (high energy time) 111 | 112 | **4. Update project roadmap and timelines** 113 | - **Why High Priority:** Team alignment, board presentation input 114 | - **Time Estimate:** 3 hours 115 | - **Action:** Complete before board presentation 116 | 117 | **5. Conduct user interviews for retention study** 118 | - **Why High Priority:** Directly supports retention goal 119 | - **Time Estimate:** 5 hours (including scheduling and prep) 120 | - **Action:** Schedule 3 interviews this week, 2 next week 121 | 122 | ### ⚡ Urgent, Not Important (Delegate/Minimize) 123 | **6. Review and respond to customer feedback emails** 124 | - **Why Lower Priority:** Important but can be batched 125 | - **Time Estimate:** 2 hours 126 | - **Action:** Batch process Friday afternoon 127 | 128 | **7. Schedule 1-on-1s with team members** 129 | - **Why Lower Priority:** Important for team but flexible timing 130 | - **Time Estimate:** 30 minutes scheduling + 3 hours meetings 131 | - **Action:** Delegate scheduling to assistant, do meetings next week 132 | 133 | ### 📋 Neither Urgent nor Important (Eliminate/Defer) 134 | **8. Plan team offsite for next month** 135 | - **Action:** Defer to next week or delegate to team lead 136 | 137 | **9. Review competitor analysis report** 138 | - **Action:** Defer to following week when less urgent items are handled 139 | 140 | **10. Create documentation for API endpoints** 141 | - **Action:** Delegate to engineering team or defer 142 | 143 | --- 144 | 145 | ## Recommended Weekly Schedule 146 | 147 | ### Monday (8 hours) 148 | - **9:00-11:00 AM:** Emergency bug fix coordination (2 hours) 149 | - **11:00-12:00 PM:** Project roadmap updates (1 hour) 150 | - **1:00-3:00 PM:** Board presentation outline and data gathering (2 hours) 151 | - **3:00-4:00 PM:** Customer feedback email batch (1 hour) 152 | - **4:00-5:00 PM:** User interview scheduling and prep (1 hour) 153 | - **5:00-5:30 PM:** Quick team check-ins (30 minutes) 154 | 155 | ### Tuesday (8 hours) 156 | - **9:00-11:00 AM:** 🎯 User research analysis (2 hours - peak focus) 157 | - **11:00-1:00 PM:** Continued user research analysis (2 hours) 158 | - **2:00-4:00 PM:** User interviews (2 hours) 159 | - **4:00-5:00 PM:** Board presentation content development (1 hour) 160 | - **5:00-5:30 PM:** Team standup and priority adjustments (30 minutes) 161 | 162 | ### Wednesday (8 hours) 163 | - **9:00-12:00 PM:** Board presentation creation and rehearsal (3 hours) 164 | - **1:00-2:00 PM:** Finalize project roadmap updates (1 hour) 165 | - **2:00-4:00 PM:** User interviews (2 hours) 166 | - **4:00-5:00 PM:** Mobile app requirements planning (1 hour) 167 | - **5:00-5:30 PM:** Progress review and Thursday planning (30 minutes) 168 | 169 | ### Thursday (8 hours) 170 | - **9:00-11:00 AM:** Final board presentation preparation (2 hours) 171 | - **11:00-12:00 PM:** Board presentation rehearsal (1 hour) 172 | - **1:00-3:00 PM:** Board presentation delivery and follow-up (2 hours) 173 | - **3:00-5:00 PM:** Onboarding flow optimization analysis (2 hours) 174 | - **5:00-5:30 PM:** Week wrap-up and Friday planning (30 minutes) 175 | 176 | ### Friday (8 hours) 177 | - **9:00-11:00 AM:** Mobile app requirements document start (2 hours) 178 | - **11:00-12:00 PM:** Customer feedback email responses (1 hour) 179 | - **1:00-2:00 PM:** 1-on-1 with team lead (1 hour) 180 | - **2:00-4:00 PM:** Week review and next week planning (2 hours) 181 | - **4:00-5:00 PM:** Administrative tasks and cleanup (1 hour) 182 | 183 | --- 184 | 185 | ## Quick Wins (Complete This Week) 186 | 187 | ### ✅ Immediate Actions (< 30 minutes each) 188 | - Email engineering team about bug fix urgency 189 | - Block calendar time for board presentation prep 190 | - Send calendar invites for user interviews 191 | - Update team on priority changes in Slack 192 | 193 | ### ✅ 1-Hour Actions 194 | - Batch respond to urgent customer emails 195 | - Update project status in management tools 196 | - Schedule next week's 1-on-1 meetings 197 | - Review and prioritize backlog items 198 | 199 | --- 200 | 201 | ## Risk Assessment & Mitigation 202 | 203 | ### High-Risk Items 204 | **1. Bug Fix Complexity** 205 | - **Risk:** May take longer than estimated, affecting other priorities 206 | - **Mitigation:** Involve senior engineer early, prepare communication for stakeholders 207 | 208 | **2. Board Presentation Quality** 209 | - **Risk:** Insufficient time for proper preparation 210 | - **Mitigation:** Start with existing templates, focus on key metrics only 211 | 212 | **3. User Research Dependencies** 213 | - **Risk:** Interview cancellations could delay analysis 214 | - **Mitigation:** Schedule backup interviews, prepare alternative data sources 215 | 216 | --- 217 | 218 | ## Time Blocking Strategy 219 | 220 | ### Energy-Based Scheduling 221 | - **High Focus Tasks (9-11 AM):** User research analysis, presentation creation 222 | - **Medium Focus Tasks (11 AM-1 PM):** Documentation, planning work 223 | - **Low Focus Tasks (After 3 PM):** Email responses, administrative work 224 | - **Meeting Blocks:** Keep 1-3 PM for interviews and team interactions 225 | 226 | ### Buffer Time Management 227 | - **Daily Buffer:** 30 minutes at end of each day for unexpected issues 228 | - **Weekly Buffer:** Friday afternoon for catch-up and planning 229 | - **Emergency Reserve:** 2 hours total across the week for critical issues 230 | 231 | --- 232 | 233 | ## Success Metrics 234 | 235 | ### This Week's Goals 236 | - [ ] Critical bug resolved by Wednesday 237 | - [ ] Board presentation delivered successfully 238 | - [ ] User research analysis completed 239 | - [ ] 5 user interviews conducted 240 | - [ ] Project roadmap updated 241 | 242 | ### Weekly Review Questions 243 | 1. Did high-priority items get completed? 244 | 2. What caused delays or inefficiencies? 245 | 3. How accurate were time estimates? 246 | 4. What should be prioritized differently next week? 247 | 5. Are we making progress toward quarterly goals? 248 | 249 | --- 250 | 251 | ## Next Week Preview 252 | 253 | ### Priorities to Advance 254 | - Complete mobile app requirements document 255 | - Continue user interviews and retention analysis 256 | - Plan team offsite (delegate to team lead) 257 | - Review competitor analysis 258 | - Start API documentation project 259 | 260 | ### Schedule Optimization 261 | - Block more focused time for deep work 262 | - Reduce meeting overhead where possible 263 | - Batch similar tasks more effectively 264 | - Build in more buffer time for unexpected priorities 265 | 266 | This prioritization framework balances urgent business needs with strategic goals while accounting for your working style and constraints. The key is maintaining flexibility while protecting time for high-impact work. 267 | ``` 268 | 269 | ## Variations 270 | 271 | - **Daily Planning**: Focus on single-day task management and optimization 272 | - **Project Prioritization**: Prioritize multiple projects or initiatives rather than individual tasks 273 | - **Team Priorities**: Collaborative prioritization for team or department-level work 274 | - **Goal-Based Planning**: Align tasks with specific objectives and key results (OKRs) 275 | 276 | ## Tips 277 | 278 | - Be honest about time estimates - add 25% buffer for most tasks 279 | - Consider your energy levels and schedule demanding work during peak hours 280 | - Review and adjust priorities regularly as circumstances change 281 | - Don't overcommit - it's better to do fewer things well 282 | - Include time for unexpected urgent tasks in your planning 283 | - Use the 2-minute rule: if something takes less than 2 minutes, do it immediately 284 | 285 | ## Related Prompts 286 | 287 | - `meeting-summary.md` - For capturing action items from meetings to prioritize 288 | - `email-templates.md` - For communicating priorities and deadlines 289 | - `brainstorming-session.md` - For generating solutions to productivity challenges 290 | 291 | ## Tags 292 | 293 | `productivity` `time-management` `prioritization` `planning` `organization` `task-management` 294 | --------------------------------------------------------------------------------