Size: a a a

2019 April 15
DocOps
Мы обещали вам подробно рассказать о том, что еще будет на KnowledgeConf кроме докладов, и держим слово. А будет интересное — будем экспериментировать и мечтать. И обязательно посмотрите на идеи из непринятых докладов и напишите в комментариях, что нужно обсудить в будущем.
https://habr.com/ru/company/oleg-bunin/blog/445040/
источник
2019 April 21
DocOps
Читатели, как вы знаете, чуть менее, чем через неделю состоится KnowledgeConf - первая профессиональная конференция по управлению знаниями в IT компаниях. На ней собрали интересные кейсы, дискуссии и спикеров из таких компаний, как Badoo, Skyeng, Google, КРОК, Lamoda, Миран, Skillbox, Стратоплан, Тинькофф, БИОКАД, Ozon и еще десятка уважаемых компаний.  

У вас есть отличная возможность буквально на флажке выиграть билет на нашу конференцию и другие подарки 🔥🔥🔥.

1. До 23:59 по Москве 23 апреля разместите пост в любимой соцсети или канале в Телеграмме о том, какую практику в управлении знаниями вам удалось применить или чем, как вам кажется, вашей компании было бы полезно управление знаниями (тема на выбор).
2. Добавляете хэштег #knowledgeconf2019 ВАЖНО! Ваш профиль должен быть открыт на время проведения флешмоба, чтобы мы могли найти ваш пост по хэштегу.
3. 23 апреля в 23:59 мы случайным образом разыграем билет на конференцию и утешительные призы - три любимые книги, рекомендованные членами Программного комитета конференции. Книги мы передадим лично или отправим почтой в любой город.
4. Каждый участник конкурса получит скидку на билет в размере 10 процентов.

Участвуйте! Конференция обещает быть очень крутой. Кстати, подписанным на этот канал быть не обязательно, так что репостите информацию.
источник
2019 April 26
DocOps
10 компетенций и 6 ролей Knowledge Manager

Сегодня на #knowledgeconf2019 модерирую зал Кембридж и пишу конспекты. Потому что могу!

Первый доклад — от Марии Мариничевой, о том как найти и обучить собственного менеджера знаний.

https://github.com/docops-hq/conf/blob/master/knowledgeconf/19/knowledge-manger-6-10.md
источник
DocOps
Применение практик Тиаго Форте для управления своими знаниями.

Огненный доклад на #knowledgeconf2019 от Андрея Александрова про то, как читать книги и статьи like a boss и наполнять собственную базу знаний.

Конспект: https://github.com/docops-hq/conf/blob/master/knowledgeconf/19/tiago-forte-practices.md
источник
DocOps
Добро пожаловать на борт: вводим в строй новых разработчиков

Глеб Декайло рассказал на #knowledgeconf2019 про то, как в Badoo вводят в команду новых сотрудников.

За конспект спасибо Екатерине Носковой! https://github.com/docops-hq/conf/blob/master/knowledgeconf/19/badoo-new-developers-onboarding.md
источник
DocOps
How to Create Compelling Multimedia Documentation.

Alexandra White из Google рассказывает, как сделать документацию в форме видео и вебинаров. А ещё — когда её делать не нужно.
Конспект: https://github.com/docops-hq/conf/blob/master/knowledgeconf/19/multimedia-documentation.md

#knowledgeconf2019
источник
DocOps
Как я 15 лет делал себе персональную Wiki для программиста

Григорий Петров придумал себе язык разметки для собственной вики-системы и пишет в нём заметки 15 лет. Я смотрел только предварительный прогон ещё в январе, и мне больше всего запомнилось вот что:

1. Я два года не писал на Ruby и ничего не помню
2. За два часа я перечитываю свой конспект по Ruby
3. Теперь я снова middle-разработчик на Ruby. PROFIT!

Спасибо Андрею Александрову (@aladmit_world) за конспект. https://github.com/docops-hq/conf/blob/master/knowledgeconf/19/xi-notes-for-developer.md

---

Trello — эффективная система управления знаниями для небольшой IT-команды

Не думали, что так можно? Вот и я удивлён. Роман Хорин рассказывает, как Trello работает в качестве базы знаний для команды дизайнеров в Atman Digital. Особенно хорошо такая база знаний помогает вводить новичков в команду.
Конспект: https://github.com/docops-hq/conf/blob/master/knowledgeconf/19/trello-kb.md

#knowledgeconf2019
источник
2019 April 28
DocOps
Я не знаю, как документировать БД. Если вы знаете, пожалуйста, расскажите об этом в @docsascode.
источник
DocOps
Переслано от Elena Baskakova
Привет! Поделитесь опытом, пожалуйста, как описывать все БД, если у тебя есть только IDE. С чего нужно начать, какие инструменты лучше использовать?
источник
2019 May 04
DocOps
​​В документации Grav CMS уже прочитанные главы помечаются галочкой.

❤️
источник
2019 May 10
DocOps
​​— Почему пользователи StackOverflow начинают вопросы со слова Say? Например:

Say “How to get data array for a numpy array with python"

— А потому что в документации такой пример.

За ссылку спасибо @factorized.
источник
2019 May 13
DocOps
​​Люблю опенсорс за дружелюбие и удобство.
источник
2019 May 21
DocOps
docops
Непрерывная локализация.

Слышали про принцип «сдвига влево» (shift left)? Непрерывная локализация (continuous localization) реализует этот принцип для перевода документации, интерфейса и других текстов.

Раньше было так: сначала разработка, потом пишем тексты, потом их переводим и наконец можем выпустить релиз. А теперь мы пишем тексты на этапе проектирования, а робот забирает их и отдаёт переводчикам. А готовые переводы сам коммитит обратно в ветку разработки. Тексты и переводы перестают блокировать релиз, и это уменьшает time to market всего продукта. Угадайте, как это влияет на прибыль и риски компании?

Техписатели из Xsolla рассказали на Хабре, как у них выстроен процесс непрерывной локализации. Они там переводят 20 проектов на 20 языков, сроки сжатые, всё автоматизировано. Xsolla крутые, спасибо им за статьи.

— 20 проектов, 20 языков, срок вчера
20 проектов, 20 языков, срок вчера. Часть 2
Техписатели из Xsolla опубликовали третью часть эпоса про непрерывную локализацию.

https://habr.com/ru/post/452580/
источник
2019 May 25
DocOps
Прямо сейчас идёт
Гипербатон от Яндекса.

В программе девять докладов про документацию и локализацию в IT.

Трансляция: https://events.yandex.ru/events/hyperbaton/25-may-2019/
источник
2019 May 27
DocOps
Сегодня и завтра идёт фестиваль «Российские интернет-технологии», #RITfest2019.

Как обычно, я постараюсь законспектировать десяток интересных докладов. Всё выложу на гитхаб: https://github.com/docops-hq/conf.
Если вы тоже на конференции и что-то записываете — присылайте пуллреквесты.

Если вы не на конференции — посмотрите открытую трансляцию из главного зала. Там собраны одни из самых популярных и важных докладов.
источник
DocOps
​​Продвижение опенсорс-проектов

Андрей Ситник из Злых Марсиан рассказывает на #RITfest2019 о продвижении опенсорс-проектов. Рассказывает очень чётко и по делу, я как технический писатель со многим согласен. Особенно понравилась инструкция, как написать три первых абзаца README.

Вот конспект: https://github.com/docops-hq/conf/blob/master/frontendconf/19/promoting-opensource.md
источник
DocOps
Столкновение мнений в двух докладах на #RITfest2019.

Представьте, что есть некая IT-компания. Эта компания хочет нанимать новых людей и оставаться привлекательной для уже работающих. На этом факты кончаются и начинаются предположения.

Предположительно, для найма сотрудников полезна репутация компании. Её можно заработать, например, если писать что-то полезное в техноблоги, на Хабр, Реддит и куда угодно ещё. Чтобы писать интересно и не ерунду, писать должны сами разработчики. Внезапно, разработчики не любят писать, они любят кодить. А ещё у пиарщика есть KPI на статьи, но нет власти, чтобы поставить разработчику дедлайн.

Как сделать так, чтобы разработчики писали статьи в блог компании?

Мария Круглова из KODE предлагает редактору сделать за разработчика всё, что только можно. Сформулировать тему, сделать из черновика или доклада готовый текст и вручить его разработчику. Вот её собственное определение роли:

Ghostwriter — человек, влияющий на создание статьи с момента зарождения идеи, в течение всего процесса её написания и защиты, активный модератор статьи, корректор и психолог. Его задача — сформировать у разработчика уверенность, что он сам написал статью.

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

Конспекты:
— Профессия «Ghostwriter», или Учим программистов писать статьи, Мария Круглова, KODE.
Пишем не только код, но и статьи: как помочь разработчику стать техноавтором, Антонина Татчук, Авито.
источник
DocOps
Как наполнить статьями техноблог компании?
Анонимный опрос
6%
Одинокий воин: освоить предметную область, писать статьи самостоятельно.
17%
Ghostwriter: писать статьи из черновиков разработчиков, публиковать под их именем.
71%
Фасилитатор: поддерживать тех, кто хочет писать статьи. Помогать редактурой, дизайном и пиаром.
6%
Начальник: поставить разработчикам KPI, пусть пишут по статье в квартал.
Проголосовало: 249
источник
2019 May 28
DocOps
​​Blameless environment: никто не должен писать качественный код

Продолжаем #RITfest2019. Кто хоть раз работал на плохой работе? Там где код плохой, и процессы плохие, и клиенты плохие, и вообще всё плохо? Кто был виноват в том, что всё так плохо?

Никита Соболев из wemake.services считает, что никто не виноват, а искать виноватых вообще вредно. Гораздо лучше исправлять ошибки на системном уровне и развиваться. Конечно, об этом просто говорить и сложно сделать. Никита, по его словам, выстроил в своей компании систему, в которой никто не виноват. В докладе он последовательно рассказывает о принципах, на которых строится такая система.

Если вы ещё не слушали ни одного доклада Никиты и не знаете про внутреннюю кухню wemake.services, я особенно рекомендую вам прочитать конспект или послушать доклад. Либо вам это очень понравится, либо вы будете дико возмущены.

Конспект: https://github.com/docops-hq/conf/blob/master/qualityconf/19/blameless.md

Сегодня доклад ещё можно посмотреть в трансляции, но скоро ссылка перестанет работать: https://youtu.be/V95bBGB-89Y?t=8561
источник
DocOps
Фестиваль РИТ продолжается, есть открытая трансляция второго дня: https://www.youtube.com/watch?v=a5kq-Yk28po
источник