Technical Writing 101 🇺🇦
1.57K subscribers
244 photos
3 videos
12 files
418 links
Anything's A Documentation If You're Brave Enough

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

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

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

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

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

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

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

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

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

Источник: https://uxplanet.org/ux-writing-how-to-do-it-like-google-with-this-powerful-checklist-e263cc37f5f1
Yet Another Markdown Editor, но на этот раз разработчик хотя бы поясняет зачем нужен еще один вот такой вот. Пусть будет. https://www.zettlr.com/#why

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

#example #ru
Telepost – Create a blog from a Telegram channel

https://telepost.io/

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

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

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

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

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

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

#career #resources #book #en
Один (одна) там технический писатель из Нью Йорка поделилась в личном блоге своим воркфлоу, с кучей ссылочек, картиночек и так далее, все как вы любите. https://amrutaranade.com/2018/03/07/my-writing-process/

Из интересного:
— Мадам пользуется методом Фейнмана для лучшего запоминания и понимания предмета о котором пишет (RU) https://lifehacker.ru/metod-fejnmana/, (EN) https://collegeinfogeek.com/feynman-technique/, вполне рабочий инструмент, можно/нужно взять на вооружение
— Структурирует заметки техникой Корнелла (RU) https://lifehacker.ru/delaem-zametki-v-bloknote-po-metodu-kornella/ (EN) https://www.youtube.com/watch?v=lsR-10piMp4
— Пользует метод пяти черновиков (EN) https://goinswriter.com/how-to-write-a-book/

#article #resources #en