Technical Writing дайджест #1: підбірка технічних словників, розглядаємо вміння та навички техрайтерів

Всім привіт! Сьогодні у дайджесті поговоримо про вимоги до техрайтерів та про метрики нашої роботи. Всі, хто до сьогодні не був знайомий із Markdown, зможуть закрити цей гештальт завдяки декільком корисним статтям. Ну і на десерт — 6 словників української комп'ютерній комп'ютерної термінології.

Велика подяка за допомогу у підготовці матеріалу нашій дружній спільноті техрайтерів та зокрема телеграм-спільноті Tech Writers of Ukraine . А тепер до справи!

Теорія техрайтингу

Handbook of Technical Writing — 600+ сторінок теорії з техрайтингу. Мабуть, це одне з найповніших видань з інформацією, яку має знати кожен техрайтер. Проте варто зауважити, що книга була написана у 2003 і останній раз перевидана у 2009 році, тому деякі речі втратили актуальність і виглядають архаїчно. Наприклад, розповсюдження документації на CD.

The Elements of Style — Ще один стайл-гайд на кшталт Microsoft Manual of Style, Chicago Manual of Style і їм подібним. Із переваг: всі правила сконцентровано у 100 сторінок, що значно спрощує ознайомлення і є ятовування.

«Технічний письменник 2.0.1» — Дуже структурний і розумний погляд на роль техрайтера у компанії. Автор пропонує 5 стратегічних напрямків, які може перекривати кваліфікований техрайтер.

What nobody tells you about documentation — Автор умовно поділяє всю документацію на 4 підтипи — tutorials, how-tos, discussions and references — і детально розглядає кожен з них. Для кращого розуміння документації як явища — супер.

Вміння та навички

Собеседуем технічних письменників — tech Lead writer ділиться своїм досвідом щодо пошуку техрайтерів. Зокрема розповідає, як вони порівнювали три ключові вміння (англійська мова, вміння писати і технічні знання) і які результати отримали. Спойлер: вміння писати є більш цінною навичкою для техрайтера, ніж технічні знання.

Metrics in Technical Writing Part 1 , Part 2 — Мені здається, чи останнім годиною піднявся якийсь особливий хайп щодо метрик у техрайтингу? Вісь дві статті від ClickHelp; нещодавно у «Яндексі» був цілий семінар по метриках; на конференції TeKom у Штутгарті була доповідь з цієї теми. Як на мене, метрики у техрайтингу доволі умовні, і варто підходити до їх аналізу з великою часткою скептицизму. А що ви думаєте з цього приводу?

Requirements for translators — Цікаві речі кояться. Виявляється, на Заході існує спеціальний ДСТУ (IEC 82079-1:2012), що визначає якість технічної документації. Відповідно до нього, перекладачі повинні мати певний перелік компетенцій, який і зазначено у цій статті.

Remarkable remarks from a technical writer survey — Автор матеріалу опитав 333 техрайтера і виклав їх думки щодо змін, пересторог, трендів у техрайтингу і т. д.

How to Deal with Difficult People on Software Projects — Трішки психології вам у стрічку. Гарненька інфографіка, яка умовно поділяє IT-працівників за видами тварин, вимальовує проблеми у роботі з ними і пропонує рішення. Surprise-surprise, техрайтерів серед цього переліку IT-працівників немає :)

Markdown

Що таке Markdown — Всі, мабуть, чули про Mаrkdown, проте не всі бачили його на власні очі. До речі, на одному з наших мітапів Karen Sawrey (техрайтер у Cossack Labs) провела чудову лекцію за Mаrkdown. Якщо вам не пощастило бути на ній присутнім, ві можете ознайомитися з базовим синтаксисом у цій статті.

7 кращих текстових редакторів, що підтримують Markdown — А це для тих, хто налаштований рішуче :)

MadCap Flare

Madcap Flare R2 Images — Все, що ви хотіли знати про роботу з малюнками у Flare, але соромилися запитати.

Adding Favicons — А ти додав іконку своєї компанії?! Favicon — це іконка, яка відображається перед заголовком табі і у переліку улюблених посилань. Ця маленька, проте дуже важлива деталь онлайн-документації суттєво покращує UX і свідчить про вашу увагу до деталей.

Дизайн

Візуалізація даних у роботі аналітика: типи діаграм і яку вибрати — Стислий посібник про те, як обрати тип діаграми, а також багато корисних посилань на цю тему, якщо статті виявиться недостатньо.

Redesigning the Office App Icons to Embrace a New World of Work — Не маю логічного пояснення, чому так цікаво спостерігати за еволюцією MS Office іконок, але в цьому є якась магія. Бонус: Еволюція логотипом Mastercard .

Google показав новий дизайн Google Документів і Таблиць — Ох, з одного боку, стало охайніше, гарніше і більш стильно, а з іншого — ця уніфікація лякає. Всі прагнуть світлого мінімалістичного дизайну, і вже не розумієш, де Google, де Apple, а де твій продукт (моя компанія в минулому релізі зробила клієнт у такому ж стилі).

Словники

Словник комп'ютерній комп'ютерних термінів LambdaBooks — Словник термінів, розроблений і прийнятий на використання командою «LambdaBooks». Рекомен-дованих для всієї україномовної літератури про програмування. Бонус: сторінка LambdaBooks у facebook .

Англо-український тлумачний словник з обчислювальної техніки, Інтернету і програмування — Спільна робота Microsoft і видавництва «СофтПрес». Словник вміщує більше 11 700 термінів, абревіатур і акронімів, які використовують у сегментах комп'ютерній комп'ютерної техніки, програмування, обчислювальних мереж, а також основних прикладних сферах. Здавалося б, все ідеально, вісь тільки це видання 2005 року.

Англо-український словник з IT — Окрім цього словника, ви знайдете на сторінці словники зі споріднених тим, як то радіоелектроника чи математика. Також є посилання на форум, де можна поставити питання або долучитися до обговорення термінів з ентузіастами.

Словотвір — Майданчик для пошуку, обговорення та вибору влучних українських відповідників до запозичених слів.

Microsoft Language Portal — Англо-український і українсько-англійський словник комп'ютерній комп'ютерної термінології від Microsoft. Мабуть, найповніша і найсвіжіша колекція.

Словник.иа — Загальний словник усіх українських слів. Містить понад 130 000 тлумачень із Словника української мови та понад 21 000 тлумачень, доданих командою та користувачами СЛОВНИК.иа . Словоформи (орфографічний словник) для більше ніж 260 000 слів.

? Попередній випуск: Technical Writing дайджест #0

Опубліковано: 19/01/19 @ 08:00
Розділ Різне

SEO Блог