From Strings to Strategy: Fostering Collaboration Between Dev and Docs

Fachvortrag
Softwaredokumentation

Dr. Marie-Christine Gosselin
- Enclustra GmbH

Inhalt

A complete and cohesive user experience is based on the same words being used in the UI as when documenting the UI. Collaboration between the software development team and the technical writing team is the key to achieving consistency between the UI and its documentation. The method presented here tackles challenges that arise when two teams with two sets of requirements are using a common asset: the collection of UI strings. In this presentation, the challenges are analyzed and flexible solutions are presented, including topics such as data exchange, timelines, and perspectives.

Finally, it will be shown how the UI strings in the CCMS can be leveraged to generate valid content that is easy to translate, both the text and the screenshots of the UI.

Das lernen Sie

General principles that can be applied to various teams in order to bridge the gap between the software development team and the technical writing team.

Vorkenntnisse

Basic concepts of technical writing

Referent:in

Dr. Marie-Christine Gosselin

Enclustra GmbH

Zum Profil

Biografie

Marie-Christine Gosselin has a strong scientific background: bachelor's and master's degrees in physics, and doctor's degree in engineering. After doing scientific research for several years, she worked in a technical software company. In 2018, she started her career as technical writer, where she quickly became a reference for her coworkers. In 2023, she graduated from the TCLoc master’s program from the University of Strasbourg. She is inspired to develop automated solutions to increase consistency and reduce maintenance efforts. She is also interested in terminology tools and processes.

zurück