Всё для технического документирования
+7 (925) 328-76-00
Разработка технической документации
Курсы для технических писателей
Программное обеспечение

Инструкция по улучшению удобочитаемости контента с помощью инструмента анализа текстов в MadCap Flare

01.12.2017

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


В MadCap Flare 2017 r3 появилась новая функция, которая позволяет оценить ваш проект Flare на удобство чтения, узнать среднюю длину предложения и другие параметры.

Чтобы запустить анализ текста, откройте файл с контентом (например, топик или сниппет). Выберите ленту Tools. В разделе Proofing выберите Text Analysis. Откроется панель с анализом текста.

Когда вы используете инструмент анализа текстов, вы можете запустить проверки, которые анализируют файлы с контентом по ряду параметров:

 

После щелчка по кнопке Analyze вы получаете результаты, которые показывают оценку удобства чтения, уровня качества и другие. Но что конкретно значат эти цифры?

Значение оценки

Баллы в своей основе имеют тесты «Индекс удобочитаемости Флеша» и «Индекса качества Флеша-Кинкейда». Тест лёгкости чтения Флеша генерирует баллы в диапазоне от 1 до 100, что грубо коррелирует с тем, насколько легко или тяжело читать текст. Чем выше количество баллов, тем проще читать контент. И чем ниже результат, тем читать труднее.

Чтобы понимать значение баллов теста лёгкости чтения Флеша, мы упростили эту задачу во Flare с помощью цветных полосок; зелёная полоска показывает, что результат хороший, жёлтый цвет показывает средний результат, а красный – низкий результат.

Тест «Индекса качества Флеша-Кинкейда» — другая метрика удобочитаемости, основанная на уровнях качества в образовательной системе США. Баллы показывают уровень читаемости; например, если ваш контент оценивается числом 6, это соответствует шестому уровню качества чтения.

Когда речь заходит о документах, которые необходимо выкладывать в публичный доступ, лучше всего ориентироваться на уровень качества чтения до 8 баллов. Короче говоря, вам необходимо достигать больших значений теста лёгкости чтения и низких значений уровня качества.

 

Старайтесь, чтобы значение уровня качества чтения вашего контента было 8 или ниже – такой контент хорошо воспримут 80% читателей

 

Для получения дополнительной информации о том, как рассчитывается количество баллов, обратитесь к этой статье (на английском языке).

Четыре совета по улучшению удобочитаемости

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

1. Уменьшите среднюю длину предложения

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

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

2. Минимизируйте плотность пунктуации в предложении

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

  • Соединение с помощью запятой: Разбейте предложения, в которых две независимых мысли разделены запятой.
  • Кавычки: Вместо использования кавычек для передачи смысла, рассмотрите возможность использования вместо этого курсива, использование жирного шрифта или подчёркивание слов.

Дополнительную информацию о проблемах с пунктуацией можно узнать из этой статьи.

3. Уменьшите размер абзацев

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

4. Следите за уникальными словами

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

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

Заключение

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

Источник: A Guide to Improving Content Readability with the Text Analysis Tool in MadCap Flare

Тэги: , , , ,

< Вернуться к списку публикаций

Облако тегов