Юлий Минькин, руководитель проектного офиса
Когда мы читаем книгу, статью или инструкцию, мы не всегда задумываемся о том, какой стиль и тип текста мы встречаем. Но если мы хотим писать сами, то нам нужно знать, какие особенности есть у разных видов текстов и как правильно составлять техническую документацию.
В этой статье я хочу сравнить два типа текстов, которые кажутся совсем разными: технический текст и художественное произведение. Я попробую показать, чем они отличаются и почему один из них проще написать, чем другой.
Сравнение видов текста
Техническая документация — это текст, который дает информацию о каком-то продукте, процессе или системе. Например, это может быть руководство по эксплуатации ноутбука, описание алгоритма работы программы или схема компьютерной сети.
Цель такого текста — помочь пользователю или клиенту понять, как что-то работает, как им пользоваться или как его починить. Техническая документация должна быть четкой, понятной, точной и краткой. Она не должна содержать лишних деталей, эмоций, мнений или оценок. Она должна следовать определенной структуре, которая логично и последовательно распределяет информацию по разделам и подразделам. Она также должна использовать простые и однозначные термины, которые соответствуют стандартам и нормам в данной области.
Художественное изложение — это текст, который создает художественный образ, выражает мысли и чувства автора или персонажей. Например, это может быть рассказ, стихотворение, эссе или рецензия.
Цель такого текста — произвести впечатление на читателя, вызвать у него эмоции, воображение или рефлексию. Художественное изложение может быть субъективным, творческим, метафорическим и образным. Оно не должно быть скучным, банальным, поверхностным или неверным. Такой текст может иметь свободную и гибкую структуру, которая зависит от идеи и формы текста. В нем можно использовать разнообразные и многозначные слова, обороты и средства художественной выразительности, которые подчеркивают индивидуальный стиль и вкус автора.
Какой текст проще составить
Из сравнения этих двух типов текстов можно сделать вывод, что составлять техническую документацию намного проще, чем художественное произведение.
Почему? Потому что техническая документация имеет более четкие и конкретные критерии, которые нужно соблюдать, а также менее зависит от индивидуального стиля и вкуса автора. Художественное произведение, наоборот, требует большего творческого подхода, воображения и мастерства, а также подвержено субъективной оценке читателя.
Конечно, это не значит, что техническая документация не требует умения и знания, а художественное изложение не имеет правил и стандартов. Но в целом, техническая документация более объективна и логична, чем творческое художественное изложение.
Советы по работе с техническим текстом
Формулировка предложений в технической документации требует ясности, точности и простоты. Вот несколько ключевых рекомендаций и примеров:
1. Используйте простые и чёткие предложения
Сложные и запутанные конструкции могут затруднить понимание.
Пример: «Нажмите кнопку питания, чтобы включить устройство» вместо «Для того, чтобы начать работу с устройством, необходимо найти и активировать кнопку, которая отвечает за его питание».
2. Избегайте жаргона и сложной терминологии
Если это не необходимо для понимания текста.
Пример: «Убедитесь, что кабель Ethernet подключен к компьютеру» вместо «Проверьте интеграцию интерфейса Ethernet с помощью соответствующего кабеля с вашим компьютерным устройством».
3. Будьте конкретными
Чётко указывайте, что нужно делать, избегая двусмысленности.
Пример: «Заполните форму, указав имя, адрес и дату рождения» вместо «Заполните форму всей необходимой информацией».
4. Используйте активный залог
Это делает предложения более прямыми и понятными.
Пример: «Сохраните файл, выбрав 'Файл > Сохранить'» вместо «Файл может быть сохранён через меню 'Файл > Сохранить'».
5. Избегайте длинных списков в предложении
Разбивайте сложную информацию на более мелкие части.
Пример: «Перед началом работы проверьте: а) уровень заряда батареи; б) наличие интернет-соединения; в) правильность установки программного обеспечения» вместо «Перед началом работы убедитесь, что батарея заряжена, интернет соединение налажено, и программное обеспечение установлено правильно».
6. Избегайте неопределённых слов и фраз
Таких как «может быть», «возможно», «и т.п.», которые вносят неопределенность.
Пример: «Подключите кабель к порту USB» вместо «Вы можете попробовать подключить кабель к порту USB».
Эти принципы помогут вам сделать техническую документацию понятной, доступной и легко исполнимой для конечных пользователей.
Вместо выводов
В заключение хочу сказать, что хорошая техническая документация — это не просто набор инструкций. Подходите к этой задаче тоже творчески, с уважением к своей аудитории, и тогда ваш текст станет не просто инструкцией, а настоящим путеводителем в мире технологий.
Ставьте лайк, если было полезно и делитесь в комментариях своими советами по работе с техническими текстами.
Еще больше интересных тем, — в нашем Telegram-канале
