Так случается: пишешь текст сам, вычитываешь, вычищаешь, убираешь воду – а потом коллега спрашивает: «Это ChatGPT?»
Рубрика «техническая документация»
Я техписатель, чьи тексты принимают за ИИ-шные. И вот что выяснилось…
2026-06-04 в 9:00, admin, рубрики: AI-детекторы, chatgpt, авторский стиль, генеративный ии, ИИ-тексты, контент, редактура, стилометрия, техническая документация, технический писатель
От ТЗ до сертификата: как интегрировать оценку соответствия в жизненный цикл продукта
2026-04-13 в 12:16, admin, рубрики: гост, испытания, качество, контроль качества, проверка, разработка электроники, сертификация, соответствие требованиям, стандарты, техническая документацияДля инженеров, конструкторов и технологов, отвечающих за создание продукта, результатом работы является не прототип, а успешный вывод изделия на рынок. Однако на этом пути могут возникнуть незапланированные препятствия, устранение которых может потребовать месяцев доработки, дополнительных испытаний и переоформления документов.
Хватит покупать курсы. Соберите портфолио на реальных кейсах. 3 разбора + чек-лист
2026-02-23 в 13:16, admin, рубрики: анализ документации, аудит документации, информационная архитектура, как стать аналитиком, метрики качества документации, пользовательский опыт, портфолио аналитика, системный анализ, техническая документацияВажное примечание: Все исследования проведены на публичных данных. Я отправляю эти разборы командам, потому что верю: лучший способ проверить гипотезы — столкнуть их с реальностью. Моя задача — подсветить разрывы в пользовательском опыте, которые могут стоить денег, и предложить варианты их устранения. Буду рада обратной связи и готовa скорректировать выводы, если увижу контекст, который ускользнул от моего внимания как внешнего исследователя.
Если читать некогда — вот суть за 40 секунд
Почему разработчики перестали читать документацию и что с этим делать
2026-02-22 в 13:16, admin, рубрики: documentation, wiki, база знаний, документация, культура разработки, Процессы в командах, процессы разработки, системный анализ, техническая документация, управление разработкойВсем привет! Я системный аналитик в компании «СИБИНТЕК-СОФТ». Последние несколько лет занимаюсь разработкой ИТ-продуктов и сталкиваюсь с одной и той же проблемой – документация есть, но ее не читают. В чём причина — в лени разработчиков или в плохо написанной документации? Давайте разберёмся.
Важно: речь в статье идёт именно о внутренней технической документации для команды разработки: архитектурных решениях, описании сервисов, API и т.д. Это не про инструкции пользователей или администраторов и не про проектную документацию для заказчика.
Проблематика
AI & RAG. Помощник по техническим вопросам систем управления освещением
2026-01-10 в 12:58, admin, рубрики: AI-first, claude, frida, qdrant, qwen, rag, локальная LLM, системы управления освещением, техническая документация, эмбеддингВведение
Свою первую программу я написал в 1988 году на калькуляторе МК52. Очень хотелось программировать и даже максимально странный интерфейс не останавливал. Утекло почти 40 лет. Были Атари, Синклеры, 286 IBM, Интернет, смартофоны. Но все эти технологии входили как-то постепенно, приспосабливаясь и без шока.
AI ворвался в жизнь бывалого ИТшника как пыльным мешком по голове. После первого шока, скормленных Дипсику результатов анализов, идей подарков, профессиональная “чуйка” потребовала придумать новой чудо-технологии боевое применение в том, чем я занимаюсь каждый день на протяжении всей сознательной жизни.
Читать полностью »
Docs-as-Code на практике: автоматизация сборки документации в проекте ODS
2025-12-26 в 11:16, admin, рубрики: asciidoc, asciidoctor, docs as code, documentation, PDF, генератор статических сайтов, техническая документация, технический писательВ статье приводится практический опыт перехода от “офисных” документов к подходу Docs‑as‑Code на примере проекта ODS (Open Documentation Standard). Рассматриваются причины отказа от MS Word и выбор AsciiDoc, версионирование документации в Git, автоматизацию сборки PDF и публикацию документации на сайте, используя генератор статических сайтов – Antora.
Эта статья о проекте ODS (Open Documentation Standard) – открытом стандарте и инструментарии для автоматизации процессов создания и поддержки технической документации в ИТ и других проектах.
(Не связан с форматом OpenDocument Spreadsheet (.ods) или проектами Open Data.)
В открытом доступе находятся Читать полностью »
Фильтруй. Переиспользуй. Собирай. Почему DITA — идеальный формат для разработки сложной технической документации
2025-12-19 в 11:27, admin, рубрики: bercut, dita, dita open toolkit, doc-as-code, XML, документация, пользовательская документация, техническая документация, технический писатель, форматы документовВспомните свои ощущения, когда обстоятельства заставили вас сменить удобный привычный инструмент на другой, неудобный и неэргономичный. Неважно, что это будет — клавиатура, телефон, отвёртка или операционная система. Те действия, которые раньше выполнялись как будто сами собой, теперь требуют дополнительных усилий, всё кажется неудобным и неправильным. К хорошему быстро привыкаешь и перестаёшь его замечать.
DITA расшифровывается как Darwin Information Typing Architecture. Фактически это формат, основанный на Читать полностью »
Как мы меняем клиентский сервис с помощью AI: часть 2
2025-10-12 в 18:10, admin, рубрики: servicedesk, искусственный интеллект, поддержка пользователей, техническая документация, техническая поддержкаПривет! На связи снова Максим Михайлов и моя серия статей про внедрение AI в клиентскую поддержку Cloud.ru.
В прошлой статье я рассказывал, как мы начали осваивать AI в бою — генеративные подсказки, которые помогают инженерам поддержки готовить ответы, и инструмент, который делает эти ответы дружелюбнее. Но это был только разогрев. Сегодня покажу нашу систему AI-агентов, которые дружно работают внутри технической поддержки Cloud.ru и самостоятельно обрабатывают больше 20% обращений.
Почему технический писатель — это переводчик между разработчиками и пользователями?
2025-08-12 в 19:04, admin, рубрики: разработка технической документации, техническая документация, технический писательПривет!
Меня зовут Дима, я работаю техническим писателем в UDV Group, описываю разрабатываемые продукты для внешних и внутренних пользователей.
Задумывались ли вы когда-нибудь о том, кто объясняет сложное так, чтобы было понятно всем? Кто превращает техническую жаргонизированную речь разработчиков в простые инструкции, которые может прочитать любой — от новичка до супер-специалиста?
Документация для AI: практические принципы разработки
2025-07-14 в 7:00, admin, рубрики: AI, llm, rag, документация, инженерия знаний, искусственный интеллект, лучшие практики, техническая документация, управление знаниямиВсем привет!
Меня зовут Александр, я COO в SaaS-платформе аналитики данных. Последний год активно изучаю внедрение AI-решений в кросс-функциональные процессы. Делюсь полезными материалами, которые считаю стоят внимания. В основном про AI, изменение процессов, тренды и продуктовое видение.
У себя в телеграм-канале делюсь сжатыми и структурированными саммери статей.
Сегодняшний перевод отличного гайда по документации для AI от Kapa AI (AI-ассистент для технической документации).