How to write technical documentation
When writing technical documentation, please take at least three principles into account. But before applying these principles, it is important to know which legal requirements should be met in your manual.
Read moreLooking for an installation manual?
Why should one need an installation manual? After all, installing a pump or fence does not need that much explanation if the correct amount of nuts and bolts are part of the package. Why, then, bother about providing a separate installation manual? The prejudice that you don’t need an installation manual in any shape or form is persistent. But it is really foolish to leave an installation manual aside. The reason is clear. That reason is called: safety
Read moreManual
What makes a manual a good manual? There is a broad consensus on this. Agreed: It's true that there are as many writing styles as there are different tastes. But that does not alter the fact that a limited number of writing rules determine what is a good manual and what is not.
Read moreContent Management
Content management revolves around the creation, collection, management and publishing of information. A Content Management System (CMS) is a software system that computerises this process in an effective manner. In a content management system, content, design and structure are separated from one another; when the information has been collected/generated, a template dictates the design and the Content Management System can then publish the information in any preferred manner. Because content exists in its own right, it can be reused to serve different objectives. In this way, information can be handled efficiently while reducing costs.
Read moreExamples Manuals
Manuals present themselves in all kinds of shapes and sizes: quick start guides, installation manuals, help files in a software application, checklists, online e-learning webpages, instruction videos, augmented reality instructions, reference cards… Manualise can help you setting up any of these manuals – including user manuals of course. Let us give you some examples of the manuals we have set up so far.
Read moreContent management: promoting reuse right from the start
Content management stands for reuse of information. For example, you could decide to adapt the printed edition of your manual for use on the Internet. Manualise is using special content management software to fulfill all your wishes. As a matter of fact, we are reseller of MadCap software, the most advanced content management software around for technical writing. In short: we consider ourselves specialists when it comes to content management. Which also is a plus if you are looking for similar manuals in multiple languages
Read moreTranslation and localisation
When you are crossing borders, your manual will as well. But as your product barely needs adjusting, your manual could very well be put upside down. That’s because an easy to understand manual is, preferably, a manual in the local language. In most cases, translated manuals are mandatory in the European Union. This is because the EU wants to be sure that a user understands his manual without a hitch. This means using the mother tongue of the customer is the best way forward. Manualise is an expert in translation and localisation. We can translate multiple manuals in multiple languages in one go – if so desired.
Read moreSaving on translation costs
Do you have a diverse product portfolio with a regular flow of product introductions? Do these products need to be accompanied by manuals in a number of different languages? In that case, you would do well to collaborate with a professional translation agency that manages the different translators from a central office. Apart from the high quality that a translation agency can guarantee, as your translation partner they can also help you to keep the associated costs down. You can read about how they do this in this BLOG.
Read moreHow to make illustrations comprehensible?
Binnen de technische communicatie is het ontwerpen van illustraties een specialisatie op zichzelf. Een illustratie moet er niet alleen goed uitzien maar ook begrijpelijk en bruikbaar zijn. In dit blog een aantal vuistregels die u helpen bij het laten ontwerpen of het zelf ontwerpen van illustraties.
Read moreManualise: expert in technical illustrations
Technical illustrations can tell you more than a 1,000 words. As a bonus, illustrations do not need translation. This reduces your costs significantly, especially if you are planning to publish similar manuals in multiple languages. Besides, a user manual or maintenance manual is almost unthinkable without technical illustrations. Manualise is an expert in illustrating technical documents.
Read more
Articles about
Creating professional manuals
We are happy to share our expertise with you. About everything involved in creating a good manual – and managing it smartly.