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

Информационная статья объясняет что-то. Что это за «что-то», почему оно работает именно так, в чем разница между двумя вариантами, что происходит за кулисами процесса.

Их сложнее писать, чем инструкции, и они «ломаются» по-разному. Материал формата «как сделать» терпит неудачу, когда человек застревает. Объяснение терпит неудачу, когда человек дочитывает, считает, что понял, и в итоге оказывается, что он не понял.

Скачать шаблон информационной статьи

Бесплатно, редактируемо, без водяного знака.

Какой тип статьи вам нужен?

Самая распространенная структурная ошибка в документации — смешивать эти форматы. Объяснение с тремя шагами, спрятанными внутри, или набор инструкций, прерванный фоном, не помогает ни одному читателю.

Почему объяснения не работают

Не потому, что автор знает слишком мало. Почти всегда — наоборот.

Читатель уже верит во что-то. Он приходит с ментальной моделью — обычно неполной и часто неверной. Факты, добавленные к неверной модели, «встраиваются» в нее, а не заменяют ее. Поэтому человек может прочитать точное объяснение и все равно уйти с неверным пониманием.

Автор забыл, каково это — не знать. Как только вы понимаете что-то, сложность обучения становится невидимой. Вы пропускаете шаг, который изначально вас путал, потому что теперь он больше не кажется шагом.

Абстракция приходит первой. Определения до примеров — естественный порядок для тех, кто уже понимает, и неправильный порядок для всех остальных.

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

Начните с того, во что они уже верят

Самое полезное, что вы можете сделать перед написанием, — выяснить, что читатель думает сейчас.

Для концепции продукта это обычно берется из тикетов в поддержку: вопросы, которые задают люди, показывают модель, с которой они работают. «Почему мой отчет не обновился» говорит о том, что они считают, будто он обновляется в реальном времени. Эта ошибка понимания — то, на что ваша статья должна ответить, и это полезнее, чем любое количество точных описаний.

Затем напишите объяснение так, чтобы оно вытеснило эту ошибку, а не просто описало истину. Это разные части текста. Одно признает то, что люди предполагают, и показывает, почему это не работает. Другое говорит, что правда, и надеется, что читатель заметит противоречие.

Явное называние ошибки понимания работает особенно хорошо. «Вы можете ожидать, что отчет обновится сразу после изменения данных. Но этого не происходит — и причина стоит того, чтобы ее понять».

Как настроить этот шаблон в Trupeer

Шаг 1: Откройте раздел «Templates»

Перейдите в раздел «Templates» из главной навигации.

Шаг 2: Выберите и откройте шаблон

Нажмите на любой шаблон, с которым хотите работать, чтобы открыть его.

Шаг 3: Разверните просмотр шаблона

При необходимости разверните просмотр шаблона, чтобы четко увидеть полную структуру и детали.

Шаг 4: Отредактируйте шаблон

Нажмите «Edit», чтобы начать изменять выбранный шаблон.

В редакторе вы можете:

• Добавлять новые разделы

• Задавать или обновлять правила форматирования

• Добавить логотип и настроить его положение и связанные параметры

Шаг 5: Сохраните настроенный шаблон

После внесения всех необходимых изменений нажмите «Save», чтобы сохранить обновленный шаблон как свой.

Шаг 6: Предпросмотр и точная настройка шаблона

Когда вы захотите увидеть, как выглядит ваш настроенный шаблон, откройте «Preview».

На экране предпросмотра при необходимости вы можете продолжить вносить правки напрямую, чтобы шаблон отображался ровно так, как вам нужно.

С шаблоном информационной статьи вы можете:

• Экономить часы на написании: пропускайте пустую страницу со структурой, созданной для образовательного контента.

• Улучшать SEO: статьи с хорошей структурой лучше ранжируются в результатах поиска.

• Оставаться в фирменном стиле: применяйте логотип, шрифты и цвета с помощью бренд-набора Trupeer.

• Привлекать больше читателей: сочетайте статьи с видео-краткими изложениями, чтобы охватить разные предпочтения в обучении.

• Стандартизировать контент: используйте один и тот же шаблон для постов в блоге и статей базы знаний.

• Достигать глобальной аудитории: переводите статьи на 65+ языков одним кликом.

Структура объяснения

Короткий ответ вверху — это не краткое содержание статьи. Это ответ для значительной части читателей, которым он нужен и которые уйдут. Сразу дать его — правильно. Статья существует для тех читателей, которые хотят больше.

Сначала конкретика, потом абстракция

Самое надежное улучшение для любого объяснения.

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

Сначала абстракция: Ограничение частоты (rate limiting) ограничивает количество запросов, которые клиент может отправить в заданном временном окне, предотвращая исчерпание ресурсов и обеспечивая доступность сервиса на равных условиях.

Сначала конкретика: Если вы отправляете больше 100 запросов за минуту, мы начинаем отклонять их, пока не закончится минута. Это останавливает одну интеграцию от случайного потребления мощности, которая нужна всем остальным. Такое ограничение называется rate limiting.

Второе не проще по содержанию. Оно приходит в том порядке, в котором читатель может это усвоить.

Аналогии и где они ломаются

Аналогии — самый мощный инструмент в объяснительном тексте и одновременно самый вероятный источник тонкого недопонимания позже.

Используйте одну, когда концепция действительно незнакома и есть близкая повседневная параллель. Держите ее короткой и используйте один раз, а не растягивайте по всей статье.

Затем скажите, где аналогия заканчивается. «Это немного похоже на очередь у стойки, за исключением того, что в отличие от очереди порядок не гарантируется». Если назвать предел, читатель не перенесет аналогию туда, где она приведет к неверным выводам. Именно так аналогии создают ошибочные представления, которые потом приходится исправлять в следующих статьях.

Если вы не можете сказать, где аналогия перестает работать, значит, вы пока недостаточно хорошо понимаете концепцию, чтобы объяснить ее.

Шаблон статьи

Слабое и лучше

Слабое начало: Эта статья дает обзор нашей архитектуры синхронизации данных и различных факторов, которые влияют на частоту обновлений в интегрированных системах.

Лучшее начало: Ваши данные обновляются каждые 15 минут, а не мгновенно. Если вы только что что-то изменили и не видите этого, причина в этом. Здесь объясняется, как работает синхронизация и когда этот интервал имеет значение.

Слабое объяснение: Система использует модель eventual consistency, при которой записи распространяются асинхронно между узлами, а сходимость обычно достигается в пределах заданного временного окна.

Лучшее объяснение: Когда вы сохраняете изменение, сначала оно записывается в одном месте, а затем копируется в остальные через некоторое время. В течение нескольких секунд разные части системы могут показывать разные значения. Это сделано намеренно, потому что ожидание подтверждения каждой копии перед тем, как принять ваше изменение, сделало бы сохранение намного медленнее. Это важно в одном случае: если вы сохраните и сразу запустите отчет, отчет может не включить это изменение.

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

Лучшая структура: ответ в одну строку, почему вам это важно, распространенное заблуждение, разобранный пример, затем общий принцип, затем исключения.

Длина и охват

Одна концепция на статью. Если в заголовке нужно «и», значит, у вас две.

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

Проверка: сможет ли кто-то прочитать это и принять решение, на которое влияет статья? Если да, то дополнительная точность стоит больше ясности, чем дает. Перенесите исключения в справочную статью и сделайте на нее ссылку.

От восьмисот до полутора тысяч слов — разумный диапазон для большинства объяснительных материалов. Длиннее обычно означает, что вы охватываете несколько концепций или что концептуальная статья «впитала» справочный материал, который должен быть в другом месте.

Диаграммы

Концептуальные статьи выигрывают от диаграмм больше, чем любые другие типы, потому что большая часть того, что они объясняют, структурная или последовательная.

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

Сделайте ее достаточно простой, чтобы ее можно было прочитать за несколько секунд. Диаграмма с двадцатью блоками не объясняет ничего такого, чего не смогли бы объяснить двадцать абзацев, но ее сложнее обновлять.

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

Когда объяснять, а когда ссылаться

Животрепещущий вопрос в большинстве документаций.

Объясняйте прямо в тексте, когда читатель не сможет двигаться дальше без этого, когда это занимает два предложения или когда вся цель статьи — именно эта концепция.

Ссылайтесь наружу, когда это самостоятельная концепция, когда она нужна только части читателей или когда объяснение удвоит длину статьи.

Никогда не объясняйте прямо в статье формата «как сделать». Читатель выполняет действия, а фон прерывает процесс. Ссылайтесь и держите шаги чистыми. Это самый сильный аргумент в пользу того, чтобы вообще иметь концептуальные статьи: они дают статьям «как сделать» куда отправлять людей.

Типы информационных статей

Статьи формата «почему» — самые ценные и при этом их пишут реже всего. Большинство документаций объясняет «что» и «как», оставляя читателям гадать о причинах, а догадки обычно менее благосклонны к истине, чем сама истина.

Форматы

Word — для черновиков и проверки, особенно когда эксперту по теме нужно проверить точность.

PDF — для бриф-документов, печатных объяснений и всего, что распространяется, а не публикуется.

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

Ваш центр помощи или база знаний — для всего, что ориентировано на клиентов, с перекрестными ссылками из статей «как сделать», где упоминается эта концепция.

Проверка объяснения

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

Рабочий метод: попросите кого-то объяснить это обратно своими словами. Не «понял ли он», на что все отвечают «да», а само объяснение. Там, где версия человека расходится с вашей, и заключается провал статьи.

Еще лучше — попросите их предсказать что-то. «С учетом того, что вы только что прочитали, что произойдет, если вы сохраните изменение и сразу запустите отчет?» Неверный прогноз — это точная обратная связь о том, какая часть не усвоилась.

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

Поддержка

Концептуальные статьи устаревают медленнее, чем статьи «как сделать», потому что базовые принципы меняются реже, чем интерфейсы.

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

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

Лучшие практики

• Одна концепция на статью.

• Короткий ответ вверху — сразу, без промедления.

• Явно назовите распространенное предположение.

• Сначала конкретный пример, затем общий принцип.

• Не более одной аналогии, с указанием ее границ.

• Исключения — после основной идеи, никогда не до.

• Диаграмма, где концепция структурная.

• Ссылайтесь наружу вместо того, чтобы объяснять внутри статьи «как сделать».

• Проверяйте, попросив кого-то объяснить это обратно.

• Скажите, что делать иначе, зная это.

Частые ошибки

• Сначала определение, в конце — пример.

• Покрыть все исключения, похоронив основную идею.

• Не адресовать существующую веру читателя — поэтому исправление не «приживается».

• Написано для того, кто уже понимает.

• Аналогия расширена за пределы того, где она работает.

• Концепция и инструкции смешаны в одной статье.

• Нет практического следствия — читатель узнает что-то и ничего с этим не делает.

• Термины определяются через другие термины.

• Диаграммы со своей терминологией.

• Проверяли с коллегами, которые уже знали.

• Без даты — читатели не могут оценить, все ли еще это правда.

Некоторые вещи проще показать, чем написать

Откройте шаблон в Trupeer AI, примените ваш бренд-набор, чтобы статьи соответствовали вашей документации, и отредактируйте любой раздел напрямую. Настройка описана в руководстве по шаблону.

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

Запишите происходящее, и Trupeer AI создаст письменное объяснение и озвученное видео из того же прохода, чтобы статья могла содержать оба формата. Тем, кто предпочитает текст, — текст. Тем, кому нужно увидеть это, — видео. Переведите на 65+ языков и храните набор в вашей базе знаний рядом со статьями «как сделать», которые на нее ссылаются.

Запишите. Оформите в бренде. Переведите. Trupeer it.

Часто задаваемые вопросы

Есть ли бесплатный шаблон информационной статьи в Word?

Да. Word — основной формат, со всей структурой, включая раздел с коротким ответом, распространенным предположением и секциями с объяснением. Бесплатная загрузка, без регистрации, без водяного знака.

Есть ли шаблон статьи в Word, который можно бесплатно скачать?

Да, и он подходит для объяснительных статей любого типа: «что это», «как работает», «почему», сравнение и материалы с подсказками для принятия решений.

Есть ли бесплатный шаблон статьи?

Да — в Word, PDF и PowerPoint; все бесплатно и без необходимости создавать аккаунт. Если вам нужны инструкции, а не объяснение, лучше подойдет шаблон статьи «как сделать».

Есть ли бесплатный шаблон информационной статьи в PDF?

Да: есть и пустой вариант, и вариант с заполненным примером. Это полезно, потому что разницу между хорошим и плохим объяснением проще увидеть, чем описать.

Есть ли бесплатный шаблон информационной статьи в PPT или PowerPoint?

Да. Версия PowerPoint предназначена для объяснения концепции на сессии, а не в документе — часто это работает лучше, потому что вы можете наблюдать, следуют ли люди за ходом, и корректировать. Оставьте письменную версию как запись.

Могу ли я скачать бесплатный шаблон информационной статьи?

Да, каждый формат можно бесплатно скачать без необходимости указывать авторство.

Какой лучший бесплатный шаблон информационной статьи?

Тот, где вверху есть раздел с коротким ответом и место, чтобы назвать распространенное ошибочное представление. Большинство шаблонов дают заголовки для введения, основной части и заключения — это структура, из-за которой объяснения сложнее читать. Сразу отвечать и адресовать то, во что читатель уже верит, — две вещи, которые сильнее всего улучшают объяснение.

Что такое информационная статья?

Статья, которая объясняет что-то, а не инструктирует. Она отвечает на вопросы: что это за «что-то», как оно работает, почему оно работает именно так или чем отличаются две вещи. Она отличается от статьи «как сделать», где проводится человек через задачу, и от справочных материалов, которые перечисляют значения и варианты.

Что должна включать информационная статья?

Заголовок словами читателя, короткий ответ на два или три предложения, почему это важно для него, распространенное предположение, указанное явно, объяснение с конкретным примером перед общим принципом, пограничные случаи после, практическое следствие, а также ссылки на связанные концепции и любые релевантные инструкции.

Как написать хорошее объяснение?

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

Какой должна быть длина информационной статьи?

Для большинства концепций — от восьмисот до полутора тысяч слов. Длиннее обычно означает, что вы охватываете несколько концепций или что вы «впитали» справочный материал, который должен быть в другом месте. Проверка — может ли читатель принять решение, на которое влияет статья, а не то, охвачены ли все случаи.

В чем разница между информационной статьей и статьей «как сделать»?

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

Как понять, что объяснение сработало?

Попросите кого-то объяснить это обратно своими словами или, что еще лучше, предсказать, что произойдет в конкретной ситуации. Если спросить, понял ли он, ответ будет «да» в любом случае. Проверяйте с человеком из реальной аудитории: коллега, который уже знает концепцию, узнает истину в вашей статье без того, чтобы чему-то научиться.

Как часто нужно пересматривать информационные статьи?

Ежегодно и всякий раз, когда меняется то, что вы объясняете. Они устаревают медленнее, чем статьи «как сделать», но «ломаются» тише: устаревший скриншот очевиден, а объяснение, которое больше не является правдой, выглядит точно так же, как то, которое является.

Могу ли я настроить этот шаблон информационной статьи?

Да, каждая версия полностью редактируемая. Два раздела, которые стоит сохранить, — короткий ответ вверху и распространенное предположение, потому что именно они отличают объяснение, за которым следуют, от того, которое просто читают.

Похожие шаблоны

• Шаблон статьи «как сделать»

• Шаблон руководства «как сделать»

• Шаблоны статей базы знаний

• Шаблон базы знаний

• Шаблон технической документации

• Шаблон страницы FAQ

• Шаблон документации процесса

• Шаблон документации по ПО