Фронтенд-ревью без боли: наш опыт перехода в GitLab

Привет! Я Вика, старший продуктовый дизайнер в

https://habr.com/ru/companies/cloud_ru/articles/974542/

#техническая_документация #фронтенд #дизайн #дизайн_интерфейсов #дизайнеры #gitlab #figma

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

GraphQL API — это мощно, но как его документировать, чтобы разработчики остались довольны? В этой статье — готовый план действий. Мы начнём со сравнения GraphQL и REST, затем покажем, как с помощью комментариев и примеров кода превратить схему в наглядное руководство. Вы узнаете, как улучшить GraphiQL Playground подсветкой синтаксиса и создать статический справочник, если Playground недоступен. В конце вас ждёт учебный репозиторий для тренировок на реальном API.

https://habr.com/ru/companies/flant/articles/971198/

#graphql #техническая_документация #техпис #graphql_api #playground #документирование #документирование_проектов #rest #rest_api #api

Где ломается прокси-балансировщик: наш опыт измерений

Привет, Хабр! Меня зовут Иван Дюков. Последние несколько лет я занимался разработкой и оптимизацией сетевых компонентов для облачной инфраструктуры. Среди моих проектов — участие в разработке сетевого процессора для компании Google в составе российского подразделения Intel, а также оптимизация программных сетевых функций для облака Samsung в команде Samsung R&D Institute Russia. В настоящее время работаю над сетевыми сервисами для платформы Cloud.ru Evolution в R&D-команде Cloud.ru . Основное направление моей работы — это исследования программных сетей, сетевых сервисов и их производительности. В этой статье хочу рассказать, как я искал точку отказа прокси-балансировщика. Расскажу и про метрики, и про инструменты, и как я автоматизировал измерения. Путь оказался весьма извилист, наполнен граблями и шишками, зато результат был познавательными. Статья будет интересна разработчикам сетевых сервисов, DevOps-инженерам и тестировщикам, исследующим проблемы производительности сети и сетевых сервисов. Погнали

https://habr.com/ru/companies/cloud_ru/articles/970450/

#техническая_документация #trex

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

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

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

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

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

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

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

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

Как мы меняем клиентский сервис с помощью AI: часть 2

Привет, Хабр! На связи снова Максим Михайлов и моя серия статей про внедрение AI в клиентскую поддержку Cloud.ru. В прошлой статье я рассказывал, как мы начали осваивать AI в бою — генеративные подсказки, которые помогают инженерам поддержки готовить ответы, и инструмент, который делает эти ответы дружелюбнее. Но это был только разогрев. Сегодня покажу нашу систему AI-агентов, которые дружно работают внутри технической поддержки Cloud.ru и самостоятельно обрабатывают больше 20% обращений.

https://habr.com/ru/companies/cloud_ru/articles/954562/

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

Правки, конфликты, редактура… релиз! Один рабочий день технического писателя Феди в IT-компании

Утренний кофе выпит, бутерброд съеден, довольные коты накормлены. Федя сразу включается в работу — дел много, нужно всё успеть. Но для начала нужно обновить локальные исходники разделов из репозитория. Это не первый его релиз. И Фёдор уже привычно запускает синхронизацию... Напряжение ощущается с самого утра — в рабочем чате постоянно всплывают сообщения: «Забираю исходник раздела с описанием общего алгоритма — буду вносить правки», «Добавил в карту документа пару новых приложений, обновитесь», «Перешлите мне комментарии тестировщика — у меня письмо затерялось». Сегодня не просто очередной рабочий день, сегодня день релиза .

https://habr.com/ru/companies/bercut/articles/952952/

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

Когда Redis превращается в тыкву: как один DevOps провел 2 недели в аду и выжил (но какой ценой)

Привет, я Виталий Ранн, занимаюсь в Узнать больше

https://habr.com/ru/companies/cloud_ru/articles/928664/

#техническая_документация #devops #cистемное_администрирование #redis #rediska #деплой #selfhosted #managed_paas

От хаоса к порядку: построение системы автотестов в условиях минимальных требований

Привет! Меня зовут Александр, я SDET-специалист в SimbirSoft. В этой статье я расскажу, как можно покрыть разрабатываемую часть проекта автотестами на ранних этапах его разработки, если в команде отсутствуют аналитики и присутствуют задокументированные требования только по основному функционалу. Эта статья будет интересна как джунам, так и техническим специалистам middle и выше, а также руководителям команд (team leads) и техническим лидам (tech leads). Я поделюсь тем, как в такой ситуации были настроены процессы в нашей команде. Мы работаем над проектом с утвержденной микросервисной архитектурой с внутренними и внешними сервисами. Команда работает по Scrum-методологии и состоит из тимлида, разработчиков сервисов, QA и SDET-специалистов. От заказчика поступила лишь основная информация о том, что должен делать продукт и на каких платформах его можно будет использовать. Именно эта информация и была задокументирована в виде требований.

https://habr.com/ru/companies/simbirsoft/articles/927484/

#программирование #тестирование #автоматизация #дизайн #бизнеспроцессы #управление_проектами #документация #схемы #техническая_документация #qa

[Перевод] Документация для AI: практические принципы разработки

Как AI-системы теряют 30% смысла при обработке документации? Проблема кроется в процессе chunking — разбиении документов на фрагменты. Когда связанная информация оказывается в разных частях, контекст теряется. Разберем механизмы работы RAG-систем и покажем, как писать документацию, которая работает для людей и машин.

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

#искусственный_интеллект #ai #rag #документация #llm #инженерия_знаний #управление_знаниями #техническая_документация #лучшие_практики