Новый конспект Highload.
Тут случилось почти невероятное. В репозиторий с конспектами Highload закинули целых три пулл-реквеста. Два — с исправлениями и дополениями. Спасибо за них Ивану Муратову и Никите Грызлову!
А вчера Ефим Поберёзкин (@efim_poberezkin) отправил третий — с целым конспектом доклада Andy Pavlo «Make Your Database Dream of Electric Sheep: Designing for Autonomous Operation». Особенно круто, что доклад и конспект — на английском.
Если у вас тоже есть конспекты — будет здорово, если вы тоже их добавите. Так они принесут пользу ещё множеству людей. Так уж получилось, что этот репозиторий много читают, и ваш конспект тоже будут читать. Смотрите сами, на скриншоте Insights → Traffic с гитхаба.
Тут случилось почти невероятное. В репозиторий с конспектами Highload закинули целых три пулл-реквеста. Два — с исправлениями и дополениями. Спасибо за них Ивану Муратову и Никите Грызлову!
А вчера Ефим Поберёзкин (@efim_poberezkin) отправил третий — с целым конспектом доклада Andy Pavlo «Make Your Database Dream of Electric Sheep: Designing for Autonomous Operation». Особенно круто, что доклад и конспект — на английском.
Если у вас тоже есть конспекты — будет здорово, если вы тоже их добавите. Так они принесут пользу ещё множеству людей. Так уж получилось, что этот репозиторий много читают, и ваш конспект тоже будут читать. Смотрите сами, на скриншоте Insights → Traffic с гитхаба.
Ruby code documentation.
Друзья-рубисты, а расскажите, как вы документируете код? Чем лучше сгенерить красивый и удобный сайт с документацией по коду? А ещё, как писать комментарии к методам, чтобы среда разработки их понимала и показывала? У меня IDEA c плагином Ruby, но могу поставить RubyMine.
Задача такая: есть немного кода на Ruby, я его сейчас понял, а через месяц снова забуду. Хочу грамотно написать комментарии в коде (это план-минимум) и сгенерить сайтик с документацией (это план-максимум).
Похоже, что официальная документация сделана на RDoc, но она какая-то несимпатичная, простите уж. Ещё есть YARD, и ruby-doc.org хорошо выглядит, но неясно, чем сгенерили.
В общем, расскажите, что самое лучшее, правильное и удобное? Приходите в @docsascode или в личку @nick_volynkin.
Друзья-рубисты, а расскажите, как вы документируете код? Чем лучше сгенерить красивый и удобный сайт с документацией по коду? А ещё, как писать комментарии к методам, чтобы среда разработки их понимала и показывала? У меня IDEA c плагином Ruby, но могу поставить RubyMine.
Задача такая: есть немного кода на Ruby, я его сейчас понял, а через месяц снова забуду. Хочу грамотно написать комментарии в коде (это план-минимум) и сгенерить сайтик с документацией (это план-максимум).
Похоже, что официальная документация сделана на RDoc, но она какая-то несимпатичная, простите уж. Ещё есть YARD, и ruby-doc.org хорошо выглядит, но неясно, чем сгенерили.
В общем, расскажите, что самое лучшее, правильное и удобное? Приходите в @docsascode или в личку @nick_volynkin.
Your Career опубликовали исследование рынка труда в ИТ. Подробно: https://news.1rj.ru/str/yourcareer/618
Кратко про технических писателей: в Москве до 4 лет опыта в среднем 80к, дальше 145к; в Питере соответственно 65к и 100к. Это гросс, до налогов.
А у вас как?
👍 — выше средней
👌 — средняя
👎 — ниже средней
😂 — я дата-сатанист, получаю столько же в евро
Кратко про технических писателей: в Москве до 4 лет опыта в среднем 80к, дальше 145к; в Питере соответственно 65к и 100к. Это гросс, до налогов.
А у вас как?
👍 — выше средней
👌 — средняя
👎 — ниже средней
😂 — я дата-сатанист, получаю столько же в евро
Предложенные правки в мерж-реквестах GitLab.
Совсем недавно вышел новый GitLab 11.6. В нём есть интересная фича: теперь в мерж-реквестах ревьюер может предлагать изменения. Потом автор реквеста одной кнопкой принимает эти изменения, они становятся новым коммитом.
Думаю, эта фича будет очень полезна в работе с текстом. Мы уже привыкли работать с предложенными правками в Google Docs и похожих инструментах. Редактор не пишет «думаю, здесь лучше написать вот так-то». Редактор просто выделяет старое и поверх него пишет новое, предложенной правкой. Это удобно, и теперь это есть в GitLab.
Обязательно попробую эту штуку сам — я как раз пошёл на учебный курс и сдаю задания куратору в GitLab. Расскажу потом, что получится. А вам как? Будете использовать предложенные правки для ревью документации и/или кода?
🔥 — выглядит интересно, иду пробовать.
🌳 — мне достаточно комментариев.
💨 — у меня Word/CMS/ревью-по-электропочте, так что без шансов.
❄️ — а зачем ревью и мерж-реквесты? Я сразу пишу идеальный код/текст.
Совсем недавно вышел новый GitLab 11.6. В нём есть интересная фича: теперь в мерж-реквестах ревьюер может предлагать изменения. Потом автор реквеста одной кнопкой принимает эти изменения, они становятся новым коммитом.
Думаю, эта фича будет очень полезна в работе с текстом. Мы уже привыкли работать с предложенными правками в Google Docs и похожих инструментах. Редактор не пишет «думаю, здесь лучше написать вот так-то». Редактор просто выделяет старое и поверх него пишет новое, предложенной правкой. Это удобно, и теперь это есть в GitLab.
Обязательно попробую эту штуку сам — я как раз пошёл на учебный курс и сдаю задания куратору в GitLab. Расскажу потом, что получится. А вам как? Будете использовать предложенные правки для ревью документации и/или кода?
🔥 — выглядит интересно, иду пробовать.
🌳 — мне достаточно комментариев.
💨 — у меня Word/CMS/ревью-по-электропочте, так что без шансов.
❄️ — а зачем ревью и мерж-реквесты? Я сразу пишу идеальный код/текст.
Технический писатель 2.0.1.
Опрос про зарплату техписателей показал, что в среднем респонденты зарабатывают чуть меньше среднего по результатам исследования. Давайте подумаем и обсудим, как зарабатывать больше.
Думаю, что доход профессионала пропорционален пользе для бизнеса. Ещё влияют навыки переговоров, зрелость компании, рынок и прочее. Но умение создавать полезный результат и объяснять его полезность — это главное.
Как приносить больше пользы с помощью документации и текста вообще? Как измерить эту пользу? У меня есть доклад как раз об этом: «Технический писатель 2.0.1» Рассказываю про пять нестандартных ролей, их типичные задачи и точки измерения результата:
— DocOps-инженер
— UX-писатель
— Технический евангелист
— Knowledge manager
— Documentation owner
Доклад версионный: я общаюсь с новыми людьми, получаю обратную связь, дорабатываю доклад и рассказываю снова. Пока что было две итерации, так что версия приросла с 2.0 до 2.0.1. Вот запись второго выступления на митапе Write the Docs Moscow #2: Технический писатель 2.0.1.
Очень хочу обратной связи, критики, дополнений и ваших историй успеха в работе с текстом и знанием. Расскажите мне, какие задачи вы решаете, в чём приносите пользу, и как её измеряете. Пишите @nick_volynkin.
А ещё я буду вам очень благодарен, если вы подпишетесь на канал Write the Docs Russia. Сейчас там 13 подписчиков. Будет 100 — у канала появится понятный URL.
Опрос про зарплату техписателей показал, что в среднем респонденты зарабатывают чуть меньше среднего по результатам исследования. Давайте подумаем и обсудим, как зарабатывать больше.
Думаю, что доход профессионала пропорционален пользе для бизнеса. Ещё влияют навыки переговоров, зрелость компании, рынок и прочее. Но умение создавать полезный результат и объяснять его полезность — это главное.
Как приносить больше пользы с помощью документации и текста вообще? Как измерить эту пользу? У меня есть доклад как раз об этом: «Технический писатель 2.0.1» Рассказываю про пять нестандартных ролей, их типичные задачи и точки измерения результата:
— DocOps-инженер
— UX-писатель
— Технический евангелист
— Knowledge manager
— Documentation owner
Доклад версионный: я общаюсь с новыми людьми, получаю обратную связь, дорабатываю доклад и рассказываю снова. Пока что было две итерации, так что версия приросла с 2.0 до 2.0.1. Вот запись второго выступления на митапе Write the Docs Moscow #2: Технический писатель 2.0.1.
Очень хочу обратной связи, критики, дополнений и ваших историй успеха в работе с текстом и знанием. Расскажите мне, какие задачи вы решаете, в чём приносите пользу, и как её измеряете. Пишите @nick_volynkin.
А ещё я буду вам очень благодарен, если вы подпишетесь на канал Write the Docs Russia. Сейчас там 13 подписчиков. Будет 100 — у канала появится понятный URL.
YouTube
Николай Волынкин, «Технический писатель 2.0.1»
Рассказываю о том, о том, какие задачи может выполнять технический писатель, чтобы принести больше пользы бизнесу; как эти задачи сформулировать и измерить успех. А ещё о том, куда движется профессия, что теряет ценность, а что наоборот, становится ценным.…
— в этом разделе будут ваши споры
— на этой странице будут ваши штрафы
— в этом коде будут ваши баги
АААААААааааа!
t.me/theyforcedme/704
— на этой странице будут ваши штрафы
— в этом коде будут ваши баги
АААААААааааа!
t.me/theyforcedme/704
Хорошие новости, подарки и игра.
Привет, друзья! У меня есть для вас две хороших новости: конференция про управление знаниями и курс по DocOps. А ещё я приготовил для вас подарки и игру.
KnowledgeConf.
В конце апреля 2019 года в Москве пройдёт конференция про управление знаниями в IT. Будут доклады о том, как снижать риски, переиспользовать решения, улучшать автобусный фактор, быстрее онбордить новых сотрудников. Организует конференцию Олег Бунин, а автор этого канала работает в программном комитете.
Мы ищем докладчиков! Если хотите выступить, оставьте заявку на conf.ontico.ru. С любыми вопросами пишите мне (@nick_volynkin).
Курс по DocOps.
Я начал работу над курсом по DocOps. Буду выпускать его небольшими частями, которые потом соберу в одно целое. В курсе будут в том числе такие темы:
— документация как код, языки разметки и генераторы
— continuous delivery для документации
— линтеры и тесты для документации
— документирование API и SDK
— документирование инфраструктуры и микросервисов
Несколько модулей опробую в конце января на зимней студенческой школе в НГУ. Студенты научатся интересно писать о своих проектах, редактировать и деплоить сайты с документацией и делать презентации на reveal.js. Если вы студент — записывайтесь на школу, там классно.
Подарки за фидбек.
Хочу сделать канал и курс максимально полезными для вас. Пожалуйста, ответьте на несколько вопросов. Среди респондентов я разыграю несколько хороших электронных книг. Опрос закроется 15 января, тогда же я разыграю подарки.
Игра.
Лучший подарок для меня — когда вы даёте мне обратную связь и рассказываете друзьям про канал @docops. Давайте сыграем в игру. Сейчас здесь 974 читателя. Если к 1 февраля будет 1300, то после студенческой школы я повторю курс онлайн для всех желающих, бесплатно, в обмен на обратную связь.
С новым годом!
Привет, друзья! У меня есть для вас две хороших новости: конференция про управление знаниями и курс по DocOps. А ещё я приготовил для вас подарки и игру.
KnowledgeConf.
В конце апреля 2019 года в Москве пройдёт конференция про управление знаниями в IT. Будут доклады о том, как снижать риски, переиспользовать решения, улучшать автобусный фактор, быстрее онбордить новых сотрудников. Организует конференцию Олег Бунин, а автор этого канала работает в программном комитете.
Мы ищем докладчиков! Если хотите выступить, оставьте заявку на conf.ontico.ru. С любыми вопросами пишите мне (@nick_volynkin).
Курс по DocOps.
Я начал работу над курсом по DocOps. Буду выпускать его небольшими частями, которые потом соберу в одно целое. В курсе будут в том числе такие темы:
— документация как код, языки разметки и генераторы
— continuous delivery для документации
— линтеры и тесты для документации
— документирование API и SDK
— документирование инфраструктуры и микросервисов
Несколько модулей опробую в конце января на зимней студенческой школе в НГУ. Студенты научатся интересно писать о своих проектах, редактировать и деплоить сайты с документацией и делать презентации на reveal.js. Если вы студент — записывайтесь на школу, там классно.
Подарки за фидбек.
Хочу сделать канал и курс максимально полезными для вас. Пожалуйста, ответьте на несколько вопросов. Среди респондентов я разыграю несколько хороших электронных книг. Опрос закроется 15 января, тогда же я разыграю подарки.
Игра.
Лучший подарок для меня — когда вы даёте мне обратную связь и рассказываете друзьям про канал @docops. Давайте сыграем в игру. Сейчас здесь 974 читателя. Если к 1 февраля будет 1300, то после студенческой школы я повторю курс онлайн для всех желающих, бесплатно, в обмен на обратную связь.
С новым годом!
А для тех, кому понравится нравится писать хорошие конспекты, у меня будет отдельное деловое предложение. Присоединяйтесь. 😁
Forwarded from Demetrio Voguer
Питер, отзовись!
Мы делаем митап про разработку в формате Lean Coffee и ищем техписов, которые готовы помочь с конспектированием бесед.
Ссылка на мероприятие: https://piterpy.timepad.ru/event/886097/
Пример бомбового конспекта от @Nick_Volynkin: https://github.com/NickVolynkin/ritfest18-community-meetup
Мы делаем митап про разработку в формате Lean Coffee и ищем техписов, которые готовы помочь с конспектированием бесед.
Ссылка на мероприятие: https://piterpy.timepad.ru/event/886097/
Пример бомбового конспекта от @Nick_Volynkin: https://github.com/NickVolynkin/ritfest18-community-meetup
piterpy.timepad.ru
PiterPy Meetup #13 Lean Coffee / События на TimePad.ru
PiterPy Meetup — петербургские митапы про Python и разработку
Кстати, завтра я выберу три лучших отзыва и подарю авторам хорошие книжки, которые и так всем рекомендую: Проект Феникс или Docs Like Code.
Хотите книгу? Ответьте на пару вопросов про этот канал и учебный курс.
Хотите книгу? Ответьте на пару вопросов про этот канал и учебный курс.
Подарки за отзывы.
Друзья, спасибо вам за целых 24 отзыва про канал! Они оказались очень полезными, вы подсказали мне много хороших идей и подтвердили важность тех, которые у меня уже были.
Я не стал ранжировать отзывы и просто выбрал три случайных. Призы выиграли Егор, Светлана и Екатерина. Всем напишу сегодня.
(нумерация с 2 по 25, потому что первым идёт заголовок таблицы)
Друзья, спасибо вам за целых 24 отзыва про канал! Они оказались очень полезными, вы подсказали мне много хороших идей и подтвердили важность тех, которые у меня уже были.
Я не стал ранжировать отзывы и просто выбрал три случайных. Призы выиграли Егор, Светлана и Екатерина. Всем напишу сегодня.
(нумерация с 2 по 25, потому что первым идёт заголовок таблицы)
Сергей Абдульманов о текстах в интерфейсе.
Конференция Dump-18 опубликовала записи докладов. Среди них есть доклад Сергея Абдульманова, директора по маркетингу компании Мосигра. Называется «Чем конкретно отличается понятный текст для интерфейса».
Сам ещё не успел посмотреть, скорее делюсь с вами. Ссылку увидел в @uxnotes, спасибо автору! 🙂
https://www.youtube.com/watch?v=XrhxisJN_zQ
Конференция Dump-18 опубликовала записи докладов. Среди них есть доклад Сергея Абдульманова, директора по маркетингу компании Мосигра. Называется «Чем конкретно отличается понятный текст для интерфейса».
Сам ещё не успел посмотреть, скорее делюсь с вами. Ссылку увидел в @uxnotes, спасибо автору! 🙂
https://www.youtube.com/watch?v=XrhxisJN_zQ
REST API.
Вчера вышла статья про то, как проектировать и документировать REST API, при этом не изобретая велосипеды. Автор рассказывает про типичные ошибки проектирования, про стандарты с лучшими практиками и про инструменты, которые реализуют эти стандарты. Остаётся взять и сделать себе хороший API.
https://habr.com/ru/company/oleg-bunin/blog/433322/
Вчера вышла статья про то, как проектировать и документировать REST API, при этом не изобретая велосипеды. Автор рассказывает про типичные ошибки проектирования, про стандарты с лучшими практиками и про инструменты, которые реализуют эти стандарты. Остаётся взять и сделать себе хороший API.
https://habr.com/ru/company/oleg-bunin/blog/433322/
Forwarded from DevOps&SRE Library
PagerDuty Incident Response
PagerDuty выложили в открытый доступ свою внутреннюю документацию по работе с инцидентами.
https://response.pagerduty.com
PagerDuty выложили в открытый доступ свою внутреннюю документацию по работе с инцидентами.
https://response.pagerduty.com
Forwarded from DevOps&SRE Library
Postmortems
PagerDuty продолжают выкладывать внутреннюю доку, на этот раз про постмортемы.
https://postmortems.pagerduty.com
PagerDuty продолжают выкладывать внутреннюю доку, на этот раз про постмортемы.
https://postmortems.pagerduty.com
KnowledgeConf.
Почему в канале почти нет постов? Потому что автор работает в программном комитете конференции knowledgeconf.ru по вечерам после основной работы. На это уходят почти все силы. Зато у нас будет отличная конференция. Я вам позже буду рассказывать про доклады, которые мы приняли.
А пока что Света Новикова написала на Хабр про конференцию и нашу команду. Там много текста по теме и смешные случайные факты про ПК.
https://habr.com/ru/company/oleg-bunin/blog/437768/
Почему в канале почти нет постов? Потому что автор работает в программном комитете конференции knowledgeconf.ru по вечерам после основной работы. На это уходят почти все силы. Зато у нас будет отличная конференция. Я вам позже буду рассказывать про доклады, которые мы приняли.
А пока что Света Новикова написала на Хабр про конференцию и нашу команду. Там много текста по теме и смешные случайные факты про ПК.
https://habr.com/ru/company/oleg-bunin/blog/437768/