When a company decides to industrialize technical documents, it immediately raises the issue of tools. However, instead of tools, this is the main format. Most publishers of writing apps, in order to force the sales market to pay regularly for product updates, have actually developed their own formats that only their software can change.
Therefore, the MS Word file or FrameMaker file can only be modified using the technical writing software of the same name. Therefore, the choice of this format risks limiting the subsequent choice of the company and is expensive: it requires one license per user, whether it be a technical writer, casual contributor or translator.
Technical writing is based on rational processes. Too often associated with a strong literary aspect, it is often abandoned by improvisation and the inspiration of a technical author. A technical writer, like other interested parties in a company, must fulfill his tasks in a predictable and reproducible manner. This process is based on a rigorous methodology and a robust production chain based on report writing software.
In order to create and improve high-value-added content for a company, a technical writer constantly maintains a dialogue not only with all the internal players of the company, but also with its ecosystem: partners, journalists, users, etc. Thus, it provides a different audience with the information they need. information. This strengthens the brand image of the company, improves customer satisfaction and facilitates the perception of the benefits created by potential customers. A technical writer relies on a production line as automated as possible. By introducing an industrial and reproducible process, it reduces production costs and provides a constant level of quality, adapted to the goals of the company.
Information should be double-checked in order to minimize the risk of transmitting incorrect or more relevant information. The technical writer must do the real investigative work. Putting himself in the place of the user, he checks each information and sorts the corresponding data and those that will only be noise that interferes with the message. As the first user of solutions developed by the company, the technical writer acts as a candidate who puts every aspect of the information transmitted into context. For example, he may decide, contrary to the advice of the technical manual, to ignore the very technical information in the user manual. Conversely, it can maintain a sales brochure with accurate technical details to support marketing discourse.
A technical writer can use content writing software. He asks the various stakeholders in the company, why he needs a product, for which he needs to create documentation and how it works, similar to someone who asks a blind man what an elephant looks like: for R&D, this is an elegantly written code for marketing, offers to position oneself in front of competitors in their market, for technical support, an executable file, whose errors must be fixed, etc.
In order to have a realistic vision of the object that he must describe, the technical writer must therefore understand it himself and form his own opinion, which he can then compare with the opinion of other business participants. A technical writer is a pragmatist who is interested in practice, not theory.
For example, if he consults only with developers, he will have little chance of creating satisfactory documentation for the user: – on the one hand, developers often have an idealistic vision of the functioning of their product, different from the behavior of the latter in real-world conditions of use, – on the other hand, loss information necessarily occurs between: – what the developer knows, – what the developer expresses, – what the technical writer understands, – what the technical writer writes, – what the gender understands user.
If a technical writer really checks the behavior of the product in conditions as close as possible to those faced by the user, the first three reasons for the loss of information are practically absent. To shorten the last two, it remains only to filter, organize and express the collected information in such a way that it is adapted to the carriers that transmit it and to the technical knowledge of the recipient. In fact, such a request may seem out of place at first glance and stumble upon the cumbersome setup of the test platform. As a rule, only after the first customer reviews or tests conducted in the press, various interlocutors fully understand the contribution of this approach.