about summary refs log tree commit diff stats
path: root/bash/talk-to-computer/corpus_prompt_template.md
diff options
context:
space:
mode:
Diffstat (limited to 'bash/talk-to-computer/corpus_prompt_template.md')
-rw-r--r--bash/talk-to-computer/corpus_prompt_template.md125
1 files changed, 125 insertions, 0 deletions
diff --git a/bash/talk-to-computer/corpus_prompt_template.md b/bash/talk-to-computer/corpus_prompt_template.md
new file mode 100644
index 0000000..f4bb91e
--- /dev/null
+++ b/bash/talk-to-computer/corpus_prompt_template.md
@@ -0,0 +1,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
\ No newline at end of file