Клуб технических писателей

Рубрика о стиле

Алексей
21 апреля 2014, 14:12

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

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

Профессор Джозеф Уильямс начинает свою книгу Стиль. Уроки ясности и изящества (англ. Style. Lessons in Clarity and Grace) с цитаты:

 

Знайте, что хотите сказать, и говорите об этом настолько ясно, насколько это возможно. Это единственный секрет стиля.

Мэтью Арнольд

 

Книга не заканчивается на этом совете, так как следовать ему сложнее, чем кажется. В рубрике «Стиль» мы попытаемся адаптировать уроки этой книги к русскому языку и применить их к документации Яндекса. Если все получится, то мы увидим, как сделать текст легче и яснее в заранее определенных рамках содержания.

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