Welcome to the

Technical Documentation Copy and Paste Kit.

Your building blocks for creating clear user assistance.

You are using:
Standard Edition, English, Version 2013
 
TRIAL VERSION  —  If you benefit from the information provided by this trial version, please be fair and buy the full version. Thank you!

 

(C) Copyright 2013 by indoition publishing e.K., all rights reserved

 

Expand /Collapse All Subsections

What the kit can do for you

Providing helpful user assistance isn’t as simple as it may seem:

If you’ve explained something thoroughly, this doesn’t mean that your information is useful.

If you’ve explained something accurately, this doesn’t mean that you’ve explained it adequately.

If your sentences are grammatically correct, this doesn’t mean that readers understand what you want to say.

The Technical Documentation Copy and Paste Kit helps you to create well-structured, clear content. The kit is your companion and style guide through all stages of a user assistance project.

Clear rules:
The kit gives you clear rules and unambiguous recommendations. No theory, no musings, no advanced grammar terms needed.

Practical examples:
For all major rules, the kit provides practical examples that you can easily remember and copy for your own work.

Timesaving working aids:
Various working aids and references help you to speed up your work.

What the kit can’t do for you

The rules given in the Technical Documentation Copy and Paste Kit are meant to provide you with helpful guidelines—not to be followed slavishly.

The kit can only provide general recommendations. It can’t provide any individual advice, and it can’t give you prefabricated texts that you only need to put together. However, the kit can help to make your process of creating user assistance more efficient, and it can help to vastly improve the quality of the outcome.

Important: The Technical Documentation Copy and Paste Kit can’t provide individual advice; in particular, it can’t provide any legal advice. Before shipping your products and before publishing any content, make sure that you also follow all relevant standards, laws, and other regulations that are applicable for both your own country and for all countries in which you sell your products. All rules that are given in these standards, laws, and other regulations take precedence over the recommendations given in the Technical Documentation Copy and Paste Kit.