Методичні вказівки до виконання практичної роботи.

Практична робота №1 з курсу:

«Основи технічного письма»

Автор: Мирослав Панчишин

Національний Університет «Львівська Політехніка»

Львів - 2023

2
1. ТЕОРЕТИЧНІ ВІДОМОСТІ

1.1 Що таке технічне письмо

Технічне письмо – це спосіб точної, структурованої та об'єктивної подачі
інформації, який застосовують спеціалісти технічних або наукових галузей.
Основною метою технічного письма є зрозуміла і ефективна передача інформації
без надлишкового тексту для надання кінцевому користувачу максимальної
цінності через текст.
Технічні комунікації — або технічне письмо, як часто називають курс — це не
написання текстів про конкретну технічну тему, таку як комп'ютери
(копірайтинг), а про будь-яку технічну тему. Термін «технічний» позначає знання,
які не мають широкого поширення, тобто охоплює територію фахівців і
фахівчинь. Якою б не була ваша спеціальність, ви розробляєте експертизу — ви
стаєте фахівцем у певній технічній галузі. І кожного разу, коли ви намагаєтеся
написати або сказати що-небудь про свою сферу, ви займаєтеся технічним
спілкуванням.
Спеціалістів, які виконують завдання в галузі технічного письма, називають
технічними авторами. Для того, щоб стати технічним автором потрібно засвоїти
не тільки технічні основи роботи з програмним забезпеченням, яке допомагає
зробити текст більш візуально сприйнятим, але й розуміти стилістичні
особливості мови, добре володіти граматичними структурами і на додачу
залучати логічне мислення. Технічний автор повинен вміти надавати тексту
змісту, щоб інструкції або пояснення технічних концепцій, комп’ютерних
програм або медичних процедур були легкими для сприйняття.
Попри те, що технічна комунікація має важливе значення в широкому
діапазоні областей і професій, технічне письмо також вже тривалий час відносять
до професійної сфери зі своїми програмами ступеня, сертифікатами, і - так! —
навіть з своєю теорією. Це широке поле з великим потенціалом зростання та
доходу, а вступний курс технічного письма - хороший спосіб розпочати кар'єру,
якщо ви зацікавлені в певній галузі або плануєте працювати там, де письмо є
складовою.

1.2 Короткий витяг з історії

Історія технічного письма налічує тисячоліття. Ще в античні часи інженери та
вчені використовували писемні документи для фіксації своїх винаходів та
відкриттів. Пам'ятними прикладами є рукописні інструкції для будівництва
складних споруд, таких як акведуки та амфітеатри в давньому Римі. В

3
середньовіччі також створювали документи, які містили інструкції щодо
будівництва мостів та фортець. Такі рукописи були важливим засобом
збереження знань та передачі їх наступним поколінням.
З появою друкарства та індустріальною революцією, технічне письмо стало
більш доступним і поширеним. Друковані матеріали та книги стали інструментом
для поширення знань та інформації, в тому числі і технічних даних.

1.3 Сфери застосування технічного письма

До найпоширеніших галузей, в яких застосовують технічне письмо,
відносяться:
- інженерія;
- програмне та апаратне забезпечення;
- робототехніка;
- хімія;
- фінанси;
- побутова електроніка;
- авіація та космічна галузь;
- медицина та охорона здоров'я;
- наука;
- біотехнологія.
Але що саме у цих галузях можна назвати технічним письмом? Все таки не весь
текст, який ми зустрічаємо в цих галузях можна вважати технічним письмом. Ось
кілька часто-вживаних прикладів документації, в яких використовується така
техніка:
- інструкції з експлуатації;
- технічні характеристики продукції;
- описи товарів;
- звіти;
- резюме;
- документація програмного забезпечення;
- посадові інструкції.
Технічний автор, зазвичай, пише для певної галузі, і в цьому випадку мова
адаптується до рівня освіти аудиторії. Однак іноді технічний автор пише для
широкої аудиторії. Багато деталей, про які розказують технічні автори, є
складними, тому процес написання включає аналіз інформації та представлення
її у спосіб, який буде легко зрозумілий всім, хто її читає, навіть тим, хто не має
великого досвіду роботи з цією темою.

4
 1.4 Споживачі технічного письма
Ще однією ключовою частиною визначення технічної комунікації є одержувач
інформації — цільова аудиторія. Технічна комунікація — це надання технічної
інформації читачам (або слухачам чи глядачам) таким чином, який адаптується
до їхніх потреб, рівня розуміння та знань.
Одним з перших завдань, які потрібно буде виконати при реалізації задання з
технічного письма - це визначити її тип (або типи – дуже рідко буває потреба
тільки в одному типі). Загальний поділ аудиторій на категорії виглядає наступним
чином:
 експерти - це люди, які знають поточну справу чи її організацію (і, можливо,
теорію та продукт) всередині та зовні. Вони спроектували його, протестували,
знають про нього все. Часто вони володіють топовими науковими ступенями
та працюють в академічних закладах або беруть участь в дослідженнях та
розробках уряду та технологічних агломерацій;
 технічні працівники - це люди, які створюють, експлуатують, обслуговують та
ремонтують предмети, про які говорять та теоретизують експерти. Вони також
володіють високотехнічними знаннями, але більш практичного характеру;
 керівники - це люди, які приймають ділові, економічні, адміністративні,
правові, урядові, політичні рішення щодо продуктів експертів та технічних
спеціалістів. Зазвичай, керівники мають такий же рівень технічних знань, як і
неспеціалісти. Для багатьох з вас це буде основна аудиторія;
 неспеціалісти - ці читачі мають найменше технічних знань серед усіх
аудиторій. Але вони хочуть використовувати новий продукт для виконання
своїх завдань; вони хочуть зрозуміти нову концепцію технології на
достатньому рівні, щоб знати, чи голосувати за чи проти неї на майбутньому
референдумі. Або ж вони можуть просто цікавитися конкретним технічним
питанням та хочуть дізнатися про це - але без конкретних, практичних причин.
Швидше за все, ці читачі будуть представляти вашу вторинну аудиторію.
Насправді орієнтація на аудиторію настільки важлива, що вона є однією із
наріжних каменів цього курсу: вам доведеться писати про технічні предмети, але
таким чином, щоб новачок — неспеціаліст — міг зрозуміти. Таке вміння
транслювати технічну інформацію неспеціалістам є ключовим навиком будь-
якого технічного комунікатора. У світі стрімкого технологічного розвитку багато
людей постійно відстають від прогресу, який відбувається навколо нас. А
технологічні компанії постійно намагаються знайти ефективні способи, щоб
допомогти клієнтам або потенційним клієнтам зрозуміти переваги чи розібратися
з експлуатацією своїх нових продуктів.

5
 1.5 Візуальне форматування та пояснення
Ще однією ключовою відмінністю, яка відрізняє технічну комунікацію від
академічного письма, є важливість візуального форматування та вміння
пояснити інформацію. Візуальне форматування і пояснення є основними
елементами оформлення технічної документації. Візуальне форматування,
наприклад, заголовки, підзаголовки або зміст - показує ієрархічну структуру
інформації та орієнтує читача в тексті. Пояснювальна або описова мова
забезпечує читачеві чітке розуміння теми обговорення. Цей тип мови може
включати конкретні деталі технічної інформації, а також інформацію про
призначення документа, як документ співвідноситься з потребами читача і які дії
очікуються від читача.
Візуальне форматування та пояснювальна мова роблять технічні документи
функціональними та зручними для навігації. Наприклад, якщо технічний звіт
деталізує фінансування різних відділів, керівник певного відділу може не
захотіти читати весь документ. Натомість керівник може вибрати прочитати лише
ті розділи, що стосуються його відділу. Добре розроблений технічний документ
повинен дати можливість читачеві візуально просканувати документ і легко
знаходити і розуміти розділи, що відповідають його потребам.
Можливо, ви стикалися з подібним сценарієм, коли гортаєте посібник
користувача, який є ще одним прикладом технічного письма. І замість того, щоб
читати весь посібник під час налаштування пристрою або усунення
несправностей під час аварійної ситуації, ви, ймовірно, переглядаєте зміст і
заголовки, щоб знайти відповідні розділи. Грамотно написаний посібник
користувача буде включати розділи, які чітко і лаконічно представляють
інформацію і дозволять ефективно виконати потрібне завдання.
Крім того до візуального форматування та пояснень технічної комунікації
відносять спеціалізовану термінологію, абревіатури, рівняння, таблиці,
зображення та графіки, тощо.

1.6 Комунікація як рішення

Цю модель можна застосовуватися як до завдань технічного письма, так і до
завдань проектування. Уявіть свою комунікаційну задачу як щось таке, що
вирішить проблему або покращить ситуацію. Перш ніж приступити до складання
документа або презентації, визначте проблему, яку ви хочете вирішити за
допомогою цього документа:
Зрозумійте потребу: потрібно визначити чому виникла проблема у технічній
комунікації. У когось недостатньо інформації для прийняття рішення? Хтось
подав запит на уточнення інформації? Чи існує якась незадовільна ситуація, яку

6
потрібно виправити, спілкуючись зі своєю аудиторією? Що конкретно її не
задовольняє? При цьому враховуйте категорію аудиторії. Ось деякі приклади:
А) Потенційному клієнту не достатньо інформації чи запропоноване мною
рішення ефективно вирішить його проблеми.
Б) В посібнику експлуатації принтера відсутня інформація про спосіб заправки
картриджів.
В) Бізнес-план описує тільки перший рік діяльності компанії, в той час як
інвестори робили запит на стратегічний період мінімум 5 років.
Встановіть мету: вкажіть свою мету в письмовій формі. Що ви хочете, щоб ваш
читач робив, думав чи знав? Хочете, щоб ваш читач прийняв рішення? Змінити
його думку чи поведінку? Підтримувати певний порядок дій? Який бажаний
результат? І яка форма і стиль спілкування найкраще призведуть до такого
результату? Ось деякі приклади:
А) Надати клієнту достатню кількість інформації, в ефективному та
читабельному форматі для прийняття рішення.
Б) Оновити посібник користувача принтера додавши розділ з інформацією про
спосіб заправки картриджів.
В) Створити бізнес-план відповідно до вимог інвесторів.
Визначте завдання: врахуйте специфіку вашого завдання та аудиторію, щоб
визначити, яким критеріям ви повинні відповідати. Яку форму варто надати
документу? Які елементи контенту вам потрібно включити? Чи потрібні будуть
дослідження і які? Яку інформацію хоче/потребує ваша аудиторія? Що вони вже
знають?
Перегляньте повторно запит клієнта, щоб визначити, які завдання він поставив
та, щоб зрозуміти як буде оцінюватися ваша виконане завдання.
Визначте обмеження: що може спричинити невдалу комунікацію в цьому
документі? Враховуйте свою риторику. Які існують умови, що створюють бар'єри
чи виклики для комунікації? Як ви можете їх вирішити? Ось деякі приклади:
А) Скільки часу ваша аудиторія готова витратити на ознайомлення з
документом? Наскільки великим ви можете зробити свій документ або
презентацію (кількість слова/обмеження часу)?
Б) Який формат і стиль від вас вимагають? Чи існує концепція стилю, якого ви
мали б дотримуватися? Чи існує шаблон, який ви можете використовувати?
В) Скільки часу у вас є на створення документу?
Г) Чи існують вимоги до використання джерел (правила академічної
доброчесності)?
Майте на увазі, що документ, який ви створюєте, оцінюється з точки зору того,
наскільки добре він реагує на «проблему» - тобто наскільки добре він відповідає

7
загальній меті і демонструє виконання конкретних завдань, дотримуючись
обмежень.

8
2. ТЕМИ ДОПОВІДЕЙ ДЛЯ САМОСТІЙНОГО ОПРАЦЮВАННЯ

1. "Важливість технічного письма в інженерних дослідженнях та розробках."

2. "Технічне письмо як інструмент документації в науковому дослідженні."
3. "Історія технічного письма: внесок середньовічних інженерів."
4. "Еволюція технічного письма в епоху Відродження."
5. "Роль технічного письма у промисловій революції."
6. "Технічне письмо в сучасній медицині: структура та формати."
7. "Специфіка технічного письма в програмуванні та розробці ПЗ."
8. "Ефективне технічне письмо для інженерів-електроніків."
9. "Технічне письмо в автомобільній промисловості: стандарти та вимоги."
10. "Інструкції з експлуатації як форма технічного письма."
11. "Технічне письмо для розробки ігрового програмного забезпечення."
12. "Правила створення технічних звітів для досліджень."
13. "Використання графіків і діаграм у технічному письмі."
14. "Особливості технічного редагування та коректури текстів."
15. "Технічне письмо та комунікація в команді проекту."
16. "Розвиток технічного письма в епоху цифрових технологій."
17. "Електронні інструменти для полегшення технічного письма."
18. "Технічне письмо та патентознавство: важливість оформлення патентів."
19. "Сучасні тенденції у технічному письмі: інтерактивність та мультимедійність."
20. "Міжнародні стандарти технічного письма та їх роль у глобальній комунікації."
21. " Роль граматики та граматичні помилки в технічному письмі: як їх уникнути."
22. "Лексична специфіка технічного письма: терміни та термінологія."
23. "Практичні аспекти використання абревіатур та акронімів."
24. "Важливість структурних коннекторів для логічності та послідовності в тексті."
25. "Мовні аспекти технічного аудиту та перевірки текстів."
26. "Ефективне використання прикладів та ілюстрацій для пояснення технічних
термінів."
27. "Технічне письмо та стандартизація мови: роль стандартів в текстах."
28. "Мовні аспекти веб-комунікації для технічних спеціалістів."
29. "Чому технічне письмо важливе?"
30. "Технічне письмо у військовій сфері"

Максимальна тривалість доповіді - 15 хвилин і залежить від кількості

присутніх студентів. Коротко і стисло про основне.

Критерії оцінювання:
- повнота розкриття теми;
- розуміння матеріалу.

9
3. ВИКОРИСТАНА ЛІТЕРАТУРА

1. Chelsea Milbourne, Anne Regan, Morgan Livingston, & Sadie Johann, California
Polytechnic State University-San Luis Obispo
2. Michele DeSilva et al. Central Oregon Community College via OpenOregon
3. Suzan Last, University of Victoria via BC Campus

10