Example Guide

Guides are a way of instructing your users to perform (complicated) tasks, without overwhelming them. They should be short, and only contain the information that is absolutely necessary.

Why Keep Guides Short?

Users often come to guides when they’re stuck or need quick instructions. A concise guide:

1. Saves time for the user.
2. Ensures clarity by avoiding unnecessary details.
3. Reduces frustration and increases user satisfaction.

Best Practices for Writing Guides

Focus on a Single Task

Each guide should tackle one task or problem. For example: "How to Set Up Payments" or "How to Install the API Plugin."

Use Clear Steps

Break the process into simple, numbered steps. For instance:

### Steps to Set Up Payments
1. Go to **Settings > Payments** in your dashboard.  
2. Select your preferred payment gateway (e.g., PayPal, Stripe).  
3. Follow the on-screen instructions to link your account. 
4. Save your settings.   

Note: You don't have to use code-blocks, you can also utilize inline code.

Add Visuals Where Necessary

Include images, GIFs, or videos to illustrate complex steps.

Example: A screenshot showing where to find the "API Key" field in the dashboard.

Test Your Instructions

Before publishing, follow the guide yourself to ensure every step is accurate and clear.

What to Avoid in Guides

• Overloading users with unnecessary background information.
• Long-winded explanations or technical jargon.
• Assuming users know too much. Always guide as if they’re new to the system.

A Quick Example

Title: How to Install the Plugin

Content:

### Step 1: Download the Plugin  
Log in to your account and navigate to the **Downloads** section.

### Step 2: Upload to Your Server    
1. Access your server files via FTP or your hosting control panel.
2. Upload the plugin to the appropriate directory (e.g., `/plugins`). 

### Step 3: Restart Your Server 
Restart the server to load the plugin. You should see a confirmation message in the server logs.

Attachments:

• URL to resource 1

• URL to resource 2

Final Thoughts

Great guides empower users to solve problems independently. When in doubt, test your guide on someone unfamiliar with the task and refine it based on their feedback.

---

Let us know if you feel like something is missing from this guide!