Благое дело люди делают! Все еще надеюсь что однажды что-то пригодное для продакшена типа такого будет, чтоб и с графиками и поддержкой всяких markdeep и чтоб все само.

Markdown база знаний: https://habr.com/post/415865/

#knowledgemanagement #en

Приятный сайт для создания “скриншотов” кода. Много тем, большой выбор подсветки синтаксиса, умеет PNG и SVG

https://carbon.now.sh

#screenshot #tool #en

Краткий (очень) разбор преимуществ reStructuredText vs Markdown для написания технической документации

https://eli.thegreenplace.net/2017/restructuredtext-vs-markdown-for-technical-documentation/

#reStructuredText #markdown #article #en

В дополнение к скриншотам кода/терминала, для документации также бывают полезны анимированные записти терминала с какой-либо последовательностью действий.

Вот парочка сервисов/приложений которые вспомнились:

1. https://asciinema.org/ — Самая продвинутая из подобных утилит. Позволяет cохранять и в пару кликов шарить весь записанный процесс. Можно даже встраивать плеер с записью на странички. Сайт очень красивый и можно поглазеть на чужие ASCII анимации.

2. https://github.com/icholy/ttygif — делает скрин каждого кадра и склеивает это все в gif.

3. https://github.com/nbedos/termtonoscript — Утилита написана на Python, сохраняет все в SVG анимацию

4. https://github.com/chjj/ttystudio — просто и со вкусом, на выходе выплевывает gif или APNG. Никаких зависимостей.

5. https://showterm.io/ — записывает весь процесс работы выбранной консольной утилиты и позволяет легко шарить результат, можно даже не устанавливать, а скормить в терминал bash <(curl record.showterm.io)

#screenshot #tool #en

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

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

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

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

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

#markdown #tool #en

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

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

#markdown #tool #en

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

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

#markdown #ide #ru

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

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

#ide #diagram #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

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

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

#article #ru

Telepost – Create a blog from a Telegram channel

https://telepost.io/

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

#tool

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

#example

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

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

#video #en #career