Skip to main content

Best Practices

Follow these tips to ensure your Docsio site provides the best possible experience for your users.

Content Quality

  • Keep it Simple: Use clear, concise language. Avoid jargon where possible.
  • Use Visuals: Embed screenshots and diagrams to illustrate complex concepts.
  • Structure with Diataxis: Ensure you have a good mix of tutorials, how-to guides, and reference material.
  • Update Regularly: Use the AI Agent to keep your docs in sync with your latest product updates.

Design & Branding

  • Consistent Colors: Ensure your primary brand color is used intentionally for key actions and links.
  • Readable Typography: Choose font sizes and line heights that make long-form reading comfortable.
  • High-Quality Logo: Use an SVG or high-resolution PNG for your logo to ensure it looks sharp on all screens.
  • Logical Sidebar: Organize your pages into clear categories that make sense to a new user.
  • Searchable Titles: Use descriptive page titles that users are likely to search for.
  • Internal Linking: Link between related pages to help users discover more information.

User Support

  • Enable AI Chat: If you're on the Pro plan, enable the AI Chat Widget to provide instant answers to common questions.
  • Clear CTA: Ensure your documentation has a clear path back to your main product or support channel.
Docs by Docsio