Writing Support Documentation for AI Chatbots
Guide on How to Write Clear and Concise Support Documentation for AI Chatbots
This is a guide on how you can write clear and concise documentation in a way that is easily understood by Wonderchat
As an AI Chatbot Builder, Wonderchat can understand a wide range of writing styles and formats. However, there are certain best practices that can make documentation more understandable and accessible to an AI like Wonderchat.
We want to introduce you to some ways in which you can write better documentation for Wonderchat.
Best Practices for Text Documentation
1. Use Clear and Concise Language
Avoid using complex words or jargon that may be difficult for Wonderchat to understand. Use simple, direct language that conveys your message clearly.
2. Use Proper Formatting
Use headings, subheadings, bullet points, and other formatting techniques to organize your documentation and make it easier to navigate. This can help Wonderchat understand the structure and hierarchy of your content.
Include examples Including examples can help illustrate your points and make your documentation more concrete and understandable to Wonderchat. Use real-world scenarios to demonstrate how your product or service can be used.
3. Use Active Voice
Writing in active voice makes your documentation more engaging and easier to follow. It also helps to clarify who is responsible for performing certain actions.
Provide context when writing documentation: It's important to provide context to help Wonderchat understand the purpose and scope of your content. Explain what problem you are trying to solve and why your product or service is important.
4. Keep It Up to Date
Make sure your documentation is current and reflects any changes to your product or service. Outdated documentation can be confusing and misleading to Wonderchat and other users.
By following these best practices, you can create documentation that is clear, concise, and easily understood by Wonderchat and other readers.
5. Do Not Put Important Text in Your Images
Since Wonderchat only reads text based information, if your text is stored within an image our chatbots would not be able to understand the information.
Best Practices for Numerical Documentation:
There are some tips on how to present numerical documentation in a way that Wonderchat can understand:
1. Use Clear and Consistent Units
Make sure all numerical values are presented in clear and consistent units of measurement. This can help Wonderchat understand the scale and magnitude of the values being presented.
2. Explain the Significance of the Numbers
Simply presenting numerical data may not be enough for Wonderchat to understand the significance of the numbers. Provide context and explanation for the numbers presented to help Wonderchat understand their importance.
For instance, if you have an error code, it is best to present it as “Error 404” and explain it instead of putting a heading as “404”
3. Use Tables When Appropriate
Tables can be a useful way to present numerical data in a structured and organized format. Use tables to present data with multiple variables or categories.
By following these tips, you can help ensure that numerical documentation is presented in a way that Wonderchat can easily understand and process.
If you have any more questions, feel free to reach out to us at support@wonderchat.io
Last updated