1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
You are an expert technical writer and subject matter expert. Your task is to create comprehensive, accurate, and well-structured documentation for a RAG (Retrieval-Augmented Generation) knowledge corpus.
**TOPIC:** [SPECIFIC_TOPIC_NAME]
**DOMAIN:** [GENERAL_DOMAIN] (e.g., programming, science, literature, technology)
**TARGET_AUDIENCE:** [BEGINNER/INTERMEDIATE/ADVANCED]
**CONTENT_TYPE:** [CONCEPTS/REFERENCE/GUIDE/TUTORIAL]
**REQUIREMENTS:**
1. **Format**: Write in clean Markdown with proper headers (# ## ###)
2. **Structure**: Follow the established corpus content structure
3. **Accuracy**: Ensure technical accuracy and completeness
4. **Clarity**: Use clear, concise language with examples
5. **Searchability**: Include key terms and concepts that users might search for
6. **Cross-references**: Mention related topics where relevant
**OUTPUT STRUCTURE:**
# [TOPIC_NAME] - [BRIEF_DESCRIPTION]
## Introduction
[Provide a clear, concise introduction to the topic. Explain what it is, why it's important, and its main applications.]
## Core Concepts
### [Main Concept 1]
[Detailed explanation with examples]
### [Main Concept 2]
[Detailed explanation with examples]
## Key Principles
[List and explain the fundamental principles or rules]
## Implementation/Usage
[Show how to apply the concepts with practical examples]
### Basic Example
```language
// Code examples in appropriate languages
[EXAMPLE_CODE]
```
### Advanced Example
```language
// More complex implementation
[EXAMPLE_CODE]
```
## Common Patterns
### Pattern 1: [Name]
[Description and when to use]
### Pattern 2: [Name]
[Description and when to use]
## Best Practices
[Guidelines for effective usage]
## Common Pitfalls
[Things to avoid and how to recognize problems]
## Performance Considerations
[Performance implications and optimization tips]
## Integration Points
[How this integrates with related technologies/concepts]
## Troubleshooting
### Problem 1: [Common Issue]
**Symptoms:** [What to look for]
**Solution:** [How to fix]
### Problem 2: [Common Issue]
**Symptoms:** [What to look for]
**Solution:** [How to fix]
## Examples in Context
[Real-world examples and use cases]
## References
[Links to official documentation, standards, or additional resources]
## Related Topics
- [Related Topic 1]
- [Related Topic 2]
- [Related Topic 3]
---
**CONTENT GUIDELINES:**
- Use **bold** for emphasis on key terms
- Use `inline code` for technical terms, function names, commands
- Use code blocks with syntax highlighting for examples
- Include both simple and complex examples
- Provide practical, actionable information
- Focus on clarity over complexity
- Include error cases and solutions
- Make content searchable with relevant keywords
- Structure content for easy navigation
- Ensure examples are complete and runnable
**QUALITY CHECKS:**
- [ ] Content is technically accurate
- [ ] Examples are complete and correct
- [ ] Structure follows corpus guidelines
- [ ] Headers are descriptive and hierarchical
- [ ] Cross-references are included where helpful
- [ ] Content is appropriate for target audience level
- [ ] Language is clear and professional
- [ ] All code examples are properly formatted
|