How to use KiteDocs

In this short article, we review the main steps someone needs to take to create a really good, searchable, comprehensive, and what is the most important, the useful documentation.

Before you start typing your first's documentation page, let's see which elements it consists of:

  • Documentation structure (the tree of pages, folders, groups)
  • Content (text and illustrations)
  • Technical implementation (hosting).

Those elements look pretty simple, especially the first two, but the whole process still requires real ideation, thinking through, and some planning. Not that changing the doc's structure is hard, but if you plan, it's much easier to create good documentation covering all the aspects of your produces/services that will not only be useful and helpful for your users, but also make it easier for search engines to find your product, index your data, and suggest it on the search results page or in an AI request.

Let's now look at the actions you need to complete to provide your users with good documentation and get as many benefits for your company or organization as you can.

  • Create the documentation structure (sections, folders, groups, pages)
  • Write text for every page
  • Select an icon for every page (or do not)
  • Select a good slug
  • Provide a title and subheading
  • Provide SEO meta tags
  • Test your documentation
  • Publish it
  • Decide on how you will host it (on the kitedocs domain, on your subdomain, or in your folder)
  • Configure your server
  • Configure your domain's settings at your domain provider
  • Provide the link to your documentation on your website and other resources (like a newsletter).

This may sound overwhelming, but please stay with us because we are going to show you shortcuts to all these goals. But before we do that, let's also review the process of creating just one page for your documentation. What you need to do are:

  • Think out title and subtitle of the page
  • Think out the structure of the page content
  • Write text, splitting it into readable chunks/sections/paragraphs
  • Prepare illustrations (take screenshots, or insert pics from the disk, or provide links) and insert them
  • Provide links to the other pages or outer resources
  • Select an icon and slug.

It's a lot, isn't it? Even in our AI era, writing good, meaningful content is still challenge. We saw tons of content that could work somehow for SEO, but was weak for humans, create noise and worsen the trustworthness of the company and product due to this surface effort.

What we suggest is a simple, effective system and easy-to-use product (yes, it's KiteDocs) that will help with completion all these tasks.

  • Our drag-and-drop UI for creating a documentation structure of ANY (absolutely any) complexity
  • WYSIWYG (What You See Is What You Get) editor for writing the content
  • Easy inserting images (from clipboard, upload as a file, or just insert the link)
  • Automatic SEO (will work even if you don't provide any values)
  • Full guides on configuring your servers for hosting the documentation in the way most suitable for you.
  • And many other things!

It's really that easy to use as it sounds, but it's still a good idea to get familiar with all those features and possibilities, so we created a short roadmap on any stage and thing you need to know about (the full road map is actually the documentation tree itself):