Pull to refresh
0
Bercut
Создаем решения для цифровизации бизнеса

Манул или мануал? Как искоренить опечатки в технических текстах

Reading time6 min
Views5.2K

В прошлом году был забавный эпизод — мы с моим коллегой, независимо друг от друга (удивительно, но факт!), сделали одну и ту же ошибку: вместо «база данных» написали «база дынных». Магазины в это время как раз были полны свежих сладких дынь. Видимо, я в тот момент был слишком голоден, и мой мозг постоянно отвлекался от проблематики архитектуры развёртывания информационных систем. Овощебаза с аппетитными спелыми фруктами — явно более привлекательный образ. А ещё лучше — бесконечные «поля дынных».

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

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

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

Кстати, зачастую такие мелкие описки и помарки как раз и возникают из-за того, что автор всё своё внимание сосредотачивает на фактической правильности текста, на проверке орфографии и пунктуации. И после этого вдвойне обидно ошибиться в чём-то совсем простом и тривиальном. Хочется, чтобы в тексте всё было идеально.

Можно ли как-то автоматизировать процесс отлова таких мелких назойливых «багов», чтобы раз и навсегда забыть о них и сосредоточиться на более важных вещах? В этой статье я хочу поделиться с вами несколькими способами борьбы с такими «вредителями», которые сам применяю на практике. А заодно перечислю самые забавные ляпы, которые я вылавливал в своих текстах.

Для начала небольшая цитата:

Хтоя свола и нензмеы, всё же вы мжеоте пчеорсть киакм-то орабозм эотт азабц. Подоряк рпоасженлоия бкув в кждаом свлое не яетвляся тиакм уж вныажм. Но пваеря и пляедосня бувкы кадожго солва дожнлы быть на сивох мтесах. Останылье бувкы мгуот быть пешаремены и всё же вы проётчте тескт без бошольго тудра. Это птомоу что чнтеие овасноно на пгадыредувании слеющдуего свлоа.

Этот эффект имеет и обратное действие: непроизвольная смена порядка букв при быстром написании слов на клавиатуре. У меня такие описки встречаются чаще всего, когда я быстро и вдохновенно пишу какой-нибудь текст. Да, технические тексты тоже можно писать «вдохновенно». Руки летают над клавиатурой, но не поспевают за словами, которые рождаются в голове: муза посетила IT-специалиста.

Муза посетила IT-специалиста
Муза посетила IT-специалиста

На Хабре уже много раз писали, что буквы на классической клавиатуре расположены неоптимально. Именно поэтому часто получается так, что при быстром наборе пальцы нажимают клавиши не в том порядке, который предполагался мозгом. Особенно часто такое бывает с пробелом: «Особенн очасто». Но и порядок букв в слове часто путается.

Вот избранное из моих последних «шедевров»: поисание, vocie, сосотяние, завяка, пекат. Вы резонно можете возразить, что все подобные ошибки выявляются простейшей проверкой орфографии. Обычно так оно и происходит. Но не всегда.

Чтобы это проиллюстрировать, я взял список существительных русского языка и с помощью небольшого скрипта нашёл несколько характерных примеров-анаграмм (на самом деле их гораздо больше):

  • икс, иск;

  • оплата, лопата;

  • штука, шутка;

  • выход, выдох;

  • сигнал, сингал;

  • утро, утор;

  • трос, торс;

  • сетка, секта;

  • контур, котурн;

  • сайра, сарай;

  • апельсин, спаниель;

  • загон, газон.

И самое замечательное: «руководство, куроводство».

Примечание: «Утор» — это нарезка на бочке или кадке для вставки дна. А «сингал» — это представитель народа сингалы, жителей Шри-Ланки. Специально посмотрел в Википедии. Такие слова особо опасны, потому что они не входят в наш повседневный словарный запас, но при этом есть во многих словарях. Правда, словарь Google Docs их не знает. Зато он знает слово «пекат» из моего списка «шедевров». У этого слова даже есть несколько значений.

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

Ещё один мой ляп. Как раз на этой неделе я ничтоже сумняшеся напечатал в очередном тексте «отпадочный интерфейс» вместо «отладочный интерфейс». Конечно, эту ошибку тут же услужливо подчеркнул алгоритм проверки орфографии, но было забавно.

Ещё в словах часто появляются лишние или исчезают нужные буквы. Тут лидер моего личного рейтинга — это пара «текст» и «тест».

Выйдем за границы одного слова:

А знаете ли Вы, что что 90% людей не замечают в этом тексте повторение слова «что» в самом начале?

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

Что же со всем этим делать? Вот несколько правил, которые я сам для себя придумал, чтобы бороться с описками:

1. Обращать внимание на то, что именно там подчёркивает система проверки орфографии.

Казалось бы, странно об этом писать, ведь эта система как раз и предназначена для того, чтобы выявлять большинство ошибок и описок. Но я стал замечать, что всё чаще игнорирую красные подчёркивания. Это связано с большим количеством ложных срабатываний. Если на среднестатистический технический текст натравить любую систему проверки орфографии «из коробки», вы тут же получите испещрённый красными подчёркиваниями экран.

Отсюда следующее правило:

2. Не лениться добавлять в словарь новые правильные слова.

Имена параметров, термины, названия систем — всё это слова, которых пока нет в словаре. Но, если они действительно написаны правильно, то это не ошибки. Чтобы среди них не затерялись действительные описки и ошибки, нужно избавиться от ложных срабатываний. Для этого нужно последовательно и систематически добавлять правильные термины в словарь. Например, совсем недавно я добавил в словарь своего приложения слово «фискализация». Главное — проверить, действительно ли слово, которое вы добавляете, написано без ошибок.

Что же делать с обратным случаем: когда проверка орфографии не помогает?

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

Какая [высокоодарённая личность] за сутки до отправки заказчику во всей инструкции заменила manual на manul?

Примеры «базы дынных» и «манула» показывают, что бывают такие слова, которые по сути верны, но совершенно неуместны, например, в технической документации. Я пока что ещё не описывал бизнес-процессы в зоопарках, поэтому вероятность необходимости упоминания манула в моих рабочих текстах стремится к нулю (хотя, вот в этом тексте упомянул же ведь!). Проверки орфографии тут бесполезны — эти харизматичные дикие коты прочно обосновались почти во всех словарях.

В таких случаях всегда жалеешь, что в словари можно что-то добавить, но почему-то нельзя ничего оттуда удалить. Хотя, почему нельзя? В некоторых системах словари хранятся в виде простых текстовых файлов. Или в каком-нибудь другом легко редактируемом формате. Можно попробовать постепенно вычистить оттуда всякие правильные, но совершенно неуместные для технических текстов слова.

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

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

Однажды по требованию заказчика поменял глобально в куче файлов «датчик» на «сенсор», а потом вручную выкорчёвывал бесчисленные «пересенсоры» и даже «приёмопересенсоры».

4. Написать скрипт для «отлова дынь».

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

5. Внимательно перечитывать каждый готовый текст.

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

Ещё лучше — привлечь к проверке кого-то ещё. В идеале — профессионального опытного редактора. Но любой новый читатель замечает описки быстрее, ведь он видит мой текст в первый раз. Кроме того, другому человеку легче отвлечься от смысла текста и проверить именно орфографию.


Вообще-то, я уже давно смирился с тем, что текстов (как и программ) совсем без ошибок не бывает. Может, и не обязательно с таким фанатизмом от них избавляться? Главное, чтобы сами тексты были интересными и/или полезными читателям. А уж описки и небольшие пунктуационные ошибки — это как трещинки кракелюра на старинной глиняной вазе: придают тексту человечности. Сразу видно, что писала не очередная нейронная сеть.

Ещё по теме: «Уж послала, так послала: 10 словосочетаний-паразитов в технических текстах».

Tags:
Hubs:
Total votes 30: ↑27 and ↓3+24
Comments41

Articles

Information

Website
bercut.com
Registered
Founded
Employees
201–500 employees
Location
Россия
Representative
Елена