Как стать автором
Обновить
31
0
Светлана Новикова @nerazzgadannaya

Технический писатель

Отправить сообщение

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

Уровень сложностиСредний
Время на прочтение10 мин
Количество просмотров716

Привет, Хабр! На связи программный комитет FrontendConf. Расскажем, как мы составляем программу нашей конференции и боремся за её актуальность — проводим исследования и общаемся с аудиторией.

FrontendConf = доклады + общение + опыт

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

Читать далее

Выстраиваем понятный онбординг: кейс команды тестирования из Яндекс Диска

Уровень сложностиПростой
Время на прочтение8 мин
Количество просмотров3.9K

Привет, Хабр! Меня зовут Антон Морозов, я инженер по тестированию в Яндекс 360. Я работаю над мобильным Яндекс Диском — это проект с тысячами тест-кейсов, который развивается уже тринадцатый год. 

Погружение в продукт и новую команду — непростая задача для новичка, но нам удалось выстроить безболезненную адаптацию. В статье поделюсь практиками в команде QA, которые помогли нам за последние четыре года успешно адаптировать новичков (с оттоком 0% за 4 года)

Читать далее

Управление документацией в растущей компании: DocFX + Gitea + «Этос»

Уровень сложностиПростой
Время на прочтение6 мин
Количество просмотров3.8K

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

Читать далее

От каждого по способностям. Как мне удалось прокачать инженерную культуру своей команды, не будучи тимлидом

Время на прочтение7 мин
Количество просмотров5.3K

Привет, Хабр! Меня зовут Кирилл Веркин, я Senior QA в СберМаркете. Эта статья о том, как за 1,5 года моя команда прокачала уровень инженерной культуры с нуля до самого высокого среднего балла в компании среди 105 команд. 

(Да, у нас есть уровни инженерной культуры!) Хочу рассказать, как мы их оцениваем и повышаем, почему это круто бустит развитие и как соревновательный аспект делает жизнь инженера гораздо интереснее. А ещё это история о том, как у меня получилось повлиять на командный результат будучи тестировщиком — на заметку тем, кто хочет не только расти сам, но и «менять мир».

Читать далее

СТОИКИ, visibility, ИПР и другие «витамины роста». 9+ ключевых советов про карьеру от техписов

Уровень сложностиСредний
Время на прочтение3 мин
Количество просмотров1.8K
На прошлой неделе мы в «Лаборатории Касперского» провели онлайн-митап, в рамках которого спикеры из различных компаний рассмотрели карьеру технического писателя как со стороны самого сотрудника (профессиональное развитие, выход на повышение, шифтинг в смежную специальность), так и со стороны нанимающих менеджеров (как найти стажера, как грамотно сформулировать требования к кандидату, как выстроить систему адаптации и что делать, если команда резко увеличилась).

image

Здесь в посте — краткая выжимка эфира в девяти ключевых тезисах, собранных из докладов всех спикеров. Если же вам интересно послушать полные выступления, а также ответы на волнующие зрителей (и, скорее всего, вас тоже) вопросы, посмотрите запись митапа по этой ссылке или в виджете ниже. Тем более что часть тезисов о развитии, повышении и структурных изменениях в команде будет применима не только к разработке документации, но и к другим сферам.
Читать дальше →

Как создать базу знаний, чтобы она стала «интеллектуальным активом» компании

Время на прочтение6 мин
Количество просмотров50K
Создавая базу знаний, каждый преследует свои цели и решает свои проектные задачи, использует свои инструменты и программные средства. Однако для чего бы и с помощью чего бы не создавалась база знаний, она обязательно должна приносить компании максимальную пользу. Как этого добиться?

В сентябре 2020 года я выступила спикером IV-й конференции «Управление корпоративными знаниями», проходившей в рамках недели корпоративного обучения. Мой мастер-класс «Как создать корпоративную базу знаний, чтобы она стала «интеллектуальным активом» компании» заинтересовал собравшихся, и я решила сделать из материалов выступления статью. Буду рада если текст поможет вам в работе. Буду рада, если кто-то из вас захочет в комментариях обсудить этот пост.

Источник
Читать дальше →

DocOps на Flow 2022

Время на прочтение4 мин
Количество просмотров4K


29-30 ноября прошла конференция для аналитиков FlowConf 2022. Основная особенность конференции — ее ориентация на конкретные практические рецепты. Одним из направлений, которое содержит много таких рецептов, стал Docs As Code или, в более широком смысле, DocOps в работе аналитика. В посте представляю обзор этого направления.

Читать дальше →

Делаем документацию здорового человека в Git на примере Docs Ozon

Время на прочтение7 мин
Количество просмотров36K

Казалось бы, с документацией всё просто — пишешь, публикуешь, поддерживаешь актуальность. Например, вот у нас в Ozon есть пользовательские инструкции на docs.ozon.ru: выглядит просто как текст на сайтике, что ж необычного-то в его размещении и в целом в работе техписателей? 

Если начать раскапывать, всплывёт ещё несколько вопросов:

• где хранить тексты и почему Confluence не подходит?

• как красиво оформить документацию с помощью статических генераторов сайтов

• зачем техписателям знать git и CI/CD?

• в какой момент пора искать разработчиков в команду и превращать документацию в платформу?

На связи Катя — руководитель отдела технических писателей в Ozon, и сегодня расскажу о платформе Docs Ozon изнутри.

Читать

Новая роль в команде: технический писатель

Время на прочтение5 мин
Количество просмотров14K

Привет! Я Катя, руководитель группы технических писателей в Ozon. Сейчас нас уже 9 человек и целая платформа документации, но коллеги всё ещё не всегда понимают, чем мы занимаемся ​:)

Из непонимания появляются запросы вида: “Хотим себе собственного техписателя в команду, но не знаем, чем именно он будет заниматься”. В итоге команда подстраивается под тренды и заводит себе документацию, но через пару месяцев оказывается, что доку не читают, а техписатель плавно превратился в аналитика.  

Поэтому пришло время делиться опытом и рассказывать о каких-то концептуальных штуках ​:)

Читать далее

Как мы улучшали процесс загрузки товаров на AliExpress.ru: машинное обучение, проблемы и решения

Время на прочтение7 мин
Количество просмотров4.8K

Всем привет! Меня зовут Нина, я работаю в команде платформы для продавцов  AliExpress. Сегодня я расскажу о том, как совместно с коллегами из команды Knowledge Engineering мы адаптировали систему для загрузки товаров, чтобы всё работало в пару кликов. Поехали!

Читать далее

5 000 000 строк кода, 500 репозиториев: зачем мы адаптировали приложение AliExpress для Рунета

Время на прочтение7 мин
Количество просмотров19K

Привет, Хабр! Мы продолжаем рассказывать о развитии «AliExpress Россия» (об истории этого проекта можно почитать здесь), и сегодня речь пойдёт о том, почему нам понадобилось сделать версию мобильного приложения маркетплейса для Рунета, чем китайские интерфейсы отличаются от европейских и как адаптировать приложение на пять миллионов строк кода под локальный рынок на лету. 

Читать далее

Свежий фиксы починить работает почти помочь герой карма много: как мы исправили проблемы с логином на AliExpress

Время на прочтение5 мин
Количество просмотров16K

Мы запустили блог на «Хабре» совсем недавно, и в комментариях к первой же статье было много вопросов о том, когда и как мы планируем устранять проблему с логином на сервисах AliExpress. И сегодня я расскажу, что вообще пошло не так, как мы чинили баг(и), с чем уже удалось справиться, а что будет улучшено в будущем.

Читать далее

Как мы превратили задание для найма тестировщиков в интерактив для конференции и читателей «Хабра»

Время на прочтение5 мин
Количество просмотров3.9K

Месяц назад мы приняли участие в конференции SQA Days. Наши эксперты выступили с докладом (вот презентация, ждите подробную статью и видео выступления) и провели ряд активностей на стенде. Сегодня мы хотим рассказать об одной из них – и интересна она тем, что по факту это задание, которое в «AliExpress Россия» используется на собеседования тестировщиков.

В этом материале мы расскажем о предыстории появления тестового задания, его эволюции и дадим возможность всем желающим проверить свои силы в поисках багов.

Читать далее

Сюда Разработка Подлинная Java: как работает AliExpress после переноса разработки в Россию

Время на прочтение6 мин
Количество просмотров57K


Привет, Хабр! Меня зовут Анатолий Орлов, и я технический директор AliExpress Россия. Сервис доступен русскоязычным пользователям уже 11 лет, при этом офис компании в Москве открылся только пять лет назад, а локальная команда разработки появилась лишь в прошлом году. Ее главная задача – адаптировать площадку, изначально заточенную на китайский лад, к реалиям Рунета и сделать ее понятнее и проще для русскоязычных пользователей.

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

Asciidoc для подготовки сложной документации

Время на прочтение3 мин
Количество просмотров17K

image


В заголовке использовано слово сложной, под которым можно понимать все, что угодно. Утверждение о том, что 2 * 2 = 4, если вдуматься, тоже очень не просто. Но в данном случае всё банальнее. Речь идёт о ЕСКД, ГОСТ, ОСТ и тому подобных скучных терминах, отягчаемых бюрократической процедурой согласования.


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


Сразу решили, что попробуем сделать документацию актуальной, т.е. обойтись без покраски травы в зелёный цвет. И сразу решили, что это будет Asciidoc. Почему? Потому что из текстовых языков разметки для подготовки документации он наиболее функциональный, а разворачивать неповоротливые DITA и Docbook не хотелось.


Пройдя определённую боль, мы с коллегами решили ей поделиться.

Читать дальше →

Что почитать, чтобы писать нормально

Время на прочтение5 мин
Количество просмотров12K
damn-hard-writing

В прошлых выпусках мы рассказывали почему бренды должны делать контент, а не втупую пропагандировать свои продукты. Теперь поговорим о том, как писать о продукте. Сегодня мы поделимся полезными ссылками, чтобы вы никогда не писали как амёба.
Читать дальше →

Лучшие школы по копирайтингу, редактированию, писательскому мастерству

Время на прочтение24 мин
Количество просмотров45K

Обзорная статья по школам и другим обучающим ресурсам по копирайтингу, редактуре, писательскому мастерству.
Читать дальше →

Какая бывает документация

Время на прочтение24 мин
Количество просмотров48K

Когда мы говорим о тестировании документации, то обычно подразумеваем тестирование требований, ТЗ. И это тестирование на полносту, однозначность и прочая. Смотрим, как новый функционал будет коррелировать со старым, не будет ли проблем. Заранее продумываем свои тесты, обсуждаем реализацию...

Однако помимо ТЗ есть еще куча другой документации, которую тоже стоит проверить. Как минимум вычитать, нет ли ошибок. Давайте посмотрим, какая бывает документация:

Читать далее

Docs as Code. Часть 1: автоматизируем обновление

Время на прочтение8 мин
Количество просмотров11K


В больших проектах, состоящих из десятков и сотен взаимодействующих сервисов, всё чаще становится обязательным подход к документации как к коду — docs as code.


Я покажу, как можно применять эту философию в реалиях classified-сервиса, а точнее, начну с первого этапа её внедрения: автоматизации обновления данных в документации.

Читать дальше →

Docs as Code. Часть 2: получаем документацию из кода

Время на прочтение10 мин
Количество просмотров13K


Продолжаем рассказывать о применении на практике принципа работы с документацией как с кодом. В этот раз разберём получение спецификации Swagger напрямую из комментариев к коду API. В статье рассматривается роль технического писателя в процессе адаптации команды к использованию нового инструмента, а также приводятся конкретные инструкции по применению swagger-php в реальном проекте.
Читать дальше →

Информация

В рейтинге
Не участвует
Откуда
Самара, Самарская обл., Россия
Работает в
Дата рождения
Зарегистрирована
Активность