Prompt engineering tips

In Document360, Eddy AI works best when you give it clear, focused instructions. This guide covers practical techniques for writing better prompts, whether you are creating content, asking questions, or building out a knowledge base for your team or customers.

Writing Better Prompts

The following tips apply whenever you ask Eddy AI to generate or summarize content.

1. Be specific

Vague instructions produce vague results. State exactly what you need, including length, tone, and focus. Example: "Generate a 100-word summary about the benefits of Document360's knowledge base."

2. Request step-by-step format for procedures

When you need instructions or how-to content, tell Eddy AI to list steps and include where to click. Example: "List the steps to publish an article in Document360, including where to click and how to configure settings." instead of just saying "Explain how to publish an article."

3. Frame prompts for comparisons

If you need a comparison, say explicitly so Eddy AI structures the output as a side-by-side or contrast. Example: "Compare the key differences between Document360's private and public knowledge base setups."

4. Target specific sections when summarizing

For long articles, point Eddy AI to the exact section you want summarized rather than asking for a general summary. Example: "Summarize the benefits and limitations section of the article on Document360's multi-language support."

5. Add context for recommendations

Include who the content is for and what problem it solves. Context helps Eddy AI give relevant suggestions. Example: "Recommend improvements to the onboarding process in a knowledge base article for new users."

6. Break complex requests into smaller tasks

If your topic is technical or wide-ranging, split it into multiple focused prompts. This keeps outputs precise and usable.

Tips for Readers Using Eddy AI

These tips are for people searching or asking questions in the knowledge base through Eddy AI.

1. Converse naturally

Talk to Eddy AI the way you would talk to a human. Full sentences work better than keyword searches.

• Instead of: "Search for articles on templates"
• Try: "Eddy AI, find me articles explaining Document360 templates."

2. Provide context

Include background in your question. The more Eddy AI knows about your situation, the more relevant the answer.

• Instead of: "Errors in the documentation"
• Try: "Eddy AI, help me identify and resolve errors in the Document360 user guide."

3. Assign a persona

Ask Eddy AI to respond as a specific type of expert when that helps frame the answer.

• Instead of: "Search for software updates"
• Try: "Eddy AI, imagine you're our IT expert and update me on the latest software changes."

4. Experiment freely

Eddy AI responds well to creative or open-ended prompts. Try different angles if the first result is not quite right.

• Instead of: "Knowledge base structure"
• Try: "Eddy AI, imagine you're a content strategist and suggest an ideal knowledge base structure."

Question Prompting Best Practices

These rules apply when asking questions directly in Eddy AI's search or chat interface.

A. Ask complete questions, not just keywords

Write full questions instead of entering keyword fragments. Complete questions give Eddy AI the intent and context needed to return precise answers.

• Instead of keywords: "Website hosting pricing plans"
• Try asking complete question: "What are the pricing plans for website hosting services?"

B. Avoid broad or vague queries

Narrow your question to a specific situation or need. Specific questions produce targeted answers; broad ones often return generic results.

• Instead of general question: "Health insurance"
• Try asking specific question: "What health insurance plans are available for full-time employees?"

C. Use standard terminology

Use commonly accepted terms rather than informal or internal shorthand. Standard terms help Eddy AI match your question with the right content.

• Instead of non-standard terminology: "Specs of your top-of-the-line tech device"
• Try using standard terminology: "What are the specifications of the latest model of the tech device?"

Enhancing Knowledge Base Articles with Eddy AI

Use these prompts when building or maintaining content in your knowledge base.

Categorize content Ask Eddy AI to suggest categories for new articles to keep your knowledge base organized. Example: "Suggest categories for an article that discusses API integration and customization in Document360."

Document error messages Eddy AI can draft explanations for error codes and troubleshooting steps, saving time on technical documentation. Example: "Generate explanations for common error messages users may encounter when integrating third-party tools in Document360."

Compile best practices Ask Eddy AI to pull together best practices for a topic and present them as a structured list. Example: "List best practices for writing comprehensive how-to articles for a knowledge base aimed at developers."

Create troubleshooting guides For troubleshooting sections, give Eddy AI the problem context so it generates step-by-step solutions. Example: "Create a troubleshooting guide for resolving common login issues in Document360."

Use Cases by Industry

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.

Learning Management Systems (LMS)

Course creation

• Generate outline: Ask Eddy AI to quickly draft a structured course plan with topics and subtopics. For example, "Create an outline for a beginner's course on cloud computing."
• Segment content: Break long-form content into smaller modules. For example, "Split this article on cybersecurity fundamentals into 5 lessons, each with a title and brief summary."
• Create quiz questions: Generate assessments for each module. For example, "Generate quiz questions for each module in a cloud computing course."
• Create FAQs: Build clarification points for specific modules. For example, "Create FAQs for the module on cloud security."

Learner engagement

• Adaptive follow-up: Recommend content based on learner progress. For example, "Suggest advanced articles for learners who have completed the beginner's cloud computing course."
• Revision guide: Create quick summaries for knowledge retention. For example, "Generate a revision guide summarizing the key points of the data privacy module."

Customer Support Knowledge Base

Creating troubleshooting guides

• Prompt Eddy AI with specific support scenarios. For example, "Generate a step-by-step troubleshooting guide for common login issues in an e-commerce platform."
• For error code documentation, try: "Create documentation explaining the causes and fixes for error code 403 in web hosting."

Organizing FAQs for support agents

• Generate FAQs from common customer interactions. For example, "Create a list of FAQs for common billing issues faced by customers on our platform."
• Keep FAQs current by updating them with new data. For example, "Update our current FAQ section with recent questions about product integration."

Compliance Documentation

Generating compliance checklists

• Ask Eddy AI to build checklists based on industry standards. For example, "Generate a checklist of mandatory compliance requirements for healthcare data privacy regulations (HIPAA)."
• Keep checklists up to date with prompt 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. For example, "Draft a Standard Operating Procedure for handling customer data in compliance with GDPR."

Software and Tech Companies

API documentation

• Generate usage examples and integration instructions. For example, "Generate step-by-step instructions on how to integrate our API with third-party services."
• Keep docs current after releases. For example, "Update the API documentation to reflect the changes in the latest version."

Release notes and feature documentation

• Summarize new releases clearly and concisely. For example, "Generate release notes for version 4.2 of our software, highlighting the new features and bug fixes."
• Create guides for newly shipped features. For example, "Create a user guide for the new reporting dashboard feature in our SaaS platform."

Retail and E-Commerce

Product documentation

• Generate product guides that cover setup, usage, and troubleshooting. For example, "Create a product guide for a smart home security system, covering setup, troubleshooting, and usage tips."
• Create comparison content to help customers decide. For example, "Compare the features of three smart home security systems available on our platform."

Order and return procedures

Simplify customer-facing processes with clear step-by-step content. For example, "Generate step-by-step instructions for returning a product purchased on our e-commerce site."

FAQ