tomehost User Guide

1. Overview

tomehost is a SaaS ("software as a service") designed to simplify the process of creating and maintaining technical manuals, user guides and other structured documentation.


Within our system, we call these documents 'tomes'.


Unlike traditional content management systems, data in a tome is structured in sections, which can be nested to any number of levels, rather than pages.


But the real power of tomehost is the way it lets you get users from a problem to a solution in a single click.


For web-based control panels and interfaces, we provide a simple way to embed popup help to just the right section of your user documentation within the page where a user is working.


For physical products such as machinery, we provide a simple way to generate QR codes that will pull up the specific section of your user documentation on a mobile phone or tablet when you point a camera at them.


Unlike PDF or Word documents, tomehost is responsive, and will reformat to different sized screens. It is far easier to edit and publish small changes, and to let multiple authors work on different sections at the same time.

2. Introduction

2.1. Platform

tomehost is software which runs on the web. This means it can be used by anyone with access to a modern web browser (Chrome, Edge, Firefox, Safari, IE 10+). It's responsive, which means that the page layout will reformat on smaller screens like mobile phones or tablets, to make it easier to use.


SaaS requires no special hardware, software, infrastructure or IT expertise - all of these are handled by the platform subscription.

2.2. Advantages over conventional documentation

Most organizations still deploy documentation in paper versions, or electronic files like Word documents or PDFs.

tomehost has a number of advantages over these more traditional methods:

  • up-to-date - user always sees the latest published information unlike paper or PDFs and Word docs, where users can retain old versions and may be unaware of updates

  • simplicity - the system takes care of the numbering and formatting, so users can concentrate on the content

  • speed - small edits can be made and published in seconds

  • multi-user - teams can work simultaneously from multiple locations, with source-control style permissions stopping users from overwriting each others' work

  • process - a variety of user-roles allows more formal processes to be put in place for publication, with some authors able to create and edit content, but not publish. Editors can be appointed to proof-read, revise and publish content.

  • usability - direct web links to any heading at any level, layout reformats for optimum usage on mobile and tablet devices

  • embedding content - we provide a simple way to embed help popup windows within your own web applications that target the specific section or subsection you want, saving users valuable time as they can pull up the information they need with a single click and stay within your web application or panel

For organizations that already put documentation online using a CMS (content management system) or templating systems, tomehost provides other benefits:

  • granularity and structure - the ability to nest content several levels deep and easily reorganize sections as the documentation develops

  • fixed URLs - pages accessed via links which remain constant even when headings are moved or renamed

  • embed help content into web back end - we provide simple tools to let you integrate tomehost content directly into your web admin panels via resizable, non-modal popups

  • no special markup - no HTML or wiki type notation is required, anyone who can write an email or use a word processor can create tomehost content

2.3. Cost

At present, tomehost is free. In future, we will add additional features which will be available under paid plans too, but will always retain a free, entry-level service. We will also provide paid plans for free to verifiable open-source projects. Contact us for details.

3. Registration

To create or contribute content to a tome, you must have a user account. You can sign up from tomehost for an account. Alternatively, if someone invites you to contribute to a tome, you will be sent a link that will allow you to create an account and join a tome.

Above: Registration requires the bare minimum information

3.1. Confirmations

You must confirm your account after registering by clicking on the link you'll receive by email. This is to ensure that your email address is correct, and belongs to you.

3.2. Password reset

Passwords in the database are salted and hashed, meaning that we have no way to recover your password if you forget it. However, there is a reset mechanism that will send and email with a temporary link that can be used to reset the password.

3.3. Email address changes

At present there is no mechanism to change the email address of an account. Since all emails are verified (to ensure you cannot sign up with a fake email address, or an address that does not belong to you), the procedure for this will require you to contact tomehost support to request a change.

4. Creating and Managing Tomes

powered by tomehost