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

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

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

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

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

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

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

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

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

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

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

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

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

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