Почему светофор важнее Шекспира? Про примечания в технических текстах

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

https://habr.com/ru/articles/822145/

#примечания #примечания_к_техническим_текстам #техническая_документация #примечания_к_документации #уточнения #правила_оформления_примечаний #технические_тексты #пользовательская_документация #светофор #технические_писатели