Contents
Inconsistencies between the user interface (UI) of a product and its user documentation negatively impacts user experience. Previous studies have found that challenges for good UI strings and consistent user documentation are related to the lack of context, the lack of awareness, and the lack of internal processes. Those challenges are relevant to both the source content and the translated content.
This presentation shows examples of inconsistencies between the UI and the user documentation of a product, as well as the results of interviews with three experienced technical writers. The findings of this work are used to formulate recommendations for teams to work as efficiently as possible with UI strings and user documentation. The recommendations are related to planning, string keys, terminology, review, translation, processes, and awareness.
Takeaways
Based on a literature review, practical examples, and interviews, recommendations are formulated to help teams working as efficiently as possible with UI strings and user documentation.
Prior knowledge
Basic concepts of technical writing: terminology, translation memory, content management system.