Сергей Абдульманов о текстах в интерфейсе.

Конференция Dump-18 опубликовала записи докладов. Среди них есть доклад Сергея Абдульманова, директора по маркетингу компании Мосигра. Называется «Чем конкретно отличается понятный текст для интерфейса».

Сам ещё не успел посмотреть, скорее делюсь с вами. Ссылку увидел в @uxnotes, спасибо автору! 🙂

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

​​Семён Факторович рассказывает про документацию студентам на CompTech NSK в Новосибирском государственном университете.

REST API.

Вчера вышла статья про то, как проектировать и документировать REST API, при этом не изобретая велосипеды. Автор рассказывает про типичные ошибки проектирования, про стандарты с лучшими практиками и про инструменты, которые реализуют эти стандарты. Остаётся взять и сделать себе хороший API.

https://habr.com/ru/company/oleg-bunin/blog/433322/

PagerDuty Incident Response

PagerDuty выложили в открытый доступ свою внутреннюю документацию по работе с инцидентами.

https://response.pagerduty.com

Postmortems

PagerDuty продолжают выкладывать внутреннюю доку, на этот раз про постмортемы.

https://postmortems.pagerduty.com

KnowledgeConf.

Почему в канале почти нет постов? Потому что автор работает в программном комитете конференции knowledgeconf.ru по вечерам после основной работы. На это уходят почти все силы. Зато у нас будет отличная конференция. Я вам позже буду рассказывать про доклады, которые мы приняли.

А пока что Света Новикова написала на Хабр про конференцию и нашу команду. Там много текста по теме и смешные случайные факты про ПК.

https://habr.com/ru/company/oleg-bunin/blog/437768/

Да что же такое, PDF мешает нашему мэру строить метро. Я готов стать личным советником Локтя по использованию Pandoc. Сделаем этим бюрократам .epub или что они там требуют.

​​There's no step two.
githistory.xyz — хороший инструмент для гита с великолепной инструкцией:

Quickly browse the history of any GitHub file:

1. Replace github.com with github.githistory.xyz in any file url
2. There's no step two

И гифка, чтобы совсем всё стало понятно:

​​I wanna tell my secret now. I see outdated documentation.

Семинар Advanced Technical Writing.

Сейчас будет как будто реклама, но я и так раз в неделю кому-нибудь рекомендую пойти учиться документации к Семёну Факторовичу (@factorized). Теперь порекомендую всем сразу.

---

5–6 марта Семён проводит в Москве двухдневный семинар Advanced Technical Writing.

Это ёмкий практический курс о критериях качества документации, целеполагании документационных активностей и о тонкостях описания сложных технических систем.

За два полных учебных дня участники рассмотрят и обсудят теоретические аспекты выстраивания процессов документирования и выполнят множество практических заданий.

Курс будет полезен техническим писателям, системным аналитикам, и всем, кто работает с технической документацией.

---

Помните, я писал про критерии целеполагания технического документа? Вот я о них узнал на этом самом семинаре. Был на нём дважды: весной 2017 и осенью 2018 года. Программа сильно обновилась: в первый раз критериев целеполагания было четыре, а во второй раз стало пять (-1 и +2).

В общем, рекомендую сходить самим или отправить сотрудников: http://documentat.io/courses/advanced-techwriting-moscow.

Я плюсую, отличный двухдневный dive, и самое ценное - много практики и фидбека прямо на лету, разбираем, критикуем, учимся, прошли какую-то технику, тот же критерии целеполагания - тут же разобрали на практике, написали кусочек текста.

В предверии предстоящей KnowledgeConf опубликована расшифровка моего доклада по управлению знаниями в IT на прошлогодней TeamLeadConf https://habr.com/ru/company/oleg-bunin/blog/438820/

​​Пришёл на TeamLeadConf, передо мной сложный выбор. На какой стенд встать, KnowledgeConf или Write the Docs? Я к обоим причастен :)

​​— Что у вас болит в документации?
— Её нет.
— Фантомные боли!

Сегодня на стенде documentation doctors работают Семён Факторович, Николай Поташников и Константин Валеев.

​​Конспекты TeamLeadConf 2019.
Если начал писать конспекты, сложно остановиться. Так что на TeamLeadConf я снова этим занимаюсь. Шлите пуллреквесты!

OKR: инструкция по применению.

Первый доклад этой конференции. Егор Толстой рассказывает о трёхлетнем опыте внедрения Objectives & Key Results в компании Авито. Егор даёт очень много практических примеров и разбирает типичные ошибки и заблуждения. И, конечно, там есть пошаговая инструкция по внедрению.

https://github.com/NickVolynkin/teamleadconf-19/blob/master/source/okr.md

Шлите ваши конспекты пуллреквестами в https://github.com/NickVolynkin/teamleadconf-19!

За это тоже кружки дают. А ещё на гитхабе их очень хорошо читают: у конспектов Highload в первые недели было больше тысячи посещений в день. Так что польза будет максимальная.

​У нас есть стенд имени себя — на нем непрерывно выдаются подарки и рассказывается обо всех конференциях Онтико.

Выкладывайте конспекты (в любом удобном виде) в одну из соцсетей с хэштегом #TeamLeadConf2019, с результатом подходите к стенду — получите кружку.

Со стикерпаком еще проще — его дают за любой пост с #TeamLeadConf2019

​​Работа со сроками как часть инженерной культуры.

Николай Крапивный из Badoo рассказывает, как правильно оценить время на выполнение задачи, выставить срок, работать по нему и делать выводы.

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

https://github.com/NickVolynkin/teamleadconf-19/blob/master/source/time-is-culture.md

Мотивация, делегирование и автоматизация: рецепт создания суперкоманды.

Алексей Катаев из Skyeng прочитал классный доклад про то, как тимлиду уменьшить количество ада и боли в своей работе. Во многом это близко к практикам управления знаниями: как улучшить автобусный фактор и научить каждого разработчика решать задачи, которые раньше мог делать только тимлид. А ещё напоминает историю из книги Проект Феникс: когда вокруг всё горит, как начать предотвращать пожары и перестать их постоянно тушить.

https://github.com/NickVolynkin/teamleadconf-19/blob/master/source/superteam.md

Напомню, что мы делаем конференцию про управление знаниями KnowledgeConf. Докладчики расскажут:
— что делать с автобусным фактором,
— как учить людей решать задачи,
— как найти и нанять людей, которые учатся сами.

Управление знаниями в проектных командах.

Мы тут проводим митап от программного комитета KnowledgeConf. В первой половине записали плюсы и минусы разных подходов к документации и тому, как сохранять знания о проекте. https://github.com/NickVolynkin/teamleadconf-19/blob/master/source/km-meetup.md