Prompts & Templates¶
AI prompt engineering resources and templates for documentation
Available Prompts¶
-
Document Editor
Guidelines for writing and maintaining technical documentation.
-
Database Prompt
Prompts for database schema design and optimization.
-
Architecture Design
Comprehensive prompts for software architecture documentation.
Prompt Categories¶
mindmap
root((AI Prompts))
Documentation
Technical Writing
API Docs
User Guides
Architecture
C4 Model
System Design
Component Design
Database
Schema Design
Query Optimization
Migration Plans
Code
Code Review
Refactoring
Testing
Usage Guidelines¶
Best Practices¶
- Be Specific: Provide clear context and requirements
- Use Examples: Include sample inputs/outputs when possible
- Iterate: Refine prompts based on results
- Document: Keep track of effective prompts
Prompt Structure¶
# Role
Define the AI's persona and expertise level
# Context
Provide background information and constraints
# Task
Clearly state what needs to be accomplished
# Output Format
Specify the expected format and structure
# Examples (Optional)
Show sample inputs and expected outputs