Pull to refresh
17
0
Теодора Малевинская @theos_deus

Head of Technical Writing at Tinkoff

Send message

Инженерия устойчивости — основной инструмент выживания вашей организации

Reading time12 min
Views2.6K

Привет! Меня зовут Сергей Реусин и последние пять лет я занимаюсь эксплуатацией production-систем с непрерывной практикой инцидент-менеджмента. Каждый день, сталкиваясь с аномалиями и проблемами, невольно спрашиваешь себя: «Почему это происходит? А главное — как с этим дальше жить?». Три нелегких года работы в Купере ( ex СберМаркет), где мне доверили строить культуру инцидент-менеджмента, помогли мне утвердиться во мнении и подходах, которые действительно помогают справляться с подобными вызовами. О них и поговорим!

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

1. Определим, ради чего вся эта «доступность» и «стабильность» нужна

2. Попробуем устаканить терминологию, чтобы говорить на одном языке

3. Посмотрим на понятие системы с позиции устойчивости

4. Обратимся к историческому опыту

5. Изучим возможные паттерны отказов систем и способы их митигации

6. Визуализируем модель восприятия аномалий

7. Познакомимся с ключевыми личностями в подходах Resilience Engineering

Читать далее
Total votes 22: ↑21 and ↓1+24
Comments2

Профессия: технический писатель

Level of difficultyMedium
Reading time11 min
Views15K

Хотела начать текст с шутки про то, что раз инструкции никто не читает, то и писать их не обязательно. Однако 14 лет работы в IT-сфере доказывают, что это всё же довольно глупая шутка. В современных компаниях (не только в IT, но и особенно в IT!) на документации завязаны практически все процессы от проектирования ПО и ведения бэклога до эксплуатации и поддержки пользователей. Люди со стороны часто не догадываются, что в командах кроме суровых разработчиков, дотошных тестировщиков, внимательных сисадминов, осторожных безопасников и продвинутых девопсов трудятся технические писатели. Как правило, они одновременно суровые, дотошные, внимательные, осторожные и продвинутые, потому что именно на них лежит ответственность как за внутреннюю документацию, так и за корректные, грамотные, лаконичные и точные инструкции для пользователей. И писать желательно без девяти прилагательных в одном предложении, как строчкой выше 🙂

Сегодня поговорим об этих ребятах, о профессии, о людях в ней и о том, стоит ли войти в айти именно через вакансию техписа?

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

Читать далее
Total votes 28: ↑25 and ↓3+39
Comments25

Docs as Code для художественной литературы. Делаем творческий сайт ребенка с помощью MkDocs

Level of difficultyEasy
Reading time13 min
Views8.6K


Docs as Сode — подход к работе с текстами, подразумевающий написание текста как кода:


  • в простом текстовом редакторе или IDE;
  • с использованием системы контроля версий;
  • с CI / CD / Code Review.

В настоящее время Docs as Code широко применяется при работе с технической документацией, давая техническим писателям и проектным командам массу удобств и преимуществ.


Но что если пойти дальше, попробовать такой подход не с техническими, а с художественными текстами? Что если автор — не технарь и не айтишник? Просто юный начинающий писатель, который пробует писать прозу и стихи ручкой на бумаге, и надеется познакомить широкую публику со своим творчеством?


В этой статье я расскажу о таком эксперименте (забегая вперед, удачном). Моей дочери 11 лет, она пишет сказки, стихи и рассказы. Чтобы поддержать ее увлечение, я помог ей создать литературный сайт, используя подход Docs as Code. Она успешно освоила основы Markdown и Git. Сейчас она самостоятельно публикует новые произведения и обновляет новости на своем сайте https://lib-beliakova.github.io/.

Читать дальше →
Total votes 44: ↑44 and ↓0+44
Comments17

Как создать внутреннюю базу знаний для большой IT-компании. Из хаоса в гиперспейсы

Level of difficultyMedium
Reading time7 min
Views28K

Когда на вопрос «Что за фича?»‎ сказали: «Посмотри в Confluence!»‎

Привет! Меня зовут Таня Дудо, я менеджер продуктовых знаний в Selectel. В тексте расскажу, как решили создать внутреннюю базу знаний о продуктах и процессах для более 800 человек. Опишу, как к этому пришли, кропотливо выуживали важную доку из массива данных и придумали решение — гиперспейсы.

Мы развиваем базу знаний на Confluence, но подходы и решения, описанные в тексте, могут быть полезны в работе с другими площадками. Мемы и уроки из опыта — под катом.
Читать дальше →
Total votes 55: ↑53 and ↓2+69
Comments15

Как мы заняли первое место в хакатоне ВК «Машинное обучение на графах», где не было графов

Reading time7 min
Views4.7K

В сентябре 2022 проходил хакатон «Машинное обучение на графах» от компании ВК на платформе «Цифровой прорыв». В хакатоне участвовала команда Лаборатории машинного обучения Альфа-Банка: Александр Сенин, Георгий Смирнов и Валерий Смирнов.

Мы заняли 1 место в хакатоне, далее подробно расскажем, как нам удалось победить.

Читать далее
Total votes 26: ↑24 and ↓2+23
Comments4

Как улучшить английский в документации

Reading time11 min
Views36K

Я работаю техническим писателем в компании documentat.io. Мы занимаемся заказной разработкой технической документации, в том числе на английском языке. Иногда я дорабатываю уже существующие документы или спецификации к API на английском. Как правило, такие документы написаны русскоязычными разработчиками, которые неплохо владеют английским. И всё же они часто допускают характерные грамматические, пунктуационные и стилистические ошибки.

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

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

Читать далее
Total votes 81: ↑80 and ↓1+97
Comments27

Realtime-матчинг: находим матчи за считанные минуты вместо 24 часов

Reading time11 min
Views12K

Задача матчинга в последнее время набирает всё большую популярность и используется во многих сферах: банки матчат транзакции, маркетплейсы – товары, а Google и другие IT-гиганты проводят соревнования по решению таких задач на Kaggle.

Для маркетплейса матчинг – очень важный процесс, который решает сразу несколько задач:

1. При поисковом ранжировании из множества товаров показывать сначала самые выгодные предложения.

2. Объединять множество товаров в одну сущность и показывать предложения одного и того же товара от разных селлеров.

3. Понимать, как предложения селлеров выглядят относительно друг друга, и поощрять их дополнительными бонусами.

Сегодня мы поговорим не только о решении этой задачи, но и о способах её реализации: offline (batch) vs online (realtime). Также обсудим, как и зачем переходить от первого ко второму.

Читать далее
Total votes 42: ↑42 and ↓0+42
Comments8

Цифровая трансформация на основе NFT

Reading time7 min
Views1.6K

NFT — это объект данных в блокчейне. Алексей Муравьев, блокчейн-инженер Института Коллективного Разума, рассказал об эволюции NFT и его применениях для бизнеса.

Находясь в крипто-индустрии с 2016 года на позиции блокчейн-инженера, я только в 2020 году впервые услышал термин NFT в СМИ. Им обозначалось право владения цифровым изображением, которое продавалось на аукционе.

После исследования вопроса по существу для меня, как для инженера, стало всё понятно. Оказалось, я уже несколько лет проектирую и разрабатываю сложные NFT-комплексы для сообществ и бизнеса, но не знаю об этом. Да будет так!

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

«Кто-то за всё заплатит», — подумал я тогда, так и получилось.

Читать далее
Total votes 13: ↑10 and ↓3+8
Comments4

Летопись проекта: зачем нужна инфраструктурная документация

Reading time6 min
Views5.1K


Документация нужна. Точка. На этом всё, расходимся.

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

Документация — это про знания. Знания о продукте, системе, процессах. Важно, где и как хранятся эти знания, кто может получить к ним доступ, легко ли их найти, доступны ли они для понимания.

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

И наконец, документация — это про коммуникацию. Про передачу информации между людьми, отделами, компаниями и т.д. Например, документация API позволяет заменить коммуникацию между группами разработчиков, пользовательская документация — это способ коммуникации между компанией-разработчиком и ее клиентами, инструкции для новых сотрудников — это замена общения наставника и новичка.
Читать дальше →
Total votes 14: ↑14 and ↓0+14
Comments3

Туда — не знаю куда и как. Что делать, если вашей компании нужно поменять основной инструментарий

Reading time11 min
Views3.5K
Ситуация, когда компания враз лишается привычных сервисов и нужно срочно менять технический функционал, нынче крайне актуальна. Причем не поймешь, как проще: когда «партия сказала “надо”» и «срок — вчера» или когда цейтнота нет, но зато нужно доказать руководителю необходимость замены и уговорить всех участников миграции.

image

Меня зовут Алла Царьгородская, я — руководитель группы разработки технической документации в «Лаборатории Касперского». Сегодня расскажу, что сделала наша команда, когда пришла пора мигрировать всю документацию для внутренних сервисов компании, и как нам помог подход Джона Коттера.

Статья будет полезна тем, кто либо оказался в такой же ситуации, как наша команда несколько лет назад, либо хочет понимать основные теоретические подходы и best practices, если придется с чем-то таким столкнуться. А в текущей ситуации с этим столкнутся практически все в IT-индустрии…
Читать дальше →
Total votes 10: ↑8 and ↓2+9
Comments1

Information

Rating
Does not participate
Location
Москва, Москва и Московская обл., Россия
Works in
Registered
Activity

Specialization

Technical Writer, Knowledge manager
Lead
Git
Golang
Markdown
Static Site Generators