Лаконичность в технической документации

Содержание статьи:

• Что такое лаконичность
• Лаконичность в технической документации
• Как сделать текст лаконичным
• Инструменты анализа текста в системе Документерра

Представьте, что вы хотите получить исчерпывающий ответ на довольно сложный технический вопрос. Например, как настроить те или иные параметры в вашем IT-продукте. Вы открываете руководство пользователя и не находите соответствующего пункта в оглавлении. Вы начинаете читать разделы с похожей информацией, тратите свое время на поиск ответа, но так и не получаете нужного результата. Документ, который вы читаете, содержит много «воды», красивых вступлений, описаний (возможно, значимых для начинающих пользователей), но в нем нет краткого и лаконичного ответа на ваш узкоспециальный вопрос.

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

Что такое лаконичность?

Лаконичность означает немногословность и максимальную концентрацию на предмете описания. Отступления от темы делают контент нелаконичным. Лаконичность – это способность «отсекать все лишнее» и оставлять только насущно важную информацию.

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

Лаконичность тесно связана с понятием содержательности. Содержательность – это насыщенность текста информацией, отсутствие «воды». Имейте в виду, что «водность» – это фактор, который учитывается при SEO-анализе и оптимизации.

Интересно, что в переносном смысле термин «лаконичность» применим не только к словесным описаниям, но и к изображениям. Например, можно сказать: «В картине «Скачет красная конница» Казимир Малевич использует лаконичную палитру» (т.е. всего несколько цветов).

Лаконичность в технической документации: экономия в цифрах

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

Например, следующий текст можно сделать более лаконичным за счет сокращения «лишних слов»:

Таким образом, исходный текст объемом 49 слов можно сократить до 43 слов. Кажется, что разница невелика, но представим, что речь идет о 100-страничном руководстве по эксплуатации. Допустим, что количество слов на каждой странице равно 300 (стандартная страница). Экономия в приведенном выше примере составила 6 на примерно 50 слов, т.е. 36/300 (36 слов на страницу). Учитывая, что количество страниц в документе равно 100, то общая экономия может составить 36х100 = 3600 слов, а это целых 12 страниц!

Теперь задумайтесь над тем, что вам необходимо тиражировать данный документ в жестком формате. Согласитесь, что напечатать 1000 копий по 88 страниц будет стоить дешевле, чем тираж в 1000 копий по 100 страниц.

Есть еще один фактор, повышающий привлекательность более лаконичных текстов. Это время прочтения. Современные онлайн-калькуляторы позволяют оценить время прочтения или дикторского озвучивания текста. Согласно калькулятору Ciox для текста объемом 12 страниц (шрифт Times New Roman, 12 кегль) результаты будут следующие:

Размеренный темп: 44 мин. 48 сек.

Нормальный темп: 37 мин. 20 сек.

Быстрый темп: 32 мин.

Таким образом, соблюдая требования лаконичности, мы сэкономили читателю около 40 минут личного времени. Для этого мы всего лишь убрали «лишние слова» – «воду», которая делает контент неинформативным, некачественным и вызывает у читателя разочарование.

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

Как сделать текст лаконичным?

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

• Принцип первого предложения. Первое (и второе) предложение должны быть краткими. Попытайтесь сделать начальные формулировки лаконичными и только потом «разворачивайте» свою мысль. Это позволит привлечь внимание читателей.
• Избегайте «лишних слов». Каждое слово, буква и символ текста должны быть значимыми. Если вы пишете «В современном высокотехнологичном мире техническая документация приобретает все большее значение для пользователей», начало предложения вполне можно сократить. Оставьте только суть: «Техническая документация приобретает все большее значение для пользователей». Или: «Значение технической документации растет».
• Тема и рема. Вспомните курс стилистики (если он у вас был). Тема – это уже существующая информация, то, что упоминалось ранее. Рема – новая информация. В русском языке рема находится в конце предложения, поэтому все основные логические акценты должны приходиться на конец предложения. Например, выражение – «Как сказал Иммануил Кант, математика – царица наук». Здесь рема – царица наук. Поэтому данная часть находится в конце предложения. Если сделать наоборот («Царица наук – это математика, как сказал Иммануил Кант»), смысл высказывания будет размыт.
• Сокращайте количество слов и символов. Слово «знак» однокоренное со словом «значение», поэтому каждый символ в документе должен быть значимым. Подумайте, что можно удалить из текста, чтобы повысить его содержательность.
• Заменяйте длинные предложения на короткие. Избегайте сложносочиненных и сложноподчиненных конструкций. Лучше замените их на более короткие независимые предложения.
• Списки. Не пытайтесь сконцентрировать всю информацию в одном высказывании. Попробуйте представить ее в виде списка.
• Избегайте страдательного залога. Это, скорее, рекомендация, а не требование, поскольку избежать страдательных конструкций на 100% невозможно. Однако попытайтесь чаще использовать действительный залог. Это самый простой способ донести свой «месседж» до читательской аудитории.
• Избегайте вводных слов и конструкций. Авторы часто добавляют в текст вводные слова и фразы. Например: по моему мнению, на самом деле, как правило и т.п. Используйте такие фразы только в тех случаях, если они действительно несут значение.
• Избегайте повторов. Справиться с этой задачей помогут различные метрики и калькуляторы. Например, калькулятор количества уникальных слов.
• Правило золотой середины. Стремитесь к естественности текста. Иногда в погоне за лаконичностью можно «пересушить» текст, сделать его слишком кратким и похожим на речь робота.

Эти рекомендации помогут вам написать краткий и емкий текст и сэкономить время читателей на его прочтение.

Инструменты анализа текста в системе Документерра

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

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

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

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

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

* * *

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

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