Background

Практические руководства по созданию пользовательской документации

 
Как пользовательская документация формирует восприятие продукта

Как пользовательская документация формирует восприятие продукта

Что мешает пользователю понять ваш продукт? Как единые стандарты документации становятся проводником в мире цифровых продуктов?

Читать ...

Документация как инфраструктура: главные выводы State of Docs 2026

Документация как инфраструктура: главные выводы State of Docs 2026

Обзор опроса State of Docs 2026: как меняется пользовательская документация?

Читать ...

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

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

Как понять, что пользовательская документация эффективна? Метрики, поиск, аналитика, кейсы и чек-лист для технических писателей и менеджеров.

Читать ...

Миссия Artemis II: что может почерпнуть техпис в 2026 году

Миссия Artemis II: что может почерпнуть техпис в 2026 году

Как создать эффективную профессиональную пользовательскую документацию в 2026 году?

Читать ...

Техпис-удаленщик в 2026 году: зло или благо?

Техпис-удаленщик в 2026 году: зло или благо?

Удаленка в IT: временный тренд или новая реальность 2026 года? Взгляд изнутри IT-индустрии.

Читать ...

Как выбрать шрифт для пользовательской документации в 2026 году?

Как выбрать шрифт для пользовательской документации в 2026 году?

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

Читать ...

Эффективная пользовательская документация и FTUE

Эффективная пользовательская документация и FTUE

Оказаться в новом интерфейсе — всё равно что очутиться в незнакомом городе: все интересно, но всё непривычное и чужое. Как превратить интерфейс в ландшафт, который интересно изучать?

Читать ...

Модель изменений Курта Левина в разработке руководства пользователя

Модель изменений Курта Левина в разработке руководства пользователя

Модель изменений Курта Левина, разработанная в 1940-х годах, — это простая, но эффективная идея о том, как управлять переменами. Как ее использовать при разработке пользовательской документации?

Читать ...

Стрелка — универсальный проводник в мире символов

Стрелка — универсальный проводник в мире символов

Стрелка проделала впечатляющий путь от логических диаграмм XIX века до интерфейсов смартфонов XXI века. Почему мы решили использовать ее в заголовке?

Читать ...

Шаблон STAR при создании пользовательской документации

Шаблон STAR при создании пользовательской документации

Знаете, в чем главная слабость традиционной пользовательской документации? В ее абстрактности. Мы описываем, что может система, но не объясняем, зачем это нужно человеку в его рабочем контексте. STAR-подход начинается с установления этой связи.

Читать ...

Как персонализировать пользовательскую документацию?

Как персонализировать пользовательскую документацию?

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

Читать ...

Как пользовательская онлайн документация продает продукт?

Как пользовательская онлайн документация продает продукт?

Программное обеспечение с онлайн-документацией или ПО с инструкциями в формате DOCX — какой выбор делает современный пользователь?

Читать ...

Пишем пользовательскую документацию по методу Стивена Кинга

Пишем пользовательскую документацию по методу Стивена Кинга

Что общего между автором, населяющим кошмары клоунами-убийцами, ожившими автомобилями, и техническим писателем, который методично описывает инструкции? На первый взгляд — ничего. Но если заглянуть в саму суть писательского ремесла...

Читать ...

Творческий отбор или Теория Дарвина в IT

Творческий отбор или Теория Дарвина в IT

Книга Кена Косиенды, бывшего инженера Apple, об истории создания знаковых продуктов. Что можно почерпнуть из нее техническому писателю?

Читать ...

Использование шкалы Лайкерта в тестировании пользовательской документации

Использование шкалы Лайкерта в тестировании пользовательской документации

Насколько легко пользователям находить ответы в вашей справочной системе? Удобна ли она для них? Ответы на эти вопросы помогут вам улучшить руководство, выявив его слабые места. Один из способов узнать мнение пользователей — шкала Лайкерта.

Читать ...

Как сделать аннотации и подписи к скриншотам в MS Word в 2026 году?

Как сделать аннотации и подписи к скриншотам в MS Word в 2026 году?

Рассказываем, как сделать аннотации в Word и показываем, как сделать это еще быстрее в специальной бесплатной программе.

Читать ...

"Понятный" интерфейс в программах для создания  пользовательской документации

"Понятный" интерфейс в программах для создания пользовательской документации

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

Читать ...

Применение теории разбитых окон в написании документации

Применение теории разбитых окон в написании документации

Как теория разбитых окон применяется в написании документации? Как поддерживать проект в актуальном состоянии и избежать его устаревания?

Читать ...

Создание файла помощи (файла справки) в формате CHM для .NET Windows-приложения с примерами

Создание файла помощи (файла справки) в формате CHM для .NET Windows-приложения с примерами

В этой статье с примерами кода рассматривается вопрос создания файла справки в формате CHM с помощью программы Dr.Explain, а также его интеграция в .NET-приложение.

Читать ...

 Создание help-файла (справки) в формате CHM для Visual Basic (VB.NET)-приложения для Windows при помощи Dr.Explain

Создание help-файла (справки) в формате CHM для Visual Basic (VB.NET)-приложения для Windows при помощи Dr.Explain

Статья с примерами кода посвящена созданию файла справки в программе Dr.Explain и его интеграции в приложение Visual Basic (VBA.NET).

Читать ...

Создание help-файла (справки) в формате CHM для MS Excel-приложения для Windows при помощи Dr.Explain

Создание help-файла (справки) в формате CHM для MS Excel-приложения для Windows при помощи Dr.Explain

Показываем, как написать справку для Microsoft Excel с помощью программы Dr.Explain. Видео урок по созданию CHM файла.

Читать ...

Создание help-файла (справки) в формате CHM для MS Access-приложения для Windows в Dr.Explain

Создание help-файла (справки) в формате CHM для MS Access-приложения для Windows в Dr.Explain

В инструкции с примерами кода описан процесс создания в программе Dr. Explain файла справки для Microsoft Access приложения и его последующая интеграция в формы базы данных.

Читать ...

Создание help-файла (справки) в формате CHM для Delphi-приложения для Windows в Dr.Explain

Создание help-файла (справки) в формате CHM для Delphi-приложения для Windows в Dr.Explain

В статье с примерами кода описан процесс создания в программе Dr. Explain файла контекстной справки для Delphi приложения и его последующая интеграция в программу.

Читать ...

Зодиак технических писателей: особенности характера и предрасположенности в работе

Зодиак технических писателей: особенности характера и предрасположенности в работе

Гороскоп технических писателей: Характеристики технических писателей по знакам Зодиака

Читать ...

10 эвристик для оценки удобства использования (юзабилити) вашей документации

10 эвристик для оценки удобства использования (юзабилити) вашей документации

Сегодня, даже если вы полностью перешли на online-документацию, эти эмпирические правила остаются хорошим подспорьем при оценки качества документации.

Читать ...

16 причин, почему ваши пользователи не читают документацию

16 причин, почему ваши пользователи не читают документацию

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

Читать ...

Делайте правильно! Публикуем онлайн-документацию на сайте проекта

Делайте правильно! Публикуем онлайн-документацию на сайте проекта

Очевидным выбором для публикации онлайн-справки кажется традиционный HTML, а точнее DHTML (Dynamic HTML). Документация представлена набором HTML файлов, изображений, а также JavaScript-файлов, которые отвечают за всю динамику.

Читать ...

Как написать руководство пользователя программы или сайта — инструкции, советы, помощь, программное обеспечение

Как написать руководство пользователя программы или сайта — инструкции, советы, помощь, программное обеспечение

Разработка и написание хорошей документации - это труд, который требует много времени и усилий. Но если успешно справиться с задачей, можно навсегда получить лояльных и довольных клиентов.

Читать ...