Инженерная зрелость. Исследование практик и триггеров

Почему одни команды релизят предсказуемо и без героизма, а другие тушат пожары на продакшене каждую неделю? Мы решили выяснить, какие инженерные практики превращают разработку в систему с понятными процессами и предсказуемыми результатами. Исследование 100+ респондентов.

https://habr.com/ru/articles/963202/

#инженерная_зрелость #процессы_разработки #devops #cicd #тестирование #документация #инженерная_культура #исследование

Как автоматизировать подготовку отчетности в Word: макросы на практике

Всем привет! Я студент-работяга, который увлекается аналитикой в многогранном мире ИБ. Почти каждая задача (как аналитика, так и студента) так или иначе заканчивается подготовкой каких-то материалов: для аналитика — отчета, для студента — курсовой работы. В процессе подготовки этих материалов неизбежно сталкиваешься с рутиной из однообразных кликов (разметка текста, форматирование картинок и много другой скукоты). Однако справиться с ней можно, и сегодня я расскажу, как это сделать с помощью автоматизации в редакторе Word посредством VBA-макросов. Статья может быть полезна студентам и начинающим специалистам, но уверен, какие-то идеи пригодятся и тем, кто уже работает. Даже если вы не пользуетесь Microsoft Office, то все равно сможете почерпнуть для себя некоторые идеи, так как почти во всех пакетах есть поддержка языков программирования, например Basic в LibreOffice, Lua в пакете «МойОфис» или JavaScript в «Яндекс Документах». Кроме того, часть моих скриптов я выложил в открытый доступ. Когда пишут про автоматизацию в Microsoft Office, то в большинстве случаев имеют в виду Excel, однако я сломаю шаблон и расскажу вам про автоматизацию в Word, которую часто незаслуженно обходят стороной.

https://habr.com/ru/companies/pt/articles/961006/

#автоматизация #word #office_365 #макросы #надстройки #вайбкодинг #рутина #документация #отчетность #vba

Один Swagger вместо сотни страниц Confluence: как в Рунити навели порядок в API-документации

Привет, Хабр! На связи Маргарита Сорочинская, технический писатель отдела архитектуры в Рунити. Хочу рассказать, как мы в компании подошли к описанию API в Swagger — и почему решили перенести туда всё, что раньше жило в Confluence. А еще поделюсь с вами стартерпаком для описания API в Swagger, пошаговой инструкцией и всеми ссылками, чтобы для вас этот путь был уже более простым :) Навигация по тексту:

https://habr.com/ru/companies/runity/articles/961156/

#api #swagger #swaggerui #swaggertypescriptapi #confluence #git #gitlab #методы #документация #документирование_проектов

BDD: Как заставить тесты говорить на одном языке с бизнесом (и перестать платить за недопонимание)

Привет! Меня зовут Анатолий, я ведущий разработчик в ITFB Group , и сегодня я хочу рассказать о том, как можно превратить скучные тесты в главного специалиста по продукту. Знакомо: ваши JUnit-тесты проходят, CI/CD зелёный, все довольны. Но тут приходит бизнес-аналитик и спрашивает: "А этот сценарий проверяет, что будет, если клиент с рейтингом 700 запросит 10 миллионов?" Вы начинаете лихорадочно копаться в коде, пытаясь найти тот самый @Test... А что если бы ответ на этот вопрос лежал не в глубинах Java-кода, а в красивом, читаемом файле, который понятен всем — от тимлида до заказчика?

https://habr.com/ru/companies/itfb/articles/960972/

#itfb #java #camunda #springboot #тестирование #бизнесанализ #bdd #документация #cucumber #allure

Как мы с ИИ перезапустили документацию Bitrix Framework и сэкономили 400 часов

Привет! Меня зовут Марина Павлова, я технический писатель в отделе документации 1С-Битрикс. В этой статье я расскажу, как мы полностью переделали документацию по Bitrix Framework и как команде из двух человек удалось выпустить доку за 9 месяцев с помощью ИИ.

https://habr.com/ru/companies/bitrix/articles/959134/

#bitrix #framework #документация #bitrix_программирование #documentation #docsascode #docs_as_code #docs #ии #нейросети

Write. Review. Commit. Repeat. Как документируют в Postgres Professional

Как вы думаете, сколько человек документирует продукты в Postgres Professional? 50? 100? А вот и нет — всего десять. Рассказываем, как команде техписателей удается управлять сотнями файлов, почему их работа — это квест, и как они успевают контрибьютить в ванильный PostgreSQL.

https://habr.com/ru/companies/postgrespro/articles/924718/

#postgresql #документация #postgres #postgres_pro #техдокументация

ИИ для технической и пользовательской документации. Какие нейросети помогут

Любая человеческая деятельность, любой проект порождает информацию. Ей нужно делиться, но не всей. Желательно обработать поток данных, прежде чем предоставить его кому-то. На этом принципе построено любое обучение, вербальное и даже невербальное взаимодействие — тот, кто отправляет информацию, учитывает возможности и особенности того, кто её принимает.

https://habr.com/ru/companies/teamly/articles/957520/

#ai #teamly #искусственный_интеллект #техническая_документация #документация

Размышления о документации

Вряд ли найдётся кто-либо, кто в здравом уме и ясной памяти будет отрицать необходимость документации. Любой продукт имеет (или должен иметь) свою документацию. Как минимум – инструкцию о том, как этим продуктом пользоваться. Производители почти всегда указывают – « прежде чем начать пользоваться нашим продуктом, внимательно ознакомьтесь с инструкцией ». Но дело почти никогда не ограничивается инструкцией пользователя. Производители также составляют и другую документацию – техническую, эксплуатационную. Но ЧТО же должен создавать автор документации? Что должна в себя включать документация, когда, на каком этапе и в каком объёме она должна создаваться, ЧТО она должна содержать, когда, кому и при каких обстоятельствах она может потребоваться? В данной статье мы и поразмышляем об этом... Читать статью

https://habr.com/ru/articles/958076/

#документирование #документация #документация_проекта #документирование_проектов #управление_проектом #управление_продуктом #техническая_документация #технический_писатель

Документирование архитектуры

Каждый архитектор сталкивается с вечной дилеммой: как правильно документировать архитектуру, чтобы она была понятна людям и одновременно пригодна для автоматизации? Сегодня разберем три основных подхода и выясним, когда какой использовать. Современная документация архитектуры должна решать множество задач одновременно. Она должна быть понятна разработчикам, архитекторам и бизнесу, поддерживать версионирование, интегрироваться в CI/CD процессы и оставаться актуальной.

https://habr.com/ru/articles/957348/

#архитектура #документация #документирование

ГОСТ ЕСКД для документирования информационных систем – зло или благо?

В этой статье мне хотелось бы порассуждать о такой области ИТ-бизнеса, как документирование ИТ-продуктов – автоматизированных/информационных систем (АС, ИС, АИС и т.п.), а также о том, как применение стандартов отражается на качестве разрабатываемой документации и её восприятии целевой аудиторией читателей. Ни один хороший (т.е. качественный – как в части организации процесса, так и в части ожидаемого результата) проект по созданию (и внедрению) ИТ-продукта не может обойтись без создания документации. Документация позволяет формализовать и зафиксировать различные аспекты, касающиеся ИТ-проекта и создаваемого в его рамках продукта. Но при этом неизбежно возникает вопрос – а как создать эту документацию? Читать статью

https://habr.com/ru/articles/956880/

#гост #документирование_систем #документация #мнение