Technical Documentation Starter Template

When creating a template for product documentation or IT documentation, you can make quite a few mistakes:

▶  You can spend many hours finding out how to tweak some special settings in Microsoft Word, OpenOffice, LibreOffice or another word processor.

▶  You can spend many hours trying to give your user manual or user guide a professional look.

▶  You might finally end up with a professional look (or with what you think that looks professional), but your visually appealing user manual or user guide may be hard to read.

▶  Your template may not work as efficiently as it could. You user manuals and user guides may still need some manual tweaking before publishing.

The professionally designed Technical Documentation Starter Template helps you to avoid these mistakes plus many more. The template is based on 25+ years of experience in technical writing and user manual template design. You can either use the Template out of the box as it is, or you can easily adapt it to match your corporate design.

The Technical Documentation Starter Template is fully compatible with Microsoft Word, OpenOffice, and LibreOffice. However, the template essentially also works with other text processors and authoring tools that can read files in .DOCX or .ODT format.
Clear, uncluttered design that helps readers focus on the content
The design of the user manual template is as simplistic as possible. Readers of a user guide are interested in finding quick answers to their questions. They are not interested in useless graphical gimmickry.

The template only uses graphical elements that serve a practical purpose, such as guiding the reader’s eye to the relevant content.
Design that supports skimming
Face the facts: Most readers won’t read your user guides from start to finish.

The design of the template helps readers to quickly skim your user manuals for just that little bit of information they need. Your clients will love your user manuals for this!
Styles that make orientation easy
For readers, losing orientation in your user guide is one of the worst things that could happen. Readers would not find the needed information, and readers would feel lost and frustrated.

The user manual template has been designed in a way so that readers can grasp the structure of your manuals easily at any time. Not only within the table of contents but also within the text.
Well-balanced amount of white space
Empty space on a page is not necessarily wasted space. Having the right amount of white space in the right places can help to guide the reader’s eye across your user manuals. Also white space can help to visually group things that belong together.

The user manual template uses white space wisely.
Just the right font and font size
You don’t have trouble reading text that uses a stylish font and a small font size? Lucky you! Many people have.

The user manual template uses fonts that are sufficiently big so that everybody can read the texts easily but yet sufficiently small to fit enough information onto each page.
Line-width that makes reading easy
If a line in a user manual has too many characters, this makes it difficult for the human eye to move from the end of the line to the beginning of the next line. This makes reading tiring and unnecessarily distracts from the content.

The user manual template uses a well-balanced line length that makes reading easy.
Semantic styles
The user manual template uses so-called semantic styles. This means that the styles don't have their names set according to what they look like but according to the styles’ meanings: the semantics.

Example: A style that you use for formatting the name of a button is not named “Arial10ptBold” but “button”. So, for instance, if one day you decide to change the style from Arial 10 Point Bold to Verdana 12 Point Blue Italic, you can do so without needing to create a new style and to reassign it throughout your documents. You just need to change the existing style’s appearance but not the style’s name.
User-friendly naming conventions
All paragraph styles and character styles set up in the user manual template are named in an intelligent way. In particular, they are named in a way so that related styles are automatically grouped together when you select a style from the style catalog in your word processor.

In the user manual template, the most frequently used styles have keyboard shortcuts assigned. The keyboard shortcuts use part of the naming scheme so that you can remember the keyboard shortcuts easily.
Automatic line breaks and page breaks
The user manual template uses as many layout automation mechanisms as possible. So you can fully focus on writing your user guides and don’t need to care about tweaking individual line beaks and page beaks.

Each style has the optimum settings that control whether a page break may interrupt the paragraph, whether a particular paragraph starts on a new page, whether a particular paragraph is always kept together with another paragraph on the same page, etc.
Prints nicely on both A4 and Letter paper size for global distribution
Documents formatted with the user manual template print well on both A4 and Letter paper. If you ship your user guides electronically (for example as a PDF file), you can do so world-wide without needing to supply different versions for different international markets.

In case you need a page size other than A4 or Letter, you can change the template easily.
Easily adaptable
The user manual template contains all elements that a user guide typically needs. You can use the template right out of the box as it is.

Yet you can easily customize the template at any time to give your user guides a unique look or to match your corporate identity requirements. Typically, adapting the existing styles only requires only some basic knowledge of Microsoft Word or your authoring tool.
Costs only €19 instead of hours of tedious work
The user manual Starter Template only costs a one-time license fee of €19. Compare this cost to the amount of time that you would need for setting up a similar template from scratch!

You can use the User Manual Starter Template to produce as many user manuals as you need without any additional charge.

Use the Technical Documentation Starter Template instead of wasting many hours setting up your own template.
Download the Template for only EUR 19,- here.

Best practices for designing your own user manual templates

Design for your audience

Don’t create a design that designers would like. Create a design that meets the needs of your audience.

  Who are your readers?

  Where and under what conditions will your readers read your user manuals?

Examples of
requirements resulting from the audience are:

  Elderly people need a larger font size and some larger line spacing than young people.

  Engineers in general prefer a more frugal design than consumers.

  Unskilled readers need bolder hints than university graduates.

Examples of
requirements resulting from where and how the audience reads your user manuals are:

  Users who read in a loud production hall need a larger font size and some more line space than users who are sitting in a quiet office.

  Users who read while sitting in a moving car, bus, train, plane, ship, or other vehicle need a larger font size and some more line space than users on solid ground.

  Users who read in bright sunlight need pages that don’t produce a glare.

  Users who read in rooms where lighting conditions are poor need some strong contrasts between paper and letters, and between different colors.

  Users who have to carry a printed manual with them may need a document with a small page size that fits into their pockets or into a special compartment attached to the product. For example, the user manual of a car should fit into the car’s glove compartment.

  Users who view an electronic user manual on a mobile device need a layout that takes up only little screen real estate.

Keep the design clear and simple

Less is more. Keep the design of your user manual template as plain and simple as possible. Don’t distract the reader. Create a design that helps the reader to retrieve and process the given information.

Avoid unnecessary variety

  Use only a small number of different colors in your user manuals. Use different colors only if they serve different purposes. Reserve bold colors for important things.

  Use only a small number of different fonts and font sizes. Use different fonts or font sizes only if they serve a particular purpose. Reserve bold, large type for important things and for headings.

  Try to get along with as few different styles as possible.

  Use the same styles consistently throughout the whole user manual.

  Use the same styles also for all other documents that relate to the same product: installation guides, getting started guides, user guides, operation manuals, reference manuals, maintenance manuals, etc.

  Always use identical positions when arranging objects. Align all objects on a common design grid.

Avoid redundancy

Omit every letter, symbol, line, or other object that doesn’t add any real value.

  Objects that convey some important or helpful information do add value.

  Objects that help readers to find or process information do add value.

  Objects that are just there to fill some empty space don’t add value.

For example:

  Don’t use background images.

  Don’t put your company logo on each page. It’s enough to have it on the title page.

  Don’t mention the author’s name on each page.

  Don’t put a copyright notice on each page.

  Don’t put a revision number or release date on each page.

  Don’t put the document title on each page.

  A running header or footer that shows the title of the current section, however, can be helpful because it keeps readers oriented.

Tip: Sometimes, the design guidelines of a company inevitably require having particular elements on each page, no matter whether this makes any sense. If, in a case like this, you can’t influence the design guidelines (you should try), at least keep these elements as unobtrusive as possible: make them small, don’t use color, make text light gray instead of black, place the elements where they draw little attention and clearly separate them from the true content.

Avoid clutter

Don’t overload the pages of your user manuals and user guides with too much information. Use white space purposefully to direct the readers’ attention, to group things that belong together, and to set reading pauses.

It’s no problem if an uncluttered layout makes your user guides a bit longer. If you provide valuable content, readers will accept the fact that they need to scroll or turn pages. However, they won’t accept user guides that overwhelm them.

Create styles semantically

Use style names that describe the meaning of a style, not its look. For example, call a style “Emphasis” rather than “Bold-Red.”

Semantic styles have some major advantages:

  The style name tells you when to use the style meaningfully.

  You can change the look of the style at any time without any negative side effects. Example: Imagine having designed a special style for formatting user interface elements. If you have named this style “element”, for instance, you can later simply change the font settings. If you want to change the font from Arial to Verdana or the size from 10pt to 12pt, you can do so and this is it. But what would you do if you had named your style “Arial-10pt-Bold”? This wouldn’t make much sense any longer …

  Semantic styles are a key prerequisite for structured authoring in XML and DITA. If you use semantic styles, your user manuals are well prepared in case you want to shift to structured authoring someday.

Use a well thought out naming convention

To make your user manual template writer-friendly, set up an effective naming convention for style names:

  Choose names that you can remember easily.

  Choose names in a way so that related styles are listed next to each other in the style catalog of your authoring tool. You can achieve this by beginning the names of related styles with the same prefix.

  For keyboard shortcuts, use keys that you can easily remember. Use the same scheme for all paragraph styles and another scheme for all character styles. For example, use Alt+Shift+letter for all paragraph styles, and use Ctrl+Shift+letter for all character styles.

When writing, avoid amateurish formatting techniques

Don’t use …

  empty paragraphs

  multiple space characters


  all sorts of local custom formatting

Only use the styles that are configured in your user manual template.

Problems with empty paragraphs

Don’t use empty paragraphs for adjusting the space above or the space below paragraphs. Instead, use appropriate paragraph settings.

Also, don’t use empty paragraphs for creating page breaks. If you later add or delete some lines from your user manual, everything will move to a wrong position. Instead, always use proper manual page breaks. Even better, when possible completely automate page breaks.

All sorts of empty paragraphs seriously interfere with automatic page breaks.

Problems with multiple space characters

Don’t use space characters for indenting text. Instead, always configure proper indentation settings as part of the paragraph properties. If you use space characters for indenting text, as soon as you change anything, all subsequent lines also need manual editing.

In online user manuals that use a variable column width, indents with space characters don’t work at all.

The only place where using space characters for formatting text within a user manual makes sense, is when quoting programming source code. When you copy and paste source code into a user manual, the source code is usually already indented with the help of space characters or tabs.

Problems with tabs

Avoid using the tab key. Tabs may get you into trouble if you want to produce an online version of your user guide because tabs don’t have any equivalent in HTML. Tabs then need to be converted into tables, space characters, or indents. This rarely works well.

Instead of using tabs, set up some proper paragraph indentation, or use a borderless table. Note that even if you don’t need to produce an online version of a user guide now, you may want to do so in the future.

Problems with local custom formatting

Don’t manually set paragraph settings and character settings for individual paragraphs. Always only use the paragraph styles and character styles that have been defined in your user manual template. If you overwrite a paragraph style for an individual paragraph or if you overwrite a character style for an individual word, this will get you into trouble when you need to change the design of your user manuals. This may seem unlikely today but often happens even if you don’t anticipate it.

If you have exclusively used template styles and want to change the design, all you need to do is to change the style definitions. If you’ve applied manual formatting, however, you will need to update all manual formatting by hand. This can result in many hours of extra work, particularly if you have multiple documents.
Do you want to save lots of time and avoid potential strategic mistakes?

The Technical Documentation Starter Template can help you.