Обновить
7.81

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

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

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

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

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

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 мин
Количество просмотров826

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

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

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

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

Читать далее

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

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

Внутри отрасли мы уже привыкли к тому, что ИТ — это спектр профессий вокруг кода, и в ИТ-компаниях работают не только разработчики, админы или 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.

Читать далее

Комплект компилятора Microsoft C/C++ 7.0 с Windows SDK с документацией весил 18 кг и занимал коробку длиной 60 см

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


До появления интернета или начала его широкого применения во всем мире программное обеспечение для разработчиков включало множество печатных руководств и инструкций от производителей, помимо простого комплекта дискет или компакт-дисков и ссылок, где можно скачать нужные руководства. Тогда была эра печатной документации на тысячах страниц, что приводило к очень «тяжёлым» выпускам программного обеспечения. Команда разработчиков документации для Windows решила спросить архивариуса Microsoft Эми Стивенсон о том, какой программный продукт был самым большим.
Читать дальше →

Визуализация архитектуры с помощью C4 модели и PlantUML

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

Приветствую, коллеги. Меня зовут Мстислав, я являюсь руководителем Python практики в Usetech. В этой статье я раскрою нюансы работы с PlantUML и C4 моделью. Вся информация является выжимкой из нашего ежедневного опыта. Также необходимо упомянуть, что на эту тему я проводил воркшоп на TechLeadConf 2022, так что при желании, вы всегда можете найти видео.

Читать далее

Команда GitHub представила нативную поддержку математических выражений в md-файлах

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

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

Читать далее

В GitHub добавили поддержку диаграмм Mermaid

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

В GitHub появилась возможность добавлять в md-файлы динамические диаграммы с помощью генератора Mermaid. До этого диаграммы вставлялись в виде изображений или «рисовались» с помощью символов из ASCII-таблицы. Теперь же полноценную поддержку схем добавили в синтаксис разметки Markdown.

Читать далее

Причиной экстренной посадки A330 в Тайбэе стал отказ компьютеров

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

14 июня 2020 года самолет Airbus A330-300 китайской авиакомпании China Airlines совершил аварийную посадку в аэропорту Тайбэя,  остановившись за 10 метров до конца взлетно-посадочной полосы.

Накануне Совет по авиационной безопасности Тайваня завершил расследование происшествия и опубликовал документацию, из которой стало известно, что экстренное торможение самолета произошло из-за отказа бортового компьютера во время посадки.

По сообщениям источника, главной причиной стал отказ третьего бортового компьютера из-за ошибки в системе автоматического руления COM/MON: во время посадки пилот взял управление самолета на себя, в то время как бортовые компьютеры должны были переключиться в вспомогательный режим. В результате сбоя компьютеры перестали обмениваться сигналами и отключились поочередно.

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

Читать далее

SpaceX обвинила Amazon в злоупотреблении вниманием государственного регулятора

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

Amazon пытается воспрепятствовать срокам запуска Starlink, чтобы наверстать темпы разработки собственного проекта спутниковой группировки Kuiper, заявила SpaceX в обращении к Федеральной комиссии связи США (FCC).

“Чтобы сократить разрыв между компаниями, Amazon решили тормозить процесс, отправляя жалобы и иски в различные органы власти. Они утверждают, что наша программа спутникового интернета недостаточно детальна, на что мы предоставили им полный отчет размещения конфигураций SpaceX на орбите, на что в Amazon заявили, что наши документы обличают секретную информацию. 

В июле 2020 года Федеральная комиссия связи потребовала, чтобы Amazon предоставили отчет по технике безопасности в случае образования космического мусора, однако 400 дней спустя компания так и не отправила никаких отчетов. Тем не менее с начала текущего года от Amazon поступают жалобы на SpaceX в среднем каждые 16 дней”, — пишут представители SpaceX.

Читать далее

Google, Microsoft и другие создали инициативу для продолжения проекта Mozilla Developer Network

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

Компания Mozilla при поддержке Google, Microsoft и других компаний учредила организацию Open Web Docs, нацеленную на продолжение поддержания проекта MDN (Mozilla Developer Network) как единой площадки для публикации документации для web-разработчиков, охватывающей поддерживаемые в современных браузерах технологии, включая JavaScript, CSS, HTML и различные Web API. 

Читать далее

Mozilla пытается переложить на сообщество поддержку проекта MDN после массового увольнения сотрудников

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

Разработчик популярного браузера Firefox, компания Mozilla, пытается переложить на сообщество поддержку проекта Mozilla Developer Network (MDN) — единой площадки публикации документации для веб-разработчиков. Для этих целей компания Mozilla учредила организацию Open Web Docs.

MDN описывает типы поддерживаемых в современных браузерах технологий, включая JavaScript, CSS, HTML и различные Web API. Проект оказался на грани закрытия по вине самой Mozilla.

Читать далее

Академия Гипербатона — для технических писателей, редакторов и переводчиков

Время на прочтение2 мин
Количество просмотров5K
С 1 по 30 апреля в Москве, Санкт-Петербурге и Екатеринбурге пройдёт четвёртая Академия Гипербатона. Это образовательный курс Яндекса для технических писателей, редакторов, а в этом году — ещё и для переводчиков. Зарегистрироваться на курс можно до понедельника следующей недели (9 марта) включительно. Для регистрации необходимо рассказать о себе и выполнить небольшое тестовое задание. Занятия будут проходить в офисах Яндекса по вечерам будних дней, 2–3 раза в неделю. Ещё несколько часов в неделю займут домашние задания.
Читать дальше →

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

2