Рекомендации по написанию технических текстов

5 4

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

Документация пишется всегда и на любые системы, в том числе и на системы документооборота. Каждая организация пишет эту документацию по-своему: кто-то придерживается ГОСТов, кто-то внутрифирменных стандартов. В любом случае документация должна соответствовать требованиям, предъявляемым к техническим текстам.

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

Рассмотрим некоторые характеристики стиля поподробнее.

Структура описания

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

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

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

Характер изложения

Под характером изложения понимается адекватная манера изложения текста. Именно такой характер изложения позволяет создать положительное отношение читателя к документу.

Читателю должно быть комфортно читать текст, поэтому тон текста должен быть доброжелательным, убедительным и объективным.

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

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

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

Например, не следует в документации использовать олицетворение, метафоры и т.п. Текст должен быть «сухим» и информативным.

Полнота, достоверность и ясность информации

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

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

Например, не следует оставлять без внимания описание каких-либо действий или особенностей их выполнения.

Под достоверностью понимается актуальность информации.

При написании текста следует указывать в нем только проверенные данные. Тексты должны соответствовать описываемой системе.

Под ясностью понимается способность точного восприятия информации.

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

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

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

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

Ориентированность текста

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

Рекомендуется писать тексты для различных категорий пользователей систем в зависимости от уровня их знаний и их обязанностей. Основной принцип ориентированности текста - «Каждому свое».

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

Терминология

Под терминологией понимается использование слов и выражений, специальных для данной области.

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

Например, не следует вводить синонимы или уточняющие словосочетания. Это может ввести читателя в заблуждение.

Оформление

Под оформлением понимается графическое представление текста. Оформление позволяет улучшить восприятие содержания текста.

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

При одинаковом же оформлении различных элементов текста затрудняется навигация по тексту.

 

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

А какие требования к написанию технических документов предъявляете вы?

 

Источники:

http://tech-writer.ru/style/special/

 

Александр Глущак

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

Наталья Донская

При написании документации на систему DIRECTUM стремимся учитывать указанные требования.

Авторизуйтесь, чтобы написать комментарий