Независимо от того, какую техническую документацию вы пишете, важно иметь под рукой шпаргалку с правилами использования заглавных букв. Таким образом, если вам нужно закончить что-то для клиента, вам не придется рыться в справочнике или лихорадочно искать ответы в Интернете. Добавьте эти правила в закладки, чтобы они всегда были под рукой.
Все имена собственные писать с заглавной буквы
Как и в любом другом виде письма, в технической документации имена собственные пишутся с заглавной буквы. Однако может быть сложно понять, что является существительным собственным, а что - просто другим словом. Помните об этих советах.
Названные места, дороги и транспортные средства
Капитализируйте все названные здания, а также все улицы, мосты, туннели, железные дороги и другие искусственные сооружения. Также напишите с заглавной буквы способы транспорта, если вы используете официальное название (напишите с заглавной буквы «Ford Focus», а не «автомобиль»). Если место, здание или комната не названы, их не следует писать с заглавной буквы.
Люди и иногда их изобретения
Всегда пишите имена людей с заглавной буквы, как и в любом документе. Однако, как технический писатель, вы также можете столкнуться с изобретениями или открытиями, названными в честь людей. В этом случае имя человека пишется с заглавной буквы, а слово, обозначающее открытие или изобретение, - нет: вспомните «горелку Бунзена», «комету Хейли», «болезнь Альцгеймера» и «чашку Петри». Используйте только те теории и научные законы, которые названы в честь кого-то.
Температурные весы
Аналогично, температурные шкалы, такие как Фаренгейт, Цельсий и Кельвин, названы в честь ученых. По этой причине в технической документации название весов всегда следует писать с заглавной буквы.
Клубы и организации
Капитализируйте все названные клубы, братские общества, официальные группы и другие организации. Также капитализируйте услуги этих организаций, но только если они официально названы. Например, напишите с заглавной буквы «Microsoft Word», а не «текстовый редактор Microsoft».
Направления только для собственных существительных
Направления на компасе следует писать с заглавной буквы, только если они являются частью имени собственного или известного названия места. Например, «Западное побережье» следует писать с заглавной буквы, как и «Уэст-Палм-Бич». Однако «ехать на запад» не следует.
Иногда используйте заглавные буквы для частей системы или программного обеспечения
Аналогично, напишите с заглавной буквы любой именованный компонент системы, о которой вы пишете. Например, рассмотрим следующие примеры:
- Названия меню или элементы интерфейса, такие как «Меню справки», пишутся с заглавной буквы, если в системе они написаны с заглавной буквы.
- Если в системе элементы интерфейса не пишутся с заглавной буквы, не используйте их в документации.
- Не используйте заглавные буквы для таких компонентов, как «мышь», «кнопка» или «переключатель».
-
Начинайте писать с заглавной буквы те части оборудования, на которых этикетка на оборудовании написана с заглавной буквы, например «Кнопка A».
Мужчина-надзиратель и работник осматривают оборудование
Никогда не используйте заглавную букву для акцента
Если вы работаете с экспертами в данной области над созданием содержания документа, вы, возможно, столкнулись с явлением использования заглавных букв для выделения. Когда эксперт в предметной области считает что-то важным, он или она может написать это слово с заглавной буквы. Обязательно следите за этим, создавая окончательный документ.
Иногда слова в аббревиатурах пишутся с заглавной буквы
Акронимы очень распространены в технических текстах, поэтому лучше всего выписывать все слова в аббревиатуре при первом использовании ее в документе, чтобы читатель знал, что представляет собой аббревиатура. Однако, когда вы записываете слова, пишите их с заглавной буквы, только если они являются существительными собственными. Например, «Международная организация по стандартизации (ISO)» пишется с заглавной буквы, а «пользовательский интерфейс (UI)» - нет.
Используйте ссылки в документе с заглавной буквы
В технических текстах часто используются ссылки на части документа или другие документы внутри серии. Когда вы ссылаетесь на эти документы или части, всегда пишите их с заглавной буквы. Рассмотрим следующее:
- " На основе потребностей пользователя, указанных в документе "Требования".
- " См. рисунок А в стандартной рабочей процедуре."
- " Как указано в Разделе 23."
Помните правила использования заглавных букв в науке
Для научных тем существуют определенные правила использования заглавных букв в технических документах. Помните о таких советах по техническому написанию.
Не пишите элементы таблицы Менделеева с заглавной буквы
Не пишите названия элементов с заглавной буквы, даже если их сокращения написаны с заглавной буквы. Это распространенная ошибка, поэтому следите за ней в исходных документах, которые вы, возможно, используете для создания документации.
Иногда астрономические термины пишут с заглавной буквы
Большинство планет, звезд и других небесных тел пишутся как имена собственные с заглавной буквы. Однако есть исключение для тех, кто наиболее близок к Земле или наиболее распространён. Начинайте писать с заглавной буквы «Земля», «Луна» и «Солнце», только если они находятся в предложении с другими небесными объектами.
Части научных названий делайте с заглавной буквы
Научные названия растений, животных и других живых существ всегда следует выделять курсивом. Однако правила капитализации немного сложнее. Напишите с заглавной буквы тип, род, отряд, класс и семейство, но не пишите с заглавной буквы вид.
Профессиональные титулы перед именами пишутся с заглавной буквы
Профессиональные звания, такие как «президент», «доктор» и «профессор», распространены в академической и технической работе. Вам следует писать эти названия с заглавной буквы, только если они идут перед чьим-либо именем. Например, «Президент Скотт Томас» следует писать с заглавной буквы, а «Скотт Томас, президент компании» - нет.
Названия документов и разделов писать с заглавной буквы
Используйте правила использования заглавных букв, предпочитаемые клиентом или организацией, для которой вы создаете документы. Как правило, первое и последнее слова заголовков должны быть написаны с заглавной буквы, как и большинство других слов в заголовке. Статьи, такие как «the» или «an», не пишутся с заглавной буквы, если они не являются первым или последним словом. Предлоги обычно не пишутся с заглавной буквы, если их длина не превышает четырех букв.
Всегда уточняйте у клиента
У каждой организации или бизнеса есть свои правила использования заглавных букв в определенных терминах или продуктах. Всегда уточняйте у своего клиента или работодателя, есть ли в их документации определенные термины, которые всегда пишутся с заглавной буквы. Затем добавьте эти заметки в этот список, чтобы создать удобный справочник для вашей работы.
