From Strings to Strategy: Fostering Collaboration Between Dev and Docs
- Presentation
- Software Documentation
- 12. November
- 09:00 - 09:45 AM (CET)
- C5.1
-
Dr. Marie-Christine Gosselin
- Enclustra GmbH
Contents
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.
Takeaways
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.
Prior knowledge
Basic concepts of technical writing