#%D1%82%D0%B5%D1%85%D0%BD%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%B0%D1%8F_%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%86%D0%B8%D1%8F

2025-10-20

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

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

habr.com/ru/companies/teamly/a

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

2025-10-19

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

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

habr.com/ru/articles/958076/

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

2025-10-12

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

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

habr.com/ru/companies/cloud_ru

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

2025-10-08

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

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

habr.com/ru/companies/bercut/a

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

2025-07-21

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

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

habr.com/ru/companies/cloud_ru

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

2025-07-16

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

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

habr.com/ru/companies/simbirso

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

2025-07-14

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

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

habr.com/ru/articles/926952/

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

2025-07-01

Технологический долг. Как сделать первый шаг к запуску производства

Запуск любого производства, будь то сервера для дата-центра или бытовой электроники, строится на трёх ключевых столпах: техническая документация (ТД), тестовая оснастка (ТО) и тестовое программное обеспечение (ТПО). Эти три элемента — основа реализации массового производства: от первого прототипа до серийной партии. Но довести их до совершенства практически невозможно. Всегда можно сделать что-то лучше: добавить новые функции в ПО, сделать новый чертёж в ТД или улучшить функциональность тестовых стендов. Однако жесткие сроки, бюджеты и нехватка ресурсов заставляют выбирать, где быть идеалистом, а где — прагматиком. В статье мы рассмотрим, как находить этот компромисс между теорией и практикой. Мы обсудим подходы к созданию ТД и ТПО, поймем, как конфликты между инженерами и управленцами влияют на производственный цикл, и разберем ситуацию, когда важно остановить разработку вовремя, даже если задача выглядит всё ещё "недоделанной". Эта статья адресована инженерам, технологам, проектировщикам, а также менеджерам, которые хотят глубже понять сложный процесс превращения технических идей в реально работающие продукты.

habr.com/ru/articles/924038/

#Технологический_долг #запуск_производства #техническая_документация #тестовая_оснастка #тестовое_ПО #массовое_производство_электроники #программы_и_методики_испытаний #минимально_жизнеспособный_продукт #управление_производством #инженер_и_менеджер

2025-07-01

Разработка документации для облачных сервисов, или как приручить дракона

Привет, я — Таня Кириллова, технический писатель команды развития безопасности контейнеров в Узнать больше

habr.com/ru/companies/cloud_ru

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

2025-05-27

Повышаем качество документации с помощью LLM

Привет, Хабр! Меня зовут Катя, я лидирую Gramax , open source-платформу для управления технической документацией. О Gramax мы писали ранее тут . В этой статье расскажу о Gramax Check — сервисе для автоматических проверок текста на базе LLM. По сути — нашей версии «Главреда», но с настраиваемыми правилами. Интересно, давай!

habr.com/ru/companies/gram_ax/

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

2025-05-21

Как мы писали техдокументацию AsciiDoc нейронкой, экономя своё время и миллионы

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

habr.com/ru/companies/alfa/art

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

2025-05-02

Gherkin без BDD для системного аналитика: простой способ описать, что происходит

Про Gherkin слышали в основном те, кто связан с тестированием. Среди аналитиков он встречается крайне редко. Но если отбросить всё связанное с BDD и тестами, то Gherkin это формат описания поведения системы, где сценарий это обычный текст, написанный в структурированном виде “Given‑When‑Then”. Не код, не диаграмма, а короткое текстовое описание того, что происходит в системе в определённых условиях. Не потому что модно, не потому что “так надо”, а потому что это удобно. Можно описать фактически всё: контекст, событие, результат - в трёх строках. Удивительно, что это не стало стандартом. Но как это работает на практике? Чтож… Щас выскажусь!

habr.com/ru/articles/906368/

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

2025-04-23

Как писать Release Notes, чтобы их читал и бизнес, и разработчики

Привет, Хабр! Меня зовут Иван Арискин, я занимаюсь развитием продукта «Единый адрес» в HFLabs. Поскольку компания сравнительно небольшая, иногда приходится самостоятельно писать и редактировать Release Notes (RN). Они же — новости продуктов, или changelog. За одни меня благодарили, за другие — троллили, но я научился смещать баланс в сторону положительных реакций. В статье разберу, что и зачем писать в Release Notes и как заинтересовать бизнес техническими обновлениями. Пригодится всем, кто ведет документацию по продукту и хочет, чтобы она приносила реальную пользу.

habr.com/ru/companies/hflabs/a

#техническая_документация #release #release_notes #новости_продуктов #changelog

2025-04-18

Патентный поиск без боли. Руководство для инженеров и не только

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

habr.com/ru/articles/898238/

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

2025-03-13

Лабораторная: запускаем приложения в облаке без Kubernetes и настройки виртуальных машин

Многие из вас прекрасно знают, насколько удобные и полезные инструменты виртуализация и Managed Kubernetes. А также понимают — чтобы ими управлять, нужен DevOps или как минимум тот, кто сможет настроить балансировщик. Но давайте на чистоту: когда приложение уже готово, заниматься инфраструктурными настройками не сильно хочется. Хочется быстро развернуть его и сразу показать коллегам, друзьям и другим пользователям интернета. Я Никита Бутримов — лидер направления

habr.com/ru/companies/cloud_ru

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

2025-03-12

Нейросетевой переводчик в командной строке, или Приручаем API Ollama и OpenWebUI

Связку из Ollama и OpenWebUI я использую больше года, и она является моим рабочим инструментом в части работы с документацией и контентом и по-настоящему ускорила работу по локализации документации HOSTKEY на другие языки. Но жажда исследований не отпускает, и с появлением относительно вменяемой документации к API у OpenWebUI возникло желание написать что-то, автоматизирующее работу. Например, перевод документации из командной строки.

habr.com/ru/companies/hostkey/

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

2025-02-06

Важность написания документации – зачем, кому, о чем, когда и как

Везде, где мне доводилось работать, была одна и та же боль – документация. А если быть точнее, ее скупость или отсутствие как таковой. И на каждом новом месте мне приходилось быть тем, кто ее пишет. Magnit Tech не стал исключением, ведь я пришла в команду, которую только-только сформировали. То есть – ни одной странички в Confluence в нашем разделе. Звучит пугающе? А меня это заинтересовало. Так что, в этой статье я расскажу: Зачем –> определение конечной цели Кому –> распределение ответственности О чем –> выбор темы для документации Когда –> выбор времени для написания Как –> эффективное донесение информации. А также поделюсь двумя вариантами подхода к написанию документации + как работать над стилистическим оформлением.

habr.com/ru/companies/magnit/a

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

2025-02-05

Унификация терминологии в документации: ключ к точности и удобству для пользователей

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

habr.com/ru/companies/document

#техническая_документация #унификация #ии #документация #технологии #автоматизация

2025-01-21

[Перевод] Как написать грамотный гайд: правила для техписов и разрабов

Большинство гайдов по программному обеспечению написаны трагически плохо. В них не хватает важной информации, и это мешает пользователям повторить описанные в руководстве процессы. Иногда автор исходит из скрытых предпосылок, которые не соответствуют ожиданиям читателя. Но есть и хорошая новость: научиться писать грамотные руководства проще, чем вы думаете. Следуйте нескольким простым правилам, и ваши тексты будут выделяться на фоне повсеместной посредственности. Прочитать →

habr.com/ru/companies/netology

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

2024-12-20

«Вымрут» ли печатные пользовательские инструкции?

В эпоху цифровизации техническая документация меняет свои формы и функции. Печатные издания, когда-то считавшиеся основным источником информации, постепенно уступают место онлайн-форматам. Однако остаётся вопрос: есть ли будущее у печатных документов, или их неизбежно ждёт забвение? В этой статье мы разберём преимущества и недостатки обоих форматов, а также рассмотрим современные инструменты, которые помогают создавать качественную и удобную документацию.

habr.com/ru/companies/document

#цифровизация #техническая_документация #печатные_тексты #онлайн #интерактивность #инструменты #notion #readthedocs #gitbook #slack

Client Info

Server: https://mastodon.social
Version: 2025.07
Repository: https://github.com/cyevgeniy/lmst