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.

Contact
  • Reaching out to your readers? Print!

    Despite the fact that laptops, tablets and smartphones are commonplace these days, a lot of users of your product(s) are still not on the World Wide Web. If this is the case with your audience, a printed manual still is a very good option. Looking for a printed manual? Or a series of simular manuals, each in multiple languages? We can help you.

    Read more
  • Examples of high-quality quick start guides

    Quick start guides are becoming more popular by the day. This statement somehow suggests that quick start guides are still in their infancy. This, in turn, may imply that there are not that many examples of high-quality quick start guides around. Both assumptions do not do justice to the current situation regarding QSGs. Yes, one can find some fine examples of high-quality quick start guides in the outside world. And yes, this implies that quick start guides already have a proven track record. This article focuses on two distinctive examples of high-quality quick start guides.

    Read more
  • Quick start guide

    The word β€˜quick start guide’ says it all: with a β€˜QSG’ a user should be able to operate his newly acquired product within – say – the blink of an eye. As such, a quick start guide takes away the worries about a steep learning curve. After all, a full-blown manual can scare people off, especially if it consists of tens of pages. Here lies the reason that a quick start guide – quite often not more than a folded card – is becoming more popular by the day.

    Read more
  • 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 more
  • Looking 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 more
  • Manual

    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 more
  • Content 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 more
  • Examples 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 more
  • Content 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 more
  • Translation 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 more

Would you like more information about our services?

We will be happy to help you.

Contact
This site is registered on wpml.org as a development site. Switch to a production site key to remove this banner.