Technical Writing Document Design

What is design?

The design stage is when decisions of how a project will look are taken.

In documentation, the design phase is about deciding the following:

The design stage must take into account the needs of the audience, in order to create something appropriate to their task.

Design Goals

When designing documentation, technical writers have five aims to keep constantly in mind. - these goals are best defined in Technical Communication by Merkel.

Documentation must look professional and create a positive image of the product and the company.

The documents must be easily navigable and follow a logical and reasonable order

Documentation is sharing knowledge, not hiding it, documents must be designed to make finding information easy.

Documents must communicate clearly and accurately.

Well designed documents make the information easy to remember by using visual prompts and elements.