Technical Communication

Writing & technical communication

Communication technique - supports et contenus adaptés

Technical communication accompanies the product throughout its life. It is made up of different media in different formats: training courses, technical data sheets, manuals, instructions or marketing support.

The objective of technical communication is to highlight the relevance of a product in relation to the needs of its customers. To do this, it uses different media, depending on the level of expertise of the person to whom it is addressed and whether or not they belong to the company (prospects, customers, employees, trainers, technicians).

The technical writer must tailor his message to each audience. They use all communication resources (written material, illustrations, films, animations). The technical writer constantly takes into account the marketing dimension in order to promote sales, because any communication medium must be a marketing tool.

Communicating simply

This principle is not specific to technical communication. It is a general engineering principle, which assumes that any man-made object is more reliable and easier to maintain and evolve if its complexity is deliberately reduced.

This is what has often led to the design of the most ergonomic products: fewer parts, cheaper, more reliable.

The tools and the writer

What has worked spectacularly for well-known brands can be applied with equal success to technical communication. Regardless of the format used, the technical writer can build an elegantly architected document, as well as a gas plant.

With DITA XML, the rules are relatively strict to keep the documentation simple and modular. FrameMaker imposes few safeguards and Word none. The skills of the technical writer are therefore, regardless of the tool used, at the forefront to ensure that the content remains maintainable and explicit.

The same goes for interfaces, illustrations and animations.

Better understanding and simple explanation

Similarly, when formulating sentences, the technical writer should always keep in mind the principle of simplicity. It is easy to construct complicated sentences that indicate a lack of understanding of the topic rather than elaborate writing.

Constructing a simple sentence requires an effort to understand its subject. Writing the content and making it understandable to the recipient becomes easy. This is a fundamental aspect of the technical writer’s job. The technical writer thus brings real added value to the product he documents, to technical communication.

Documentation technique - les outils