Написанное должно быть удобочитаемо
#мысливслух #что_почитать

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

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

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

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

📍По окончании выполнения расчета регистрируется высокоприоритетная заявка → После расчета система создает заявку с приоритетом «Высокий»
📍На данном этапе разработка приложения идёт по плану. → Разработка приложения идет по плану.

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