Technical Writing дайджест #0: новий реліз MadCap Flare, приклади зразкової документації та телеграм-канали для техрайтерів

У випуску: тренди у техрайтингу, сучасні хмарні сервіси для перевірки документації, десятки книжок у PDF та конференції на 2019 рік.

Add to favorites

What’s new MS Style guide — спостерігаємо за змінами у Біблії техрайтера.

Confluence — щотижневі апдейти фаворита українських техрайтерів.

MadCap Flare

MadCap Flare 2018 R2 — цього разу новий реліз відверто розчарував: дуже кастомні налаштування безпеки і ніяких нових загальновживаних фіч. Із цікавого тільки мерж бренчів у GIT з UI MadCap Flare.

MadCap Flare 2018 vs. DITA — порівняльна таблиця на сайті MadCap Flare. Мабуть, на 100% об’єктивність не претендує, але доволі пізнавально.

A Step-by-Step Guide to Importing Microsoft Word Content into MadCap Flare — покрокова інструкція з імпорту документів як в новий, так і в існуючий проект.

Techcomm tools and trends — Matthew Ellison, лектор і тренер MadCap Flare, розповідає про сучасні хмарні сервіси для перевірки документації вашими колегами. Можна починати слухати з 08:20.

Articles

API Documentation Guidelines — про що варто пам’ятати, коли пишеш API документацію.

Keep It Simple — подкаст про тренди у написанні технічної документації. Можна починати слухати з 08:00.

Tech comm trends: (Part I, Part II) — Tom Johnson працює техрайтером в Amazon і веде блог з техрайтингу. Почитайте його думки і спостереження стосовно трендів у техрайтингу.

How to avoid being a secretary for engineers — емоційна стаття від Tom Johnson про тяжку долю техрайтерів. Вибачте, тяжку долю «tech comm», як зараз модно говорити :)

Гайд по написанию уведомлений — якщо раптом ви проґавили класну статтю на DOU щодо написання error messages i notifications.

Я узнал, что существуют технические писатели. Как понять, что мне это подходит? — для тих, хто тільки придивляється до професії техрайтера.

How A Professional Tech Writer Can Market Your Business? — стислий зміст: «Техрайтери — класні. Наймай, або пожалкуєш» :)

Useful links

!!! Величезне сховище книжок, статей, онлайн інструментів і інших корисних посилань. Зверніть увагу, знизу багато вкладок.

The Top 10 Best Technical Documentation Sites — приклади зразкової документації. Дивимося і насолоджуємося :)

22 API Document Generation Tools — як пише автор, для Web and RESTful APIs :)

600+ resources for technical documentation. All in one place — сотні статей на всі випадки життя. Зручна структура і пошук.

5 Great Books on Writing — за версією Ugur Akinci, Sr. Technical Writer в Honeywell. Довіримося його думці.

Telegram channels

Techwriter’s Daily — російський канал для техрайтерів. Багато подкастів і статей.

DocOps-чат — доволі живий чат, де можна поставити питання колегам чи взяти участь у гарячій дискусії.

Technical Writing 101 — ще один російський канал, з якоюсь особливою любов’ю до UX.

Technical Writing Blog — власне телеграм-версія сайту clickhelp.com, щоб не пропустити нові матеріали.

Conferences 2019

MEGAComm — 7 лютого, Єрусалим

LocWorld39r — 27-28 лютого, Куала-Лумпур

The Translation and Localization Conference — 29-30 березня, Варшава

Information Energy — 11-12 квітня, Амстердам

Write the Docs Portland — 19-21 травня, Портленд, США

Soap! — 5-7 червня, Краків

LocWorld40 Portuga — 11-13 червня, Ештуріл, Португалія

Дякую колегам зі спільноти Technical writers of Ukraine за допомогу у підготовці матеріалу.

Наступний випуск: Technical Writing дайджест #1 →