Gathering information
The technical writer collects information from various sources, both internal and external to the company.
Once the technical writing project has been clearly defined, the technical writer gathers all available information:
- Product specifications, Intranet, Jira issues,
- Interviews with the R&D department,
- Product handling,
- Interviews with the marketing department,
- Customer interviews,
- Observing users in their real working environment,
- Competitor analysis,
- Reading trade publications.
Information Gathering
Information must be cross-checked to minimize the risk of transmitting incorrect or outdated information. The technical writer must perform diligent investigative work. By putting themselves in the user’s shoes, they check each piece of information and differentiate relevant data from noise that could disrupt the message.
As the first user of the solutions developed by the company, the technical writer takes on the role of Candide, Voltaire’s naive innocent who meets the world with fresh eyes, putting every aspect of the information into context. Testing products in conditions similar to those of users is an essential part of this process. For example, they may decide, against the advice of the technical department, to omit highly technical information from the user guide. Conversely, they may support a sales brochure with precise technical data to enhance the marketing pitch.