що це за курс
Інтенсивний семінар для практикуючих технічних письменників.
Без прив'язки до конкретних типів документів і документаційних методологій розповімо, як зробити ваш текст краще, як описувати складні програмні (і взагалі технічні) системи, і як виробити об'єктивні критерії якості документації і донести їх до всієї команди.
Для кого
- для досвідчених технічних письменників, системних аналітиків, і всіх, кому за родом діяльності потрібно описувати складні технічні системи.
- життєві цикли технічного документа: великий цикл (від бізнес-проблеми до її вирішення) і малий цикл (від постановки завдання на написання документа до його приймання). Три кити технічного документа: мета, цільова аудиторія, замовник.
- заочне профілювання цільової аудиторії: кому ми пишемо? Що ми знаємо про читача? Що читач знає про описуваний предмет?
- проблеми технічної документації очима її споживача:" нічого не зрозумів"," не знайшов того, що шукав"," не зміг вирішити вихідну проблему " і т.д. і методи їх вирішення. Типові сценарії читання технічного тексту. Вибір структури документа і підходів до подачі інформації виходячи з очікуваних сценаріїв читання.
- рецензування документів та його види: Коректура, перевірка фактологічної коректності, перевірка на відповідність цілі. Сценарії рецензування, особиста взаємодія редактора і автора. Антипаттерны рецензування.
- Об'єктивні критерії якості документа. "Джерела істини": документаційні стандарти, словники, довідники з граматики, зовнішні і внутрішні гіди по стилю. Компроміс між доведенням документа до досконалості і витримуванням термінів. Поняття "good enough".
- Суб'єктивні критерії якості документа, суб'єктивні оцінки при рецензуванні та прийманні. Ситуації" мені не подобається","я б написав по-іншому". Вирішення неконструктивних спорів у процесі рецензування. Чому мета документа стає особливо важливою на етапі рецензування та приймання.
- понятійний граф тексту. Підходи до структурування тексту і до подачі інформації. Принцип піраміди.
- підходи до опису складних технічних систем. Робота з ментальними моделями, опис різних ракурсів однієї і тієї ж моделі. Архітектурні документи як один з найскладніших видів технічної документації.
- типові помилки структури і подачі інформації. "Прокляття знання"і" прокляття незнання". Визначення понять через їх другорядні характеристики. Непотрапляння в ціль і цільову аудиторію. Помилка ракурсів. Виклад фактів в тому порядку, в якому їх дізнавався автор. Інші варіанти порушення порядку в понятійному графі.
- Роль старшого технічного письменника в команді. Створення культури рецензування, передача досвіду, формування командного смаку.
https://privatelink.de/?https://documentat.io/courses/advanced-techwriting/