Technical Writing 101 🇺🇦

У ребят из iFixit (сообщество людей, которые помогают друг другу что-либо починить или восстановить) есть отличный Technical Writing проект, в котором любой студент может написать/отредактировать инструкцию по ремонту и/или замене каких-то деталей в поломанном устройстве. Благое дело!

Это мог бы быть отличный источник для практики для начинающего техписателя, однако там просят войти в систему используя имэйл своего университета/школы, подозреваю, что просто нужна почта в зоне .edu. НО! Если вам таки лень искать где достать соответствующее мыло, а тяга к знаниям неугасаема, то перейдите в раздел с информацией для студентов по вот этому —> https://edu.ifixit.com/student-resources/ <— линку. Там вас научат разнице между цитированием источников и тыреньем чужого контента, научат работать с форматированием в Вики, тыкнут в самые популярные ошибки и даже выдадут Tech Writing Handbook. Вот этот самый хендбук при беглом осмотре оказался довольно годным, поэтому сэкономлю вам несколько минут и поделюсь с вами им прямо тут. Have a good day, fellas ❤️

#career #resources #book #en

Отвлекусь на секунду от восхваления Маркдауна и напомню, что это не единственный годный язык разметки текста. Например, есть еще и Asciidoc. В статейке чувак делится своим опытом по верстке (красивой) книги пользуясь Sketch и Asciidoc. Напомню, что многие популярные издательства (O'Reilly, Manning) пользуются Asciidoc для верстки профессиональной литературы, это что-то да значит!

https://hackernoon.com/using-sketch-and-asciidoc-to-generate-a-professional-tech-book-ef5b5d8dd410

#asciidoc #article

Небольшое видео о жизни Тех. Писателей в Google

https://www.youtube.com/watch?v=qnnkAWP55Ww

#video #en #career

Документация от Бога

#example

Telepost – Create a blog from a Telegram channel

https://telepost.io/

Будем попробовать!

#tool

Как писать дату и время в интерфейсах

http://mikeozornin.ru/blog/all/how-to-write-datetime-in-ui/

#article #ru

Как сделать самую скучную документацию на свете (депозитный договор) чуточку менее скучным - приложить к нему наклейки с котами. Не техническая, но документация. Работаем дальше.

#example #ru

Yet Another Markdown Editor, но на этот раз разработчик хотя бы поясняет зачем нужен еще один вот такой вот. Пусть будет. https://www.zettlr.com/#why

#markdown #ide #tool

UX-копирайтинг [Опыт Google]

Заметки с Google I/O 2017, на котором UX-копирайтеры компании рассказали о собственном опыте организации работы и составили чек-лист:

— Пользователь на первом месте. Думайте о людях, для которых создаёте продукт.
— Понятно. Слова должны описывать проблемы людей, а не программные проблемы.
— Лаконично. Не коротко, а более эффективно. Сразу говорите о важном.
— Полезно. Текст должен подсказывать следующий шаг, приближать человека к тому, чего он хочет добиться.
— В духе бренда. Создайте собственный голос, который будет узнаваться пользователем.

Источник: https://uxplanet.org/ux-writing-how-to-do-it-like-google-with-this-powerful-checklist-e263cc37f5f1

Доцент Государственного университета Вебера по программе Профессионального и Технического письма, рассказывает о стереотипах на рабочем месте, которые обесценивают техническую и профессиональную коммуникацию. Эти мифы увековечивают мысль о том, что работа в области технической коммуникации чисто косметическая, секретарская и вообще НИНУЖНА.

http://idratherbewriting.com/2018/07/18/stereotypes-about-tech-writers-in-workplace/

#article #en

Набрел тут на интересную статистику. Ценности особо никакой, но так, для ознакомления.

#vacancy #en

Ну и наконец-то многострадальная статья про рисование графиков в документации буквами. Ловите!

http://telegra.ph/Uchimsya-risovat-grafiki-v-dokumentacii-bez-dizajnera-i-talanta-07-12

#ide #diagram #ru

Эм. По неизвестной мне причине куда-то пропал пост со второй частью лонгрида про настройку Atom для тех, кто хочет научиться лучше комбинировать английские слова в предложения, вот он повторно. (хотя поиском по каналу находится, но его не видно. МАГИЯ)

http://telegra.ph/Pimp-My-Markdown-Part-II-04-20

#markdown #ide #ru

Расширение для Хрома для поехавших на Markdown

https://github.com/plibither8/markdown-new-tab

#markdown #tool #en

Читать и смотреть исходники статей блога создателя одной из лучших версий Markdown — Markdeep, это чистое наслаждение.

#markdown #tool #en

Привычки глупых людей: предпочитать сложные слова и конструкции простым аналогам

Не любите записывать чужие умные мысли, а душевно склоняетесь к эпистолярной фиксации рациональных идей башковитых индивидуумов? Фейнмана на вас нет, а есть Гегель, «ибо суть дела исчерпывается не своей целью, а своим осуществлением, и не результат есть действительное целое, а результат вместе со своим становлением; цель сама по себе есть безжизненное всеобщее, подобно тому как тенденция есть простое влечение, которое не претворилось еще в действительность; а голый результат есть труп, оставивший позади себя тенденцию. — Точно так же различие есть скорее граница существа дела; оно налицо там, где суть дела перестает быть, или оно есть то, что не есть суть дела».

Источник: https://knife.media/habits-of-stupid-people/

Главное правило техрайта - пиши просто. Вспоминается одно из мест работы, где у меня был напарник и я только-только начинал познавать документодзен и всячески пытался донести до компаньона и начальства, что вычурные английские словечки не делают текст лучше и качественнее, но естественно меня никто не слушал, а аргументировать я особо и не мог, это был такой gut feeling