Manuals and manual pages

📋 Table of contents

Creating your first manual page
Document builder
Creating and managing pages

Introducing manuals and pages

Manuals and manuals pages are the foundation of all documentation you will create at Inverifi, they give you the freedom to create a structure while being simple to use and understand. When describing manuals and pages to new users the comparison I use is books. A manual is like the hard back cover of a book, it will contain the title and summary of what’s inside. Then we have pages which are the meat and bones of the manual, this is where all your content will live and be created. It’s important to understand this comparison as you can not create a page on it’s own, a page needs to belong to a manual.

1.1) Creating your first manual and page

To start creating your first manual in Inverifi, you first need to:

Go to the documents page
In the bottom right corner, click the purple plus button (FAB)
Select manual
Select the organisation it belongs to
Enter a title and optionally a summary
Click save
You will now be met with the document builder, skip this for now there will be a section covering this later
You will now be on the create screen for a manual page
Enter a title for your page
Click “create”
To go to the manual overview screen, click the exit button in the top right

*Building a page is also completely optional if you only want to create the manual, just skip to step 11 when you get to step 8.

1.2) Document builder

Once you’ve created your manual you may have noticed the document builder pop up. This is a tool for quickly building out a manual and page structure, using a markdown language. A markdown language is used to format/ create content using plain text E.g Surrounding a word with an asterisk (*Bold*) in some editors will make the word bold.

Lets look at an example in Inverifi with how this works:

Using a hashtag will create a page E.g #Code of ethics will create a page called “Code of ethics”
- Using multiple hashtags will indent the page E.g ##Employee onboarding will create the page “Employee onboarding” and indent the page
- Pages can be only indented up to a third level, using three hashtags is the current limit
You can also use a dash, each dash represents what heading style the word will have E.g If I was to put —-Employee leave policy. This would create the heading “Employee leave policy” with a heading 4 style as I used 4 dashs (-).
- We offer up to heading 6 with our editor so 6 dash’s is the limit

Now lets take a look at a practical of how this would look inside the product:

As you can see from the image, using the markdown language I’ve said I want two pages to built with each page having it’s own heading. To make things easy to understand, the structure of how it will look is built out in real time in the contents section of the builder. Having this visual aid will let users get a preview of how he pages in their manual will be structured.

1.3) Creating and managing pages

While viewing your manual you’ll be able to add as many pages as you like. You can also change the order of the pages and indent the pages, this allows you to structure them as sub pages.

Adding pages

To add a page to your manual you must do the following:

Make sure you have the editor or manager role, viewers can not create pages
Click on the “Add page” button in the bottom right
This will open the create page
Like any other content type, add a title
Once happy you can click the “create” button

This will finalise the creation of your new page, you will be able to see this from the manual overview screen.

Re arranging your pages

Once you have built out some pages for your manual, you will be able to changes the order and indentation of pages. It works by simply dragging and dropping the pages into the position you’d like and if you want to make a sub page, you again just drag and drop the page onto the parent page.