aia 0.9.11 → 0.9.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.version +1 -1
- data/CHANGELOG.md +66 -2
- data/README.md +133 -4
- data/docs/advanced-prompting.md +721 -0
- data/docs/cli-reference.md +582 -0
- data/docs/configuration.md +347 -0
- data/docs/contributing.md +332 -0
- data/docs/directives-reference.md +490 -0
- data/docs/examples/index.md +277 -0
- data/docs/examples/mcp/index.md +479 -0
- data/docs/examples/prompts/analysis/index.md +78 -0
- data/docs/examples/prompts/automation/index.md +108 -0
- data/docs/examples/prompts/development/index.md +125 -0
- data/docs/examples/prompts/index.md +333 -0
- data/docs/examples/prompts/learning/index.md +127 -0
- data/docs/examples/prompts/writing/index.md +62 -0
- data/docs/examples/tools/index.md +292 -0
- data/docs/faq.md +414 -0
- data/docs/guides/available-models.md +366 -0
- data/docs/guides/basic-usage.md +477 -0
- data/docs/guides/chat.md +474 -0
- data/docs/guides/executable-prompts.md +417 -0
- data/docs/guides/first-prompt.md +454 -0
- data/docs/guides/getting-started.md +455 -0
- data/docs/guides/image-generation.md +507 -0
- data/docs/guides/index.md +46 -0
- data/docs/guides/models.md +507 -0
- data/docs/guides/tools.md +856 -0
- data/docs/index.md +173 -0
- data/docs/installation.md +238 -0
- data/docs/mcp-integration.md +612 -0
- data/docs/prompt_management.md +579 -0
- data/docs/security.md +629 -0
- data/docs/tools-and-mcp-examples.md +1186 -0
- data/docs/workflows-and-pipelines.md +563 -0
- data/examples/tools/mcp/github_mcp_server.json +11 -0
- data/examples/tools/mcp/imcp.json +7 -0
- data/lib/aia/chat_processor_service.rb +19 -3
- data/lib/aia/config/base.rb +224 -0
- data/lib/aia/config/cli_parser.rb +409 -0
- data/lib/aia/config/defaults.rb +88 -0
- data/lib/aia/config/file_loader.rb +131 -0
- data/lib/aia/config/validator.rb +184 -0
- data/lib/aia/config.rb +10 -860
- data/lib/aia/directive_processor.rb +27 -372
- data/lib/aia/directives/configuration.rb +114 -0
- data/lib/aia/directives/execution.rb +37 -0
- data/lib/aia/directives/models.rb +178 -0
- data/lib/aia/directives/registry.rb +120 -0
- data/lib/aia/directives/utility.rb +70 -0
- data/lib/aia/directives/web_and_file.rb +71 -0
- data/lib/aia/prompt_handler.rb +23 -3
- data/lib/aia/ruby_llm_adapter.rb +307 -128
- data/lib/aia/session.rb +27 -14
- data/lib/aia/utility.rb +12 -8
- data/lib/aia.rb +11 -2
- data/lib/extensions/ruby_llm/.irbrc +56 -0
- data/mkdocs.yml +165 -0
- metadata +77 -20
- /data/{images → docs/assets/images}/aia.png +0 -0
@@ -0,0 +1,125 @@
|
|
1
|
+
# Development Prompts
|
2
|
+
|
3
|
+
Collection of prompts for software development tasks.
|
4
|
+
|
5
|
+
## Available Prompts
|
6
|
+
|
7
|
+
### Code Review
|
8
|
+
- **code_review.txt** - Comprehensive code analysis and review
|
9
|
+
- **security_review.txt** - Security-focused code review
|
10
|
+
- **performance_review.txt** - Performance analysis and optimization
|
11
|
+
|
12
|
+
### Documentation
|
13
|
+
- **generate_docs.txt** - Generate code documentation
|
14
|
+
- **api_docs.txt** - API documentation generation
|
15
|
+
- **readme_generator.txt** - README file creation
|
16
|
+
|
17
|
+
### Debugging
|
18
|
+
- **debug_analysis.txt** - Systematic bug analysis
|
19
|
+
- **error_investigation.txt** - Error investigation and resolution
|
20
|
+
- **performance_debug.txt** - Performance issue diagnosis
|
21
|
+
|
22
|
+
### Architecture
|
23
|
+
- **architecture_analysis.txt** - System architecture review
|
24
|
+
- **design_patterns.txt** - Design pattern recommendations
|
25
|
+
- **refactoring_guide.txt** - Code refactoring suggestions
|
26
|
+
|
27
|
+
### Testing
|
28
|
+
- **test_strategy.txt** - Test strategy development
|
29
|
+
- **unit_test_generator.txt** - Unit test creation
|
30
|
+
- **integration_testing.txt** - Integration test planning
|
31
|
+
|
32
|
+
## Usage Examples
|
33
|
+
|
34
|
+
```bash
|
35
|
+
# Basic code review
|
36
|
+
aia code_review my_file.py
|
37
|
+
|
38
|
+
# Security-focused review
|
39
|
+
aia security_review --severity high auth_module.rb
|
40
|
+
|
41
|
+
# Generate comprehensive documentation
|
42
|
+
aia generate_docs --format markdown src/
|
43
|
+
```
|
44
|
+
|
45
|
+
## Detailed Example Prompts
|
46
|
+
|
47
|
+
### Code Review Prompt
|
48
|
+
```bash
|
49
|
+
# ~/.prompts/code_review.txt
|
50
|
+
//config model gpt-4o-mini
|
51
|
+
//config temperature 0.3
|
52
|
+
|
53
|
+
Review this code for:
|
54
|
+
- Best practices adherence
|
55
|
+
- Security vulnerabilities
|
56
|
+
- Performance issues
|
57
|
+
- Maintainability concerns
|
58
|
+
|
59
|
+
Code to review:
|
60
|
+
```
|
61
|
+
|
62
|
+
**Usage:** `aia code_review mycode.rb`
|
63
|
+
|
64
|
+
### Meeting Notes Processor
|
65
|
+
```bash
|
66
|
+
# ~/.prompts/meeting_notes.txt
|
67
|
+
//config model gpt-4o-mini
|
68
|
+
//pipeline format,action_items
|
69
|
+
|
70
|
+
Raw meeting notes:
|
71
|
+
//include [NOTES_FILE]
|
72
|
+
|
73
|
+
Please clean up and structure these meeting notes.
|
74
|
+
```
|
75
|
+
|
76
|
+
**Usage:** `aia meeting_notes raw_notes.txt`
|
77
|
+
|
78
|
+
### Documentation Generator
|
79
|
+
```bash
|
80
|
+
# ~/.prompts/document.txt
|
81
|
+
//config model gpt-4o-mini
|
82
|
+
//shell find [PROJECT_DIR] -name "*.rb" | head -10
|
83
|
+
|
84
|
+
Generate documentation for the Ruby project shown above.
|
85
|
+
Include: API references, usage examples, and setup instructions.
|
86
|
+
```
|
87
|
+
|
88
|
+
**Usage:** `aia document --PROJECT_DIR ./my_project`
|
89
|
+
|
90
|
+
### Multi-Model Decision Making
|
91
|
+
```bash
|
92
|
+
# ~/.prompts/decision_maker.txt
|
93
|
+
# Compare different AI perspectives on complex decisions
|
94
|
+
|
95
|
+
What are the pros and cons of [DECISION_TOPIC]?
|
96
|
+
Consider: technical feasibility, business impact, risks, and alternatives.
|
97
|
+
|
98
|
+
Analyze this thoroughly and provide actionable recommendations.
|
99
|
+
```
|
100
|
+
|
101
|
+
**Usage Examples:**
|
102
|
+
```bash
|
103
|
+
# Get individual perspectives from each model
|
104
|
+
aia decision_maker --model "gpt-4o-mini,gpt-3.5-turbo,gpt-5-mini" --no-consensus
|
105
|
+
|
106
|
+
# Get a synthesized consensus recommendation
|
107
|
+
aia decision_maker --model "gpt-4o-mini,gpt-3.5-turbo,gpt-5-mini" --consensus
|
108
|
+
|
109
|
+
# Use with chat mode for follow-up questions
|
110
|
+
aia --chat --model "gpt-4o-mini,gpt-3.5-turbo" --consensus
|
111
|
+
```
|
112
|
+
|
113
|
+
## Customization
|
114
|
+
|
115
|
+
These prompts can be customized with parameters:
|
116
|
+
- `--model` - Choose appropriate AI model
|
117
|
+
- `--temperature` - Adjust creativity level
|
118
|
+
- `--severity` - Focus level for reviews
|
119
|
+
- `--format` - Output format preference
|
120
|
+
|
121
|
+
## Related
|
122
|
+
|
123
|
+
- [Tools Examples](../../tools/index.md) - Development tools
|
124
|
+
- [Analysis Prompts](../analysis/index.md) - Data analysis prompts
|
125
|
+
- [Automation Prompts](../automation/index.md) - Process automation
|
@@ -0,0 +1,333 @@
|
|
1
|
+
# Prompt Examples
|
2
|
+
|
3
|
+
This collection contains real-world prompt examples organized by category and complexity level.
|
4
|
+
|
5
|
+
## Categories
|
6
|
+
|
7
|
+
### [Development](development/index.md)
|
8
|
+
Prompts for software development tasks:
|
9
|
+
- **Code Review**: Quality analysis and improvement suggestions
|
10
|
+
- **Documentation**: Generate comprehensive code documentation
|
11
|
+
- **Debugging**: Systematic problem diagnosis and resolution
|
12
|
+
- **Architecture**: System design analysis and recommendations
|
13
|
+
- **Testing**: Test strategy and implementation guidance
|
14
|
+
|
15
|
+
### [Writing](writing/index.md)
|
16
|
+
Content creation and editing prompts:
|
17
|
+
- **Technical Writing**: API docs, tutorials, technical guides
|
18
|
+
- **Blog Posts**: Engaging technical and general content
|
19
|
+
- **Creative Writing**: Stories, poetry, creative projects
|
20
|
+
- **Editing**: Content improvement and style refinement
|
21
|
+
- **Marketing**: Copy, descriptions, promotional content
|
22
|
+
|
23
|
+
### [Analysis](analysis/index.md)
|
24
|
+
Data analysis and research prompts:
|
25
|
+
- **Data Analysis**: Statistical analysis and insights
|
26
|
+
- **Research**: Literature review and synthesis
|
27
|
+
- **Reports**: Structured analysis and recommendations
|
28
|
+
- **Comparison**: Competitive analysis and evaluation
|
29
|
+
- **Trends**: Pattern recognition and forecasting
|
30
|
+
|
31
|
+
### [Automation](automation/index.md)
|
32
|
+
System administration and automation prompts:
|
33
|
+
- **System Monitoring**: Health checks and diagnostics
|
34
|
+
- **Deployment**: Release and deployment workflows
|
35
|
+
- **Log Analysis**: System log interpretation
|
36
|
+
- **Maintenance**: Routine system maintenance tasks
|
37
|
+
- **Alerting**: Notification and response templates
|
38
|
+
|
39
|
+
### [Learning](learning/index.md)
|
40
|
+
Educational and knowledge acquisition prompts:
|
41
|
+
- **Concept Explanation**: Complex topic simplification
|
42
|
+
- **Tutorial Creation**: Step-by-step learning guides
|
43
|
+
- **Quiz Generation**: Assessment and evaluation tools
|
44
|
+
- **Research Assistance**: Academic and professional research
|
45
|
+
- **Skill Development**: Practice exercises and challenges
|
46
|
+
|
47
|
+
## Complexity Levels
|
48
|
+
|
49
|
+
### Basic
|
50
|
+
- Simple, single-purpose prompts
|
51
|
+
- Minimal configuration required
|
52
|
+
- Clear, straightforward outputs
|
53
|
+
- Great for learning AIA basics
|
54
|
+
|
55
|
+
### Intermediate
|
56
|
+
- Multi-step workflows
|
57
|
+
- Dynamic configuration
|
58
|
+
- Context-aware processing
|
59
|
+
- Suitable for regular use
|
60
|
+
|
61
|
+
### Advanced
|
62
|
+
- Complex multi-stage pipelines
|
63
|
+
- Extensive use of directives
|
64
|
+
- Tool and MCP integration
|
65
|
+
- Production-ready workflows
|
66
|
+
|
67
|
+
## Using These Examples
|
68
|
+
|
69
|
+
### 1. Copy to Your Prompts Directory
|
70
|
+
```bash
|
71
|
+
# Copy individual prompts
|
72
|
+
cp docs/examples/prompts/development/code_review.txt ~/.prompts/
|
73
|
+
|
74
|
+
# Copy entire categories
|
75
|
+
cp -r docs/examples/prompts/development/ ~/.prompts/
|
76
|
+
|
77
|
+
# Copy all examples
|
78
|
+
cp -r docs/examples/prompts/* ~/.prompts/
|
79
|
+
```
|
80
|
+
|
81
|
+
### 2. Customize for Your Needs
|
82
|
+
Each prompt includes customization sections:
|
83
|
+
- **Parameters**: Variables you can adjust
|
84
|
+
- **Configuration**: Settings to modify
|
85
|
+
- **Extensions**: How to add functionality
|
86
|
+
- **Variations**: Alternative approaches
|
87
|
+
|
88
|
+
### 3. Run Examples
|
89
|
+
```bash
|
90
|
+
# Basic usage
|
91
|
+
aia code_review my_file.py
|
92
|
+
|
93
|
+
# With customization
|
94
|
+
aia --model gpt-4 --temperature 0.3 code_review my_file.py
|
95
|
+
|
96
|
+
# In workflows
|
97
|
+
aia --pipeline "code_review,optimize,test" my_project/
|
98
|
+
```
|
99
|
+
|
100
|
+
## Featured Examples
|
101
|
+
|
102
|
+
### Code Review Prompt
|
103
|
+
**File**: `development/code_review.txt`
|
104
|
+
```markdown
|
105
|
+
//config model gpt-4
|
106
|
+
//config temperature 0.3
|
107
|
+
|
108
|
+
# Code Review Analysis
|
109
|
+
|
110
|
+
Review the following code for:
|
111
|
+
- **Bugs**: Logic errors, edge cases, potential crashes
|
112
|
+
- **Security**: Vulnerabilities, input validation, data exposure
|
113
|
+
- **Performance**: Efficiency, scalability, resource usage
|
114
|
+
- **Style**: Conventions, readability, maintainability
|
115
|
+
- **Best Practices**: Design patterns, industry standards
|
116
|
+
|
117
|
+
## Code to Review:
|
118
|
+
//include <%= file %>
|
119
|
+
|
120
|
+
## Review Format:
|
121
|
+
Provide your analysis in the following structure:
|
122
|
+
|
123
|
+
### Summary
|
124
|
+
Brief overall assessment and rating (1-10).
|
125
|
+
|
126
|
+
### Issues Found
|
127
|
+
List specific problems with severity levels:
|
128
|
+
- 🔴 **Critical**: Security vulnerabilities, crashes
|
129
|
+
- 🟠 **Major**: Performance issues, bugs
|
130
|
+
- 🟡 **Minor**: Style, minor improvements
|
131
|
+
|
132
|
+
### Recommendations
|
133
|
+
Concrete suggestions for improvement with code examples where applicable.
|
134
|
+
|
135
|
+
### Positive Aspects
|
136
|
+
Highlight what's done well in the code.
|
137
|
+
```
|
138
|
+
|
139
|
+
### Blog Post Generator
|
140
|
+
**File**: `writing/blog_post.txt`
|
141
|
+
```markdown
|
142
|
+
//config model gpt-4
|
143
|
+
//config temperature 1.0
|
144
|
+
//config max_tokens 3000
|
145
|
+
|
146
|
+
# Technical Blog Post Generator
|
147
|
+
|
148
|
+
Create an engaging, well-structured blog post about: **<%= topic %>**
|
149
|
+
|
150
|
+
## Requirements:
|
151
|
+
- **Target Audience**: <%= audience || "Software developers" %>
|
152
|
+
- **Word Count**: <%= word_count || "1000-1500 words" %>
|
153
|
+
- **Tone**: <%= tone || "Professional but approachable" %>
|
154
|
+
- **Include Code Examples**: <%= code_examples || "Yes" %>
|
155
|
+
|
156
|
+
## Context:
|
157
|
+
<% if context_file %>
|
158
|
+
//include <%= context_file %>
|
159
|
+
<% end %>
|
160
|
+
|
161
|
+
## Structure:
|
162
|
+
1. **Hook**: Engaging opening that grabs attention
|
163
|
+
2. **Introduction**: Problem statement and article overview
|
164
|
+
3. **Main Content**: 3-4 major sections with headers
|
165
|
+
4. **Code Examples**: Practical, runnable code samples
|
166
|
+
5. **Best Practices**: Key takeaways and recommendations
|
167
|
+
6. **Conclusion**: Summary and call-to-action
|
168
|
+
|
169
|
+
## Style Guidelines:
|
170
|
+
- Use clear, concise language
|
171
|
+
- Include practical examples
|
172
|
+
- Add subheadings for readability
|
173
|
+
- Include relevant links and resources
|
174
|
+
- End with actionable next steps
|
175
|
+
|
176
|
+
Please ensure the post is SEO-friendly with good header structure and includes relevant keywords naturally.
|
177
|
+
```
|
178
|
+
|
179
|
+
### Data Analysis Workflow
|
180
|
+
**File**: `analysis/data_pipeline.txt`
|
181
|
+
```markdown
|
182
|
+
//config model claude-3-sonnet
|
183
|
+
//config temperature 0.2
|
184
|
+
|
185
|
+
# Data Analysis Pipeline
|
186
|
+
|
187
|
+
Analyze the provided dataset and generate comprehensive insights.
|
188
|
+
|
189
|
+
## Dataset Information:
|
190
|
+
//shell head -5 <%= dataset_file %>
|
191
|
+
//shell wc -l <%= dataset_file %>
|
192
|
+
//shell file <%= dataset_file %>
|
193
|
+
|
194
|
+
## Analysis Steps:
|
195
|
+
|
196
|
+
### 1. Data Overview
|
197
|
+
- Examine data structure and types
|
198
|
+
- Identify columns and their meanings
|
199
|
+
- Note data quality issues
|
200
|
+
|
201
|
+
### 2. Descriptive Statistics
|
202
|
+
- Calculate summary statistics
|
203
|
+
- Identify distributions and outliers
|
204
|
+
- Examine correlations
|
205
|
+
|
206
|
+
### 3. Data Quality Assessment
|
207
|
+
- Missing values analysis
|
208
|
+
- Duplicate detection
|
209
|
+
- Inconsistency identification
|
210
|
+
|
211
|
+
### 4. Key Insights
|
212
|
+
- Significant patterns and trends
|
213
|
+
- Interesting correlations
|
214
|
+
- Anomalies or outliers
|
215
|
+
|
216
|
+
### 5. Recommendations
|
217
|
+
- Data cleaning suggestions
|
218
|
+
- Further analysis opportunities
|
219
|
+
- Actionable business insights
|
220
|
+
|
221
|
+
## Data Sample:
|
222
|
+
//include <%= dataset_file %>
|
223
|
+
|
224
|
+
Please provide a thorough analysis with specific findings and quantitative metrics where possible.
|
225
|
+
```
|
226
|
+
|
227
|
+
## Prompt Design Patterns
|
228
|
+
|
229
|
+
### Parameterization Pattern
|
230
|
+
Make prompts reusable with variables:
|
231
|
+
```markdown
|
232
|
+
//config model <%= model || "gpt-4" %>
|
233
|
+
//config temperature <%= temperature || "0.7" %>
|
234
|
+
|
235
|
+
Task: <%= task_description %>
|
236
|
+
Context: <%= context || "General" %>
|
237
|
+
Output Format: <%= format || "Markdown" %>
|
238
|
+
```
|
239
|
+
|
240
|
+
### Conditional Inclusion Pattern
|
241
|
+
Include different content based on conditions:
|
242
|
+
```markdown
|
243
|
+
<% if File.exist?('production.yml') %>
|
244
|
+
//include production.yml
|
245
|
+
<% else %>
|
246
|
+
//include development.yml
|
247
|
+
<% end %>
|
248
|
+
|
249
|
+
<% if ENV['DETAILED_ANALYSIS'] == 'true' %>
|
250
|
+
Provide detailed technical analysis.
|
251
|
+
<% else %>
|
252
|
+
Provide summary analysis.
|
253
|
+
<% end %>
|
254
|
+
```
|
255
|
+
|
256
|
+
### Multi-Stage Pipeline Pattern
|
257
|
+
Chain related prompts together:
|
258
|
+
```markdown
|
259
|
+
//next data_cleaning
|
260
|
+
//pipeline analysis,visualization,reporting
|
261
|
+
|
262
|
+
Initial data processing completed.
|
263
|
+
Ready for next stage: <%= next_stage %>
|
264
|
+
```
|
265
|
+
|
266
|
+
### Tool Integration Pattern
|
267
|
+
Incorporate external tools:
|
268
|
+
```markdown
|
269
|
+
# Get a list of tools that are available
|
270
|
+
//tools
|
271
|
+
|
272
|
+
Using advanced analysis tools:
|
273
|
+
|
274
|
+
# Tell the LLM which tool to use and its arguments
|
275
|
+
use the examine_data tool to review this file '<%= data_file %>')
|
276
|
+
```
|
277
|
+
|
278
|
+
## Validation and Testing
|
279
|
+
|
280
|
+
### Testing Your Prompts
|
281
|
+
1. **Syntax Check**: Verify directive syntax
|
282
|
+
2. **Parameter Testing**: Test with different inputs
|
283
|
+
3. **Output Validation**: Ensure consistent, quality outputs
|
284
|
+
4. **Performance Testing**: Check response times and costs
|
285
|
+
5. **Edge Case Testing**: Handle unusual inputs gracefully
|
286
|
+
|
287
|
+
### Example Test Scripts
|
288
|
+
```bash
|
289
|
+
# Test basic functionality
|
290
|
+
aia --debug code_review test_file.py
|
291
|
+
|
292
|
+
# Test with different models
|
293
|
+
for model in gpt-3.5-turbo gpt-4 claude-3-sonnet; do
|
294
|
+
echo "Testing with $model"
|
295
|
+
aia --model $model code_review test_file.py
|
296
|
+
done
|
297
|
+
|
298
|
+
# Test parameter variations
|
299
|
+
aia code_review --file test1.py --severity high
|
300
|
+
aia code_review --file test2.py --severity low
|
301
|
+
```
|
302
|
+
|
303
|
+
## Best Practices
|
304
|
+
|
305
|
+
### Prompt Structure
|
306
|
+
1. **Clear Instructions**: Specific, actionable directions
|
307
|
+
2. **Context Setting**: Provide necessary background
|
308
|
+
3. **Output Format**: Specify desired response structure
|
309
|
+
4. **Examples**: Include sample inputs/outputs when helpful
|
310
|
+
5. **Error Handling**: Account for edge cases
|
311
|
+
|
312
|
+
### Configuration Management
|
313
|
+
1. **Model Selection**: Choose appropriate models for tasks
|
314
|
+
2. **Temperature Setting**: Adjust creativity vs. consistency
|
315
|
+
3. **Token Limits**: Balance completeness with cost
|
316
|
+
4. **Parameter Validation**: Ensure required inputs are provided
|
317
|
+
|
318
|
+
### Maintenance
|
319
|
+
1. **Version Control**: Track prompt changes
|
320
|
+
2. **Documentation**: Keep usage instructions current
|
321
|
+
3. **Performance Monitoring**: Track effectiveness over time
|
322
|
+
4. **User Feedback**: Incorporate user suggestions
|
323
|
+
|
324
|
+
## Related Documentation
|
325
|
+
|
326
|
+
- [Directives Reference](../../directives-reference.md) - All available directives
|
327
|
+
- [CLI Reference](../../cli-reference.md) - Command-line options
|
328
|
+
- [Advanced Prompting](../../advanced-prompting.md) - Expert techniques
|
329
|
+
- [Configuration](../../configuration.md) - Setup and customization
|
330
|
+
|
331
|
+
---
|
332
|
+
|
333
|
+
Explore the specific categories to find prompts that match your needs, or use these as inspiration to create your own custom prompts!
|
@@ -0,0 +1,127 @@
|
|
1
|
+
# Learning Prompts
|
2
|
+
|
3
|
+
Collection of prompts for educational content, skill development, and knowledge acquisition.
|
4
|
+
|
5
|
+
## Available Prompts
|
6
|
+
|
7
|
+
### Concept Explanation
|
8
|
+
- **explain_concept.txt** - Clear concept explanations
|
9
|
+
- **eli5_explainer.txt** - "Explain Like I'm 5" simplifications
|
10
|
+
- **technical_concepts.txt** - Technical concept breakdown
|
11
|
+
- **analogy_generator.txt** - Concept explanation through analogies
|
12
|
+
|
13
|
+
### Tutorial Creation
|
14
|
+
- **step_by_step.txt** - Step-by-step tutorial generation
|
15
|
+
- **hands_on_guide.txt** - Practical, hands-on learning guides
|
16
|
+
- **project_tutorial.txt** - Project-based learning tutorials
|
17
|
+
- **troubleshooting_guide.txt** - Problem-solving tutorials
|
18
|
+
|
19
|
+
### Skill Development
|
20
|
+
- **skill_assessment.txt** - Skill level assessment
|
21
|
+
- **learning_path.txt** - Personalized learning path creation
|
22
|
+
- **practice_exercises.txt** - Practice exercise generation
|
23
|
+
- **progress_tracking.txt** - Learning progress evaluation
|
24
|
+
|
25
|
+
### Knowledge Testing
|
26
|
+
- **quiz_generator.txt** - Quiz and test creation
|
27
|
+
- **flashcard_maker.txt** - Flashcard generation
|
28
|
+
- **assessment_rubric.txt** - Assessment criteria creation
|
29
|
+
- **knowledge_check.txt** - Knowledge verification questions
|
30
|
+
|
31
|
+
### Research and Study
|
32
|
+
- **study_guide.txt** - Study guide creation
|
33
|
+
- **research_methodology.txt** - Research approach guidance
|
34
|
+
- **note_organization.txt** - Note-taking and organization
|
35
|
+
- **summary_extraction.txt** - Key point summarization
|
36
|
+
|
37
|
+
## Usage Examples
|
38
|
+
|
39
|
+
```bash
|
40
|
+
# Explain complex concepts simply
|
41
|
+
aia explain_concept --topic "blockchain" --level "beginner"
|
42
|
+
|
43
|
+
# Create learning tutorial
|
44
|
+
aia step_by_step --subject "Python programming" --project "web scraper"
|
45
|
+
|
46
|
+
# Generate practice exercises
|
47
|
+
aia practice_exercises --skill "data analysis" --difficulty "intermediate"
|
48
|
+
```
|
49
|
+
|
50
|
+
## Learning Workflows
|
51
|
+
|
52
|
+
### Concept Mastery
|
53
|
+
1. **concept_introduction.txt** - Introduce new concept
|
54
|
+
2. **detailed_explanation.txt** - Provide detailed explanation
|
55
|
+
3. **practical_examples.txt** - Show real-world examples
|
56
|
+
4. **practice_problems.txt** - Generate practice problems
|
57
|
+
5. **concept_assessment.txt** - Assess understanding
|
58
|
+
|
59
|
+
### Skill Development
|
60
|
+
1. **skill_assessment.txt** - Assess current skill level
|
61
|
+
2. **gap_analysis.txt** - Identify skill gaps
|
62
|
+
3. **learning_plan.txt** - Create development plan
|
63
|
+
4. **resource_recommendation.txt** - Recommend learning resources
|
64
|
+
5. **progress_milestones.txt** - Set progress markers
|
65
|
+
|
66
|
+
### Project-Based Learning
|
67
|
+
1. **project_design.txt** - Design learning project
|
68
|
+
2. **requirement_breakdown.txt** - Break down requirements
|
69
|
+
3. **implementation_guide.txt** - Step-by-step implementation
|
70
|
+
4. **review_and_reflect.txt** - Review and reflection
|
71
|
+
5. **next_steps.txt** - Suggest next learning steps
|
72
|
+
|
73
|
+
## Educational Approaches
|
74
|
+
|
75
|
+
### Different Learning Styles
|
76
|
+
- **visual_learner.txt** - Visual learning approaches
|
77
|
+
- **auditory_learner.txt** - Audio-based explanations
|
78
|
+
- **kinesthetic_learner.txt** - Hands-on learning methods
|
79
|
+
- **reading_learner.txt** - Text-based learning materials
|
80
|
+
|
81
|
+
### Difficulty Levels
|
82
|
+
- **beginner_friendly.txt** - Beginner-level explanations
|
83
|
+
- **intermediate_depth.txt** - Intermediate complexity
|
84
|
+
- **advanced_topics.txt** - Advanced, detailed coverage
|
85
|
+
- **expert_discussion.txt** - Expert-level discourse
|
86
|
+
|
87
|
+
## Customization Parameters
|
88
|
+
|
89
|
+
- **Learning Level** - beginner, intermediate, advanced, expert
|
90
|
+
- **Learning Style** - visual, auditory, kinesthetic, reading
|
91
|
+
- **Subject Area** - specific domain or field
|
92
|
+
- **Time Constraint** - available time for learning
|
93
|
+
- **Goal Orientation** - certification, job skills, general knowledge
|
94
|
+
|
95
|
+
## Integration with Other Prompts
|
96
|
+
|
97
|
+
### Code Learning
|
98
|
+
```bash
|
99
|
+
# Combine with development prompts
|
100
|
+
aia explain_concept --topic "design patterns" | aia code_review --context -
|
101
|
+
```
|
102
|
+
|
103
|
+
### Research Learning
|
104
|
+
```bash
|
105
|
+
# Combine with analysis prompts
|
106
|
+
aia research_methodology --topic "market analysis" | aia competitive_analysis --method -
|
107
|
+
```
|
108
|
+
|
109
|
+
## Assessment and Feedback
|
110
|
+
|
111
|
+
### Self-Assessment Tools
|
112
|
+
- **knowledge_self_check.txt** - Self-assessment questions
|
113
|
+
- **skill_reflection.txt** - Skill reflection prompts
|
114
|
+
- **learning_journal.txt** - Learning journal templates
|
115
|
+
- **goal_evaluation.txt** - Goal achievement assessment
|
116
|
+
|
117
|
+
### Peer Learning
|
118
|
+
- **discussion_questions.txt** - Generate discussion topics
|
119
|
+
- **peer_review.txt** - Peer review frameworks
|
120
|
+
- **group_project.txt** - Collaborative learning projects
|
121
|
+
- **knowledge_sharing.txt** - Knowledge sharing formats
|
122
|
+
|
123
|
+
## Related
|
124
|
+
|
125
|
+
- [Writing Prompts](../writing/index.md) - Educational content creation
|
126
|
+
- [Analysis Prompts](../analysis/index.md) - Learning analytics
|
127
|
+
- [Development Prompts](../development/index.md) - Technical skill development
|
@@ -0,0 +1,62 @@
|
|
1
|
+
# Writing Prompts
|
2
|
+
|
3
|
+
Collection of prompts for content creation and writing tasks.
|
4
|
+
|
5
|
+
## Available Prompts
|
6
|
+
|
7
|
+
### Technical Writing
|
8
|
+
- **technical_docs.txt** - Technical documentation creation
|
9
|
+
- **api_documentation.txt** - API documentation writing
|
10
|
+
- **user_guides.txt** - User guide creation
|
11
|
+
- **tutorial_writer.txt** - Step-by-step tutorial generation
|
12
|
+
|
13
|
+
### Blog Posts
|
14
|
+
- **blog_post.txt** - General blog post creation
|
15
|
+
- **technical_blog.txt** - Technical blog posts
|
16
|
+
- **how_to_guide.txt** - How-to article creation
|
17
|
+
- **listicle_generator.txt** - List-based article creation
|
18
|
+
|
19
|
+
### Creative Writing
|
20
|
+
- **story_generator.txt** - Creative story writing
|
21
|
+
- **character_development.txt** - Character creation and development
|
22
|
+
- **dialogue_writer.txt** - Dialogue creation
|
23
|
+
- **scene_setting.txt** - Scene and setting description
|
24
|
+
|
25
|
+
### Business Writing
|
26
|
+
- **proposal_writer.txt** - Business proposal creation
|
27
|
+
- **report_generator.txt** - Business report writing
|
28
|
+
- **email_composer.txt** - Professional email composition
|
29
|
+
- **presentation_outline.txt** - Presentation structure creation
|
30
|
+
|
31
|
+
### Editing and Improvement
|
32
|
+
- **content_editor.txt** - Content editing and improvement
|
33
|
+
- **style_checker.txt** - Writing style analysis
|
34
|
+
- **grammar_check.txt** - Grammar and syntax review
|
35
|
+
- **readability_improver.txt** - Readability enhancement
|
36
|
+
|
37
|
+
## Usage Examples
|
38
|
+
|
39
|
+
```bash
|
40
|
+
# Create a technical blog post
|
41
|
+
aia technical_blog --topic "microservices" --audience "developers"
|
42
|
+
|
43
|
+
# Generate user documentation
|
44
|
+
aia user_guides --product "API" --level "beginner"
|
45
|
+
|
46
|
+
# Edit and improve existing content
|
47
|
+
aia content_editor --style "professional" existing_article.md
|
48
|
+
```
|
49
|
+
|
50
|
+
## Customization Options
|
51
|
+
|
52
|
+
- **Topic/Subject** - Specify the main topic
|
53
|
+
- **Audience** - Target audience level and type
|
54
|
+
- **Style** - Writing style (formal, casual, technical)
|
55
|
+
- **Length** - Desired word count or length
|
56
|
+
- **Format** - Output format (Markdown, HTML, plain text)
|
57
|
+
|
58
|
+
## Related
|
59
|
+
|
60
|
+
- [Development Prompts](../development/index.md) - Code-related writing
|
61
|
+
- [Analysis Prompts](../analysis/index.md) - Analytical writing
|
62
|
+
- [Learning Prompts](../learning/index.md) - Educational content
|