Так случается: пишешь текст сам, вычитываешь, вычищаешь, убираешь воду – а потом коллега спрашивает: «Это ChatGPT?»
Рубрика «технический писатель»
Я техписатель, чьи тексты принимают за ИИ-шные. И вот что выяснилось…
2026-06-04 в 9:00, admin, рубрики: AI-детекторы, chatgpt, авторский стиль, генеративный ии, ИИ-тексты, контент, редактура, стилометрия, техническая документация, технический писатель
Как мы избавились от копипаста в технической документации
2026-03-14 в 20:39, admin, рубрики: гост 34, документация, технический писатель, техническое заданиеО себе
Всем привет. Меня зовут Никита, я руковожу командой Цикл-ОН. Мы уже более 5 лет ведем проекты по заказной разработке ПО и, как и многие, сталкиваемся с необходимостью разработки не только качественного кода, но и документацию на продукты. В нашей нише особенность, что заказчики живут в парадигме ГОСТа. Я бы здесь хотел оставить небольшую заметку о нашем опыте — как то, что для начаиналось как откровенное мучение превратилось сначала в умную идеологию, а по итогу в самостоятельное решение для подготовки документации — Платформа «ГОСТ‑ОН».
С чего все началось
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. Фактически это формат, основанный на Читать полностью »
User guide — пустая формальность или незаменимый документ? Руководство, как написать руководство
2025-10-05 в 16:40, admin, рубрики: rtfm, user guide, документация, инструкция, интерфейс, описание, пользовательская документация, руководство пользователя, технический писательВ случае возникновения критической ошибки обновления:
1. Установите причину ошибки.
2. Устраните причину ошибки.Документация Microsoft
Недавно мне понадобилось почитать инструкцию к одной программе. Нужно было понять, как заполнить одно из полей в важном окне. Были там определённые нюансы. Само приложение никаких подсказок не давало, вело себя весьма сдержанно и отстранённо. Название таинственного поля тоже не радовало ясностью и прозрачностью. В общем, всё как всегда.
Почему технический писатель — это переводчик между разработчиками и пользователями?
2025-08-12 в 19:04, admin, рубрики: разработка технической документации, техническая документация, технический писательПривет!
Меня зовут Дима, я работаю техническим писателем в UDV Group, описываю разрабатываемые продукты для внешних и внутренних пользователей.
Задумывались ли вы когда-нибудь о том, кто объясняет сложное так, чтобы было понятно всем? Кто превращает техническую жаргонизированную речь разработчиков в простые инструкции, которые может прочитать любой — от новичка до супер-специалиста?
Как добавить теги в чат. Часть первая
2025-05-31 в 19:25, admin, рубрики: профессиональное сообщество, сообщество экспертов, теги, технические писатели, технический писатель, чатПривет! Меня зовут Арина Балерина, я — технический писатель, а это значит, что я умею писать инструкции к тому, чем вы пользуетесь каждый день, будь то API или холодильник.
В этой статье я расскажу про то, как можно использовать #теги в профессиональном сообществе — чате. Если вы ведёте канал, активный чат, отвечаете за базу знаний или просто размышляете, как сделать домашнее хранилище ссылок — вам эта статья точно пригодится.
Речь пойдёт о крупнейшем в России сообществе технических писателей, вот оно:
Михаил Острогорский — о том, как в России появились технические писатели и как они создали свою профессию
2025-04-20 в 13:16, admin, рубрики: ит-рынок, научпоп, русский язык, технический писательНужные люди без профессии
Для меня, студента, а потом выпускника московского технического вуза по специальности «Прикладная математика», середина 1990-х годов выглядела дивным новым миром и взрывом возможностей. Появлялись новые российские компании, новые продукты, приходили в Россию иностранные компьютерные и софтверные компании. И всё это было окружено многочисленными выставками, всевозможными семинарами, презентациями, журналами и еженедельниками.
AI в работе технического писателя
2025-04-03 в 4:15, admin, рубрики: AI, chatgpt, restructuredtext, sphinx, sphinx docs, автоматизация, документация, искусственный интеллект, рабочие процессы, технический писательВсем привет! Меня зовут Севара Ахтямова и я работаю техническим писателем — аналитиком около 4 лет. В этой статье я расскажу, как AI помог мне справиться с рабочей рутиной — от генерации toctree до отладки сборки Sphinx-документации. Всё это — на реальных задачах. Я постаралась собрать побольше примеров из личного опыта. Надеюсь, не слишком много.
Оценка рынка труда для технических писателей: Россия vs. США
2025-01-15 в 14:30, admin, рубрики: зарплаты в it, ИИ, искусственный интеллект, нейросети, рынок труда, создание документации, технический писатель, тренды будущегоРазберём, как устроен рынок труда для техписов в России и США, вооружившись данными за 2023–2024 годы. Поговорим о зарплатах, условиях работы и трендах, которые определяют будущее профессии. Заодно выясним, почему спрос на специалистов по документации продолжает расти вместе с развитием технологий и какие перспективы открываются перед теми, кто готов учиться, адаптироваться и прокачивать свои навыки.