Как стать автором
Обновить
71.25

Подготовка технической документации *

Всё о деятельности технических писателей

Сначала показывать
Порог рейтинга

Митап по технической документации. Битва подходов HFLabs и «Контура»

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

Как вести документацию по продуктам так, чтобы не утонуть в бесконечных обновлениях? Какие плюсы и минусы есть у разных подходов? Вместе с экспертами из «Контура» обсудим, когда нужна автоматизация, а когда можно обойтись без нее. 

Встречаемся 27 марта в 18.00 в Zoom. Чтобы принять участие, зарегистрируйтесь по ссылке.

Читать далее

Новости

Релиз Nextra 4 x App Router: что нового?

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

Nextra — это мощная библиотека для рендеринга MDX-файлов с использованием Next.js. Она упрощает создание сайтов-документаций, блогов и других проектов с контентом, предоставляя готовые темы, удобные маршруты и поддержку серверных и клиентских компонентов. Благодаря своей гибкости и продвинутым возможностям, Nextra подходит как для небольших личных проектов, так и для крупных корпоративных сайтов.

Читать далее

«Каждый год 31 декабря...» или вышла новая LTS версия XWiki – 16.10.12

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

На протяжении многих лет в самом конце декабря обновляется LTS версия XWiki – open source аналога Confluence (по мнению разработчиков).

Этот год не стал исключением. Поэтому предлагаю кратко рассмотреть нововведения в XWiki 16.10.2 по сравнению c предшествующей LTS версией – 15.10.15.

Читать далее

С новым релизом в новый год: блочный редактор и другие улучшения в апдейте Документерры

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

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

Узнать больше

R-Style Softlab открыла исследовательскую лабораторию по тестированию ПО и оборудования

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

R‑Style Softlab, компания‑разработчик ПО для финансовой сферы и системный интегратор, входящий в группу Россельхозбанка, открыла исследовательскую лабораторию по тестированию ПО и оборудования.

R‑Style Softlab системно подходит к переводу собственной и клиентской инфраструктуры на российские решения, максимально используя возможности развития российских технологий. Партнерский хаб компании насчитывает более 100 решений производителей в направлениях системное и базовое ПО.

Для оценки соответствия поставляемого оборудования или ПО требованиям заказчика, а также для оценки уровня технической поддержки вендоров, была создана исследовательская лаборатория РСХБ‑R-Style Softlab, где решения проверяются на тестовых стендах и в рабочей нагрузке.

 

Читать далее

Какая роль аналитика в кросс-командной разработке

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

23 октября пройдет System Analysis Meetup в офисе AGIMA на Петровке.

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

Что вас ждет:

- Доклады экспертов из МТС Premium и AGIMA. Поговорим о лучших практиках в работе с кросс-командой в разработке, о систематизации и многом другом.

- Квест. Подготовим для вас испытания — заковыристые задачки, сложные и веселые вопросы и конечно, непростой маршрут.

- Экскурсия. Прогуляемся по офису, потрогаем раритетные стены из кирпича и представим, как в этом месте создавал свой шедевр «Вишневый сад» Антон Павлович Чехов. 

- Конкурс «Мастер-печати». Узнаем, как быстро вы печатаете и посоревнуетесь с другими участниками митапа. Кстати, прошлый рекорд был 392 знака в минуту.

- Твоя игра. Вспомним, как это было в нулевые, когда попадался кот в мешке. Перенесемся в атмосферу и узнаем, кто же знает больше всего фактов из агентств о рынке диджитал. Готовьтесь к рейтингам за 300, статьям за 400 и багам на проде.

Еще будут напитки, угощения и классная атмосфера для живого общения и обмена опытом. Регистрация — по ссылке выше, мероприятие рассчитано для системных аналитиков, поэтому будет проведена модерация. Количество мест ограничено.

До встречи 23 октября, 18:00!

Читать далее

Techdoc Meetup #5

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

Приглашаем вас на Techdoc Meetup #5, который пройдёт 3 октября. Поговорим про работу в режиме аврала, автопроверки по внутренним гайдам и синергию UX-редактора со смежными ролями. По традиции завершит митап круглый стол, на этот раз об UX-исследованиях.

Читать далее

Сопровождающий man-pages для Linux объявил об окончании работы над проектом из-за финансовых проблем

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

6 сентября 2024 года разработчик и сопровождающий man-pages для Linux Алехандро Коломар (Alejandro Colomar) объявил об окончании работы над проектом по техническому обслуживанию и поддержке man-страниц на неопределённое время из-за финансовых проблем.

Читать далее

Techdoc Meetup #4

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

Приглашаем вас на Techdoc Meetup #4, который пройдёт 18 апреля в офлайн и онлайн фарматах. Вас ждут четыре доклада: поговорим про ИИ, процессы и личные границы. Подведём итоги традиционным круглым столом. Митап будет полезен всем техническим писателям и не только.

Читать далее

Работа с требованиями в системном и бизнес-анализе. Обсудим лучшие кейсы, инструменты и практики на митапе AGIMA

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


Митап пройдет 27 марта в офисе AGIMA на Петровке. Эксперты из Альфа-Банка, X5Tech и отдела аналитики AGIMA расскажут об эффективных методах сбора требований, поделятся примерами работы с ними и объяснят, как провести ППО, чтобы все остались довольны.

Читать далее

Google начала «Сезон документации» с поддержкой проектов с открытым исходным кодом и улучшения их документации

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

Google объявила о начале «Сезона документации 2024» (Google Season of Docs 2024, GSoD) — инвестиционной программы, дополняющей проект «Лето кода», предоставляющей финансирование проектам с открытым исходным кодом для найма технических писателей и улучшения уровня документирования проектов.

Читать далее

В Роспатенте зарегистрировали шлем для космонавтов с повышенной защитой от падений

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

В базе Роспатента 12 января 2024 года появился документ, описывающий шлем, созданный в РКК «Энергия» (входит в Госкорпорацию «Роскосмос»). Согласно описанию, новое изобретение представляет собой модернизированный шлем космического скафандра для улучшенной защиты при падении на небезопасную поверхность — Луны или Марса. Автор изобретения — главный научный сотрудник «Энергии», специалист в области внекорабельной деятельности космонавтов Олег Цыганков.

Читать далее

Одно из конструкторских бюро «Росатома» начало использовать технологии AR и VR для согласования документации

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

Центральное конструкторское бюро машиностроения (ЦКБМ, входит в машиностроительный дивизион Госкорпорации «Росатом») рассказало об использовании технологий AR/VR при согласовании конструкторской документации нового оборудования. Документация посвящена разгрузочно‑загрузочной машине (РЗМ‑С), предназначенной для перегрузки ядерного топлива в многоцелевом исследовательском реакторе на быстрых нейтронах (МБИР), строящегося в Димитровграде.

Читать далее

Ближайшие события

Вышла система документирования Doxygen 1.10

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

25 декабря 2023 года вышла открытая система документирования Doxygen 1.10 со множеством исправлений и доработок. Исходный код проекта распространяется под лицензией GNU.

Читать далее

Tesla опубликовала техническую документацию спорткара Roadster

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

Tesla опубликовала руководства по использованию, техническому обслуживанию, ремонту, схемы и другие документы по электроспорткару Roadster. В том числе есть и научно-исследовательские работы, которые создавали сотрудники Tesla. Об этом объявил глава и основатель компании Илон Маск, документы доступны на сайте.

Читать далее

Федеральная комиссия по связи США получила от 20 операторов связи на официальный запрос невнятные отписки и спам

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

Федеральная комиссия по связи США (FCC) в ответ на официальный запрос от 20 операторов связи вместо конкретных планов по снижению робозвонков получила невнятные отписки и просто странные материалы, включая пустые листы, сканы тестовых страниц и непонятные, не по теме или даже случайные данные. Регулятор пригрозил этим компаниям блокировкой их сервисов за подобные отписки.

Читать далее

Приглашаем на Techdoc Meetup #2

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

28 сентября в Москве проводим Techdoc Meetup #2! Будут два увлекательных доклада, много острых вопросов и общение в рамках круглого стола. Поговорим про атрибуты технических писателей, обсудим стайлгайды.

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

Читать далее

Microsoft и Open Web Docs обновили документацию по PWA на портале MDN

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

Команда разработчиков Microsoft Edge совместно с сообществом Open Web Docs обновила документацию по созданию прогрессивных веб-приложений (Progressive Web App, PWA) на платформе MDN. Весь раздел переписали с нуля.

Читать далее

Приглашаем на Techdoc Meetup #1

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

Если не не знаешь, как написать, давай попробуем вместе!

Всем привет, меня зовут Катя и я руководитель отдела технических писателей в Ozon Tech.

Все мы хотим, чтобы документация была понятной и полезной, но не всегда мы знаем, как сделать её такой. Поэтому мы решили собраться с техписателями из X5 Tech и Тинькофф на небольшой камерный онлайн-митап — обсудить наболевшие вопросы и обменяться опытом.

Подключайся 5 июня на Techdoc Meetup #1

Читать далее

В ИТ через тексты: DevRel, технический писатель, маркетолог — митап в Нижнем Новгороде

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

Внутри отрасли мы уже привыкли к тому, что ИТ — это спектр профессий вокруг кода, и в ИТ-компаниях работают не только разработчики, админы или DevOps-инженеры. Вне ИТ по-прежнему жив стереотип о том, что без умения писать код найти себя в ИТ-мире не получится. Тем не менее, иногда достаточно умения хорошо писать! Мы с собратьями по перу решили собрать в родном Нижнем Новгороде открытую встречу для всех, кто дружит со словом и хочет понять, какие варианты есть для применения этого ценного навыка в ИТ-индустрии.

О каких профессиях будем говорить, ясно из заголовка публикации:

- про DevRel расскажет Ксения Романова, активист DevRelConf и организатор питерских DevRel-завтраков,

 тема доклада — «Кого, с кем и зачем связывают Developer Relations»;

- про техническое писательство поведает Николай Кочнев, инженер по документации компании ТЕКОМ,

тема доклада — «От пресс-релиза к release notes»;

- про маркетинг в ИТ-компаниях наблюдениями поделюсь я, Анастасия Распопина, маркетолог B2B-проектов в сфере СУБД, старший менеджер по коммуникациям в Postgres Professional,

тема доклада — «Реальный маркетинг виртуального продукта».

Продолжительность докладов 20-30 минут, вопросы к выступающим приветствуются.

Регистрация на Timepad: https://rostova-events.timepad.ru/event/2349782/

Место встречи — уютный Центр инноваций «РОСТ» компании Росбанк (Родионова 192/2).

Начало в 18:00, вход свободный, но количество мест ограничено.

Среди оффлайн-участников разыграем курс «Копирайтинг для продвижения проектов» в Академии Globus, записанный Анной Приваловой — PR-специалистом с многолетним стажем работы в IT, руководителем студии контента APWriting.

Читать далее
1