Help & Guidance

Prompting Best Practices

Artifact Types

The Prompt Library organizes reusable assets into several artifact types. Each type serves a distinct purpose in AI-assisted development and project management.

AI Prompts

AI prompts are predefined inputs used to guide AI models in generating responses. They are essential for ensuring that AI outputs are relevant and useful.

Usage: Copy and paste the prompt directly into your AI assistant's chat window.

Example: Project Management User Story Generator
# User Story Generator Prompt ## Format Template As a [type of user] I want to [perform some action] So that [achieve some goal] ## Key Considerations - User's role and context - Specific action or functionality - Clear business value or benefit - Acceptance criteria - Technical constraints ## Instructions Please write 3-5 user stories following this format for: [feature description] ## Example Output As a content editor I want to preview content in different screen sizes So that I can ensure responsive design works correctly Acceptance Criteria: - Support desktop, tablet, and mobile views - Allow custom viewport dimensions - Show responsive breakpoints - Real-time preview updates
Rules (.cursor/rules)

Cursor Rules define specific behaviors, guidelines, and configurations for your development environment and AI interactions within the Cursor editor. They help maintain consistency, enforce standards, and streamline workflows.

File Location Examples: .cursor/rules/code-review.mdc, .cursor/rules/project-guidelines.md

These rules can cover a wide range of topics, including coding standards, commit message formats, documentation requirements, and even persona definitions for the AI.

Example: Code Review Guidelines
# Code Review Guidelines ## Scope Applies to: JavaScript, TypeScript, and React files (*.js, *.ts, *.jsx, *.tsx) ## Review Checklist ### Code Quality - [ ] Error handling and edge cases covered - [ ] Consistent naming conventions followed - [ ] Test coverage for new functionality - [ ] No security vulnerabilities present - [ ] Performance considerations addressed - [ ] Accessibility standards met ### Automation Settings - Auto-format on save enabled - Import organization automated - Warning level severity ## Additional Notes - Run linter before submitting - Update documentation if needed - Consider backwards compatibility
Project Configs

Project configurations are settings and parameters that define how a project is built, run, or how specific tools related to the project should behave. They are crucial for maintaining consistency and sharing setup information.

File Location Example: [category]/project-configs/[config-name].md (e.g., development/project-configs/11ty-setup.md)

Example: Next.js Project Configuration
# Next.js Configuration Guide ## Image Optimization - Supported domains: assets.example.com - Formats: AVIF, WebP - Quality settings optimized for web ## Internationalization - Supported languages: English, Spanish, French - Default: English - Automatic language detection enabled ## Environment Variables Required variables: - API_ENDPOINT: Backend API URL - ANALYTICS_ID: Web analytics identifier ## Experimental Features Enabled features: - Server Actions - Typed Routes ## URL Management ### Redirects Old Path | New Path | Type ---------|----------|------ /old-blog/:slug | /blog/:slug | Permanent ## Development Notes - Update env variables per environment - Test redirects after deployment - Monitor experimental features
Workflow States

Workflow states represent the different stages of a project, task, or content lifecycle. They help in tracking progress, defining processes, and managing tasks efficiently.

File Location Example: [category]/workflow-states/[workflow-name].md (e.g., content-strategy/workflow-states/editorial-workflow.md)

Example: Content Publishing Workflow
# Content Publishing Workflow ## Draft **Owner**: Content Writer **Required**: title, body, category Initial content creation phase ## Technical Review **Owner**: Technical Editor **Required**: technical_accuracy, code_review Code snippets and technical accuracy check ## Editorial Review **Owner**: Editor **Required**: grammar_check, style_guide_compliance Grammar, style, and tone review ## Final Approval **Owner**: Content Manager **Required**: seo_check, accessibility_check Final review before publishing ## Published **Required**: publish_date, author, meta_data Content is live on the website ## Workflow Transitions 1. Draft → Technical Review 2. Technical Review → Draft or Editorial Review 3. Editorial Review → Technical Review or Final Approval 4. Final Approval → Editorial Review or Published ## Notes - All required fields must be completed - Each state requires sign-off - Published content needs archive strategy

Core Concepts

Memory Bank

The Memory Bank is a structured collection of Markdown files designed to provide persistent context and project knowledge. Since AI assistants like Cursor may have their memory reset between sessions, the Memory Bank ensures that critical information about the project's goals, technical details, current progress, and active context is always available.

Key components typically include:

  • projectbrief.md: Core requirements and goals.
  • productContext.md: The 'why' behind the project.
  • systemPatterns.md: Architecture and technical decisions.
  • techContext.md: Technologies and setup.
  • activeContext.md: Current work focus.
  • progress.md: Status and known issues.

Maintaining the Memory Bank is crucial for effective collaboration with AI assistants. These files are typically located in the memory-bank/ directory, often with subdirectories for each component e.g. memory-bank/projectbrief.md

Browse the Memory Bank documentation