In Document360, Eddy AI provides various AI-driven functionalities that help streamline content creation and enhance the overall knowledge base experience. Leveraging prompt engineering with Eddy AI can improve accuracy, efficiency, and relevance in generating content tailored to your needs. This guide will help you make the most of Eddy AI’s capabilities when interacting with your knowledge base.
Best practices for prompt engineering with Eddy AI
1. Be clear and specific in your prompts
When working with Eddy AI, the more precise your instructions, the better. For example, instead of asking for a “brief summary,” be specific about what you want, such as, “Generate a 100-word summary about the benefits of Document360’s knowledge base.”
If your content involves complex technical details, break it into smaller, more manageable requests. This helps Eddy AI deliver focused, relevant outputs.
2. Ask for step-by-step instructions
Eddy AI can be very effective in generating procedural content when you clearly specify the task. Instead of just saying, "Explain how to publish an article," a more refined prompt would be, "List the steps to publish an article in Document360, including where to click and how to configure settings."
3. Structure your prompts for comparisons
Structure your prompt accordingly if you need content that compares features or options. For example, “Compare the key differences between Document360’s private and public knowledge base setups” will guide Eddy AI to focus on generating a detailed comparison.
4. Focus on article summaries
When summarizing articles, especially longer ones, ask Eddy AI to create summaries based on specific sections or categories. For instance, “Summarize the benefits and limitations section of the article on Document360’s multi-language support.” This will help generate more concise and useful summaries.
5. Include context for recommendations
Context is critical when asking Eddy AI to generate recommendations or suggestions. For example, instead of saying, “Recommend improvements,” you could say, “Recommend improvements to the onboarding process in a knowledge base article for new users.”
Recommendations for optimizing your experience as a reader with Eddy AI
Converse naturally
Why: Speak to "Eddy AI" as you would to a human.
Example: Instead of "Search for articles on templates," try "Eddy AI, find me articles explaining Document360 templates."
Provide detailed context
Why: Enhance understanding by setting the stage and providing context.
Example: Instead of "Errors in the documentation," try "Eddy AI, help me identify and resolve errors in the Document360 user guide."
Customize persona
Why: Instruct "Eddy AI" to adopt a specific identity for personalized responses.
Example: Instead of "Search for software updates," try "Eddy AI, imagine you're our IT expert and update me on the latest software changes."
Embrace creativity
Why: Encourage experimentation and creativity in your queries.
Example: Instead of a standard search like "Knowledge base structure," try "Eddy AI, let's play! Imagine you're a content strategist and suggest an ideal knowledge base structure."
By following these recommendations, you harness the power of Eddy AI’s capabilities and make your interactions more engaging and tailored to your specific needs. Feel free to experiment, instruct Eddy AI creatively, and watch as your queries yield more insightful and personalized results.
Tips for enhancing knowledge base articles with Eddy AI
1. Use Eddy AI for content categorization
When organizing content, ask Eddy AI to help categorize or label articles. For example, “Suggest categories for an article that discusses API integration and customization in Document360.” This will help streamline your knowledge base’s structure.
2. Generate error message documentation
If your knowledge base deals with troubleshooting or technical content, you can ask Eddy AI to document common error messages. For example, “Generate explanations for common error messages users may encounter when integrating third-party tools in Document360.”
3. Request best practices
Eddy AI can also assist in compiling best practices. For instance, you can ask, “List best practices for writing comprehensive how-to articles for a knowledge base aimed at developers.”
4. Create troubleshooting guides
Suppose your knowledge base includes a troubleshooting section. In that case, you can instruct Eddy AI to generate content like, “Create a troubleshooting guide for resolving common login issues in Document360,” which ensures the AI focuses on step-by-step solutions.
Use cases
Eddy AI is a versatile tool that can streamline content creation across various industries, whether you’re building an LMS, maintaining a customer support knowledge base, or generating compliance documentation. By tailoring prompts to your specific needs, you can harness the full potential of Eddy AI to improve efficiency, accuracy, and engagement across your platform.
1. Building a Learning Management System (LMS) with Eddy AI
Course creation and structuring
Outline generation: You can use Eddy AI to quickly generate course outlines by specifying your learning objectives. For example, ask Eddy AI, “Create an outline for a beginner’s course on cloud computing,” and it will draft a structured plan with topics and subtopics.
Content segmentation: For educational materials, Eddy AI can divide long-form content into smaller, digestible modules. For instance, “Split this article on cybersecurity fundamentals into 5 lessons, each with a title and brief summary.”
Quiz and FAQ generation: Request, “Generate quiz questions for each module in a cloud computing course,” or “Create FAQs for the module on cloud security,” and Eddy AI will produce interactive learning assessments and clarification points.
Enhancing user engagement
Adaptive learning paths: Based on learner performance, you can ask Eddy AI to recommend follow-up content. For example, “Suggest advanced articles for learners who have completed the beginner’s cloud computing course.”
Knowledge retention aids: Eddy AI can help create summaries and quick revision guides. You might ask, “Generate a revision guide summarizing the key points of the data privacy module.”
2. Streamlining content for customer support knowledge base
In customer support, having a well-structured knowledge base is essential for quick and effective problem resolution. Eddy AI can assist by creating and organizing relevant content for customer support teams and self-service portals.
Creating troubleshooting guides
You can prompt Eddy AI with specific support cases like, “Generate a step-by-step troubleshooting guide for common login issues in an e-commerce platform.”
For technical support, ask for explanations on error messages. For example, “Create documentation explaining the causes and fixes for error code 403 in web hosting.”
Organizing FAQs for support agents
Use Eddy AI to generate frequently asked questions based on customer interactions. For example, “Create a list of FAQs for common billing issues faced by customers on our platform.”
It can also assist in updating existing FAQs by analyzing new data or customer queries. Ask, “Update our current FAQ section with recent questions about product integration.”
3. Accelerating compliance documentation in regulated industries
For industries like healthcare, finance, or manufacturing, maintaining up-to-date compliance documentation is crucial. Eddy AI can simplify the creation and maintenance of this content.
Generating compliance checklists
Ask Eddy AI to generate specific checklists based on industry standards. For instance, “Generate a checklist of mandatory compliance requirements for healthcare data privacy regulations (HIPAA).”
Compliance content often requires updates. Eddy AI can help with prompts like, “Update the checklist with the latest changes to GDPR regulations.”
Creating Standard Operating Procedures (SOPs)
In regulated environments, SOPs need to be clear and detailed. Eddy AI can assist in drafting these. You could ask, “Draft a Standard Operating Procedure for handling customer data in compliance with GDPR.”
4. Supporting product development documentation in tech companies
Maintaining up-to-date product documentation is key to smooth operations and customer satisfaction for software and tech companies. Eddy AI can help streamline the process.
API documentation
Ask Eddy AI to generate API usage examples or explanations. For example, “Generate a step-by-step guide on how to integrate our API with third-party services.”
It can also assist with documentation updates. You can request, “Update the API documentation to reflect the changes in the latest version.”
Release notes and feature documentation
With new product updates, use Eddy AI to create concise release notes. For instance, “Generate release notes for version 4.2 of our software, highlighting the new features and bug fixes.”
It can also help generate user guides for new features. For example, “Create a user guide for the new reporting dashboard feature in our SaaS platform.”
5. Automating knowledge base content for retail and E-commerce
In retail and e-commerce, a comprehensive knowledge base is critical for ensuring smooth customer support and product understanding. Eddy AI can help keep your content updated and relevant.
Product documentation
Use Eddy AI to automatically generate product guides. For instance, “Create a product guide for a smart home security system, covering setup, troubleshooting, and usage tips.”
It can also generate comparison content. Ask, “Compare the features of three smart home security systems available on our platform.”
Order and return procedures
Create customer-facing content that simplifies processes. For example, ask, “Generate a step-by-step guide for returning a product purchased on our e-commerce site.”
FAQs
How can I ensure Eddy AI gives me specific content?
Be as detailed as possible in your prompt. If you're asking for an explanation, specify the length, tone, and focus. For example, “Provide a formal, 200-word explanation of how to create custom categories in Document360.”
What should I do if the output is too broad?
Rephrase the prompt to narrow the focus. Break down the request into smaller steps, such as “Generate a summary of Document360’s version control feature,” followed by “List the key benefits of version control in a knowledge base system.”
Can Eddy AI assist with writing FAQs based on my content?
Yes, you can request FAQs based on specific sections or topics. For instance, ask, “Generate FAQs related to article categorization and tagging in Document360.”
How can I use Eddy AI to create technical content?
For technical content, make sure your prompts include relevant technical details. For example, “Generate a step-by-step guide for integrating Google Analytics with Document360’s knowledge base.”