Agnès Carchereux, Marion Groix, Amandine Kempf, Harriet Logan, Camille Pépin
As apprentices in the software, hardware and embedded systems industries, we wondered whether the type of product had an impact on documentation. After collecting the existing literature on the subject, we sent a questionnaire to technical writers with hands-on experience in order to learn more about their methods and skills. Their answers on the subject underlined that having direct access to the product is essential, but that the methods and skills are different depending on the type of product documented. Indeed, for security reasons, hardware industry documents contain more legal requirements than software documents and have a different documentation structure. The type of deliverables and whether the product is published online or in hardcopy depend on how the product is used on site. Terminology and syntax, the illustration workload, and project management methods are also discussed in this article.
Read the full article (PDF): Hardware or software products: What impact on technical documentation?