Technical writing w teorii i praktyce - analiza instrukcji obsługi firmy Motorola Solutions

Niniejsza praca magisterska ma na celu zaprezentowanie teoretycznych podstaw komunikacji techniczej i technical writing (dziedzina dotycząca pisania tekstów technicznych) oraz praktycznych wytycznych na temat tworzenia dokumentów technicznych, ze szczególnym naciskiem na model danych DITA (the Darwin Information Typing Architecture) i zasady efektywnego pisania stosowane przez technical writerów firmy Motorola Solutions w odniesieniu do instrukcji obsługi. Na podstawie literatury przedmiotu przedstawiono pojęcie i cechy komunikacji technicznej wraz z opisem poszczególnych typów dokumentów technicznych. W pracy zaprezentowano również standardy technical writing wprowadzone przez IBM, skupiając się przede wszystkim na modelu danych DITA przeznaczonym do tworzenia i publikowania treści technicznych. Następnie zasady efektywnego pisania obowiązujące w firmie Motorola Solutions zostały szczegółowo przedstawione. Ostatnia część pracy obejmuje analizę przykładowych instrukcji obsługi powstałych w firmie Motorola Solutions w celu sprawdzenia jak standardy technical writing są realizowane w praktyce.

This master thesis aims at presentation of the theoretical basics of technical communication and technical writing as well as practical guidelines on writing technical documentation, with special emphasis being placed on the Darwin Information Typing Architecture (DITA) and principles of effective writing observed by technical writers of Motorola Solutions with regard to user manuals. The concept and features of technical communication as well as types of technical documents have been broadly described on the basis of the literature of the subject. The thesis also presents standards of technical writing established by IBM with special attention being paid to DITA data model for creating and publishing technical content. Next a comprehensive account of Motorola Solutions’ principles of effective writing is provided. The thesis ends up with the analysis of sample user manuals created by Motorola Solutions’ technical writers in order to verify how technical writing standards are realised in practice.