Create Your First Knowledge Base Article
Creating helpful articles for our customers is a cornerstone of our success. With Solo, you can generate comprehensive, well-structured knowledge base articles in just a few steps. This guide will walk you through creating your first article from start to finish.
Step 1: Start a New Documentation Article
First, you'll need to create a new space for your article.
Navigate to the Documentation section of the platform.
Click the Generate New Documentation button. A dialog box will appear.
Step 2: Provide a Topic and Instructions
This is where you tell Solo what your article should be about.
Topic: In the "Topic" field, enter a clear and concise title for your article. This will become the main heading of your new document.
Instructions: In the "Instructions" field, describe the content you want in the article. This is your chance to guide the content generation. The more detail you provide, the better the result will be.
Tips for Writing Great Instructions:
Define the Goal: Start by explaining the purpose of the article. For example, "Explain how to reset a user's password."
Outline Sections: Suggest specific sections or headers you'd like to see. For example, "Include a section for 'Step-by-Step Instructions' and another for 'Common Issues'."
Specify the Tone: Describe the desired tone of voice. Should it be formal, friendly, technical, or simple?
Include Key Details: List any essential points or information that must be included in the article.
Click Create. This will take you to a new page dedicated to your article.
Step 3: Generate the Article Content
Now that your article page is created, it's time to generate the content.
On your new article page, you will see the topic and instructions you provided.
Click the Generate Documentation button.
Solo will begin writing your article. You will see the text appear on the page as it's being generated.
Step 4: Review and Publish
Once the generation is complete, you can review the content.
Not quite right? If the article isn't what you expected, you can click Regenerate. Consider updating your instructions with more specific details before regenerating.
Ready to use? If you're happy with the article, you have a couple of options:
Copy to Clipboard: Click this button to easily copy the formatted content and paste it into another application.
Publish: You can publish the article directly to connected platforms like Notion or Intercom. Clicking Publish will open a dialog where you can choose the destination.