TECHNICAL

WRITING

Outsource your documentation to professional writers


Companies generate information in large amount and in various forms such as:

organizational notes

operating manuals

procedures

reports

However, the targeted audience is not always a subject matter expert, which can be a barrier to understand the information. Besides, producing documentation can be time consuming which will prevent your expert from dedicating to his or her core business.

What is technical writing?

A technical writer (level bachelor’s degree to master’s degree) relies on the existing documentation base in the company in order to enhance the value of the information and make it understandable to a wider audience. On more technical subjects, a technical writer can also work in collaboration with an expert.

Finally, technical writing can also be used to design visual aids (e.g. a diagram in exploded view in a maintenance manual): using a graphical element often makes it easier to explain a procedure.

Finally, technical writing can also be used to design visual aids (e.g. a diagram in exploded view in a maintenance manual): using a graphical element often makes it easier to explain a procedure.

Who is it for?

The technical writing is for companies from different sectors such as:

Aeronautics

Automotive

Railway

Information Technology

In these sectors, without a good prior technical command, the end user may struggle to understand the information in the technical documentation (whether it is a user manual or a maintenance manual).

Towards simplified document management ?

By aiming to produce quality and comprehensible content, a technical writer will help updating documents and their distribution on different media.

To do so, simplified document management relies on two key components:

 

  • Structured writing and XML tags make writing in a modular way possible (in accordance with the S1000D and DITA standards). When the content is updated, only the concerned block of information will be modified (e.g. when the supplier decides to modify a spare part reference) without altering the rest of the document

 

  • Content editing and management software (e.g. Arbortext, Author-it, Calenco, Oxygen XML) associated with a version management system (i.e. single-sourcing)

A few figures

For one of our clients, we wrote a 60-page catalogue from 28 documents, with the help of an expert.

Without the help of a technical writer

The expert estimated that he would have spent 40 days writing the document.

With the help of a technical writer

The same expert has eventually been called upon only 8 days over 3 months.

With the help of a technical writer

The same expert has eventually been called upon only 8 days over 3 months.

Entrusting a technical writer with the documentation has actually saved 15%  on the company budget.

Achievements

For further details, have a look at "Our achievements”.