Небольшое интересное утреннее чтиво от Техписа-Интерна в Google

https://medium.com/@shrij/technical-writer-internship-at-google-d17e7f580c1b

#career #en

Статейка о UX-писателях (Product Writer), с чем их есть и чем они полезны:
https://daresay.co/2018/11/20/so-youve-got-a-product-writer-on-your-team-now-what/

#uiux #en #career

Поправил тут комикс под редакторов ;)

Рассказ о том, как документация Redis Labs переехала (начала переезжать) на docs-as-code подход и заопенсорсила документацию и что из этого вышло.
https://www.docslikecode.com/articles/moving-agile-open-source-docs/

#article #DocsAsCode #en

Когда хочется красивый статик сайтик с документацией мы обычно делаем что?
1. Идем смотреть че придумали нового
2. Выбираем уже полюбившееся

Для тех, кто только находится в поиске, предлагаю зайти на https://staticsitegenerators.net/ где представлен список из 464 Static Site Generator'ов

#tool #SSG #en

Ну и чтобы вы не забывали, что техническая документация это крайне обширное понятие, которое затрагивает не только IT индустрию, предлагаю читнуть статейку про дизайн избирательных бюллетеней, чем вам не документация.

https://www.npr.org/2018/11/24/670107455/why-are-so-many-election-ballots-confusing



P.S С конца этой недели бложик вместе с администрацией уходит на двухнедельный отпуск, всем УДАЧИ ОСТАВАТЬСЯ В СВОИХ ОФИСАХ

#career #en

Метрики эффективности документации.

Совсем недавно Яндекс проводил митап про метрики эффективности документации. Были такие доклады:

— Методы оценки трудозатрат и сроков документирования или Как правильно отвечать на неправильные вопросы. Александр Лебедев, компания Философт.
— Как измерить качество документации и эффективность её разработки. Светлана Каюшина, Юрий Никулин и Антон Литвинов из Яндекса.
— Кастомизация отчётов, или Как говорить на языке метрик без переводчика. Анастасия Агеева, Intel.

Лана Новикова (@the_know_all) законспектировала доклады, там же есть ссылки на слайды:

https://gist.github.com/lananovikova10/d48191e6c8cefdd08d81e4a4a85e5cf8

Организаторы обещали выложить видеозаписи в январе 2019.

Красивые чейнджлоги всегда в почете

#changelog

При чем тут Яндекс.Авто и какой фикспрайс?

Но в целом, самый бодрый what’s new из полсотни предновогодних обновлений. #uxtext

Часто работаете с Asciidoc? Попробуйте пописать в AsciidocFX. Умеет предательски много, графики, pie чарты, презентации, итд. https://github.com/asciidocfx/asciidocfx/

#asciidoc #en #tool

Я как-то писал о митапе в Амстердаме о тестировании документации, там товарищи пилили тулзу, которая аккумулирует в себе "а collection of checks which help to improve the quality of your docs". Так вот, они время не теряли и неспешно пилили и пилили эту штуку и она доросла уже до альфы. Все это дело крутится в Докере для локальной проверки ваших текстиков, ну или можно это все запихнуть в CI. Из интересного — они впилили лучший линтер маркдауна из возможных (remark), так что есть надежда, что эта штука выстрелит, советую держать руку на пульсе. Все ссылки в раундапе за 2018-й, ознакамливайтесь!

https://testthedocs.org/roundup-12-2018.html

#testthedocs #tool #en

Небольшой (получасовой) ликбез по основным типам документации с детальным описанием каждого:

https://youtu.be/t4vKPhjcMZg

#video #en

Пример краткого и красивого Writing Guide'a от DigitalOcean:

https://www.digitalocean.com/community/tutorials/digitalocean-s-technical-writing-guidelines#style

#styleguide #en

Всем привет, опубликовали видеозаписи с Мини-Гипербатона, прошедшего в декабре:

- Методы оценки трудозатрат и сроков документирования (Александр Лебедев): https://events.yandex.ru/lib/talks/6821/
- Как измерить качество документации и эффективность её разработки (Светлана Каюшина, Юрий Никулин, Антон Литвинов): https://events.yandex.ru/lib/talks/6822/
- Кастомизация отчётов, или Как говорить на языке метрик без переводчика (Анастасия Агеева): https://events.yandex.ru/lib/talks/6825/

Не то, чтобы новость или что-то мега-примега полезное, но советую наблюдать за этой книгой, как выйдет — уверен, будет очень полезно и круто.
https://rosenfeldmedia.com/books/writing-for-interfaces/

#book #en #resource

Как я уже не раз говорил, доля Техписа может занести вас совсем не в туда, куда вы себе представляли, когда устраивались на оную должность. Так, например, вас могут напрячь быть каким-нить UI Writer'ом и писать интерфейсные тексты окажется не так просто, как выглядело со стороны. Сегодня мы попробуем не забыть о том, что иногда продукты переводят и интерфейсные тексты — тоже:

https://blog.prototypr.io/3-things-to-keep-in-mind-when-designing-ui-to-be-translated-in-different-languages-e1d02accf21c

#uiux #career #en

Для любителей порисовать диаграмки в Mermaid:
https://sprite.link/

#diagram #tool

Прекраснейшей информативности статья про Тултипы. Показывают c картинками Do's и Don't's, рассказывают в чем разница между Попап Типсами и Тултипсами и всякое такое!

https://www.nngroup.com/articles/tooltip-guidelines/


P.S Канал жив, а вот редакция едва ли. Гигантский загруз по работе, но я о вас не забыл, скоро разгребем всё и снова будем умнеть вместе

#visual #en #article

Тут выложили статистику (собранную с 71281 разработчика) с кучей всякой информации. Прошу обратить внимание на самую большую боль разработчиков — плохая документация.

https://research.hackerrank.com/developer-skills/2019

#article #en