В современном мире технологий точность и понятность текстов играют ключевую роль, особенно когда речь идет о технической документации и материалах для разработчиков. Google Word List — это уникальный список рекомендаций и правил, который помогает авторам, техническим писателям и инженерам создавать качественные, понятные и корректные тексты. Он направлен на стандартизацию терминологии, исключение неоднозначных выражений и повышение доступности материалов для широкой аудитории. Google Word List представляет собой часть большего комплекта рекомендаций, известного как Google Developer Documentation Style Guide. Именно здесь сосредоточены основные принципы написания, касающиеся лексики, грамматики, пунктуации и форматирования, применяемого в технической документации Google и многих связанных продуктов.
Данный список содержит сотни слов и терминов с подробной инструкцией по их использованию, а также примерами того, какие слова необходимо избегать и какие более уместные альтернативы стоит применять. Основная цель Google Word List заключается в создании единых стандартов, которые помогут сделать техническую литературу понятной для максимального числа пользователей — от опытных разработчиков до новичков, а также для аудитории с разным уровнем владения английским языком и из разных культурных и географических регионов. Особое внимание уделяется инклюзивности, чтобы тексты не содержали дискриминационных или оскорбительных выражений, и чтобы они были свободны от профессионального жаргона там, где это неуместно. В списке Google Word List четко прописаны термины, которые можно и нужно использовать, а также те, которыми стоит пользоваться с осторожностью или вовсе избегать. Например, вместо устаревших и потенциально спорных терминов «blacklist» и «whitelist» рекомендуется использовать более нейтральные варианты — «denylist» и «allowlist» или «blocklist» и «safelist».
Такое внимание к языку отражает современное понимание социальной ответственности в сфере коммуникаций. Особое внимание уделяется правилам употребления сокращений и аббревиатур. Например, в тексте советуют использовать «API» только для обозначения интерфейса программирования приложений, а не для описания классов или методов. Аналогично прописаны рекомендации по использованию терминов, обозначающих технические и продуктовые названия, например, «Google Cloud console» вместо общих фраз «cloud console» или «console» в отрыве от контекста. Для улучшения качества документации Google предлагает базовые рекомендации по правилам грамматики и стилистики.
Предпочтение отдается активному залогу, избеганию сложных и длинных предложений, а также к четкой и однозначной структуре. Важным аспектом является использование простых слов вместо сложных и излишне профессиональных терминов, если это не снижает технической точности. Например, вместо «utilize» и «leverage» предпочтительнее использовать более простой и широко понимаемый глагол «use». Google Word List детально разбирает проблемы, связанные с написанием слов с дефисами и без. Существует четкая грань между словами, которые нужно писать раздельно, через дефис или слитно.
Например, «load balancing» — как существительное, и «load-balancing» — как прилагательное. Это позволяет избежать путаницы и повышает читаемость текста. Значительную часть рекомендаций занимает работа с датами, временем, единицами измерения и числовыми значениями. Для повышения универсальности и удобства восприятия Google советует использовать формат, понятный глобальной аудитории, а также избегать использования специфических сокращений и обозначений, что способствует лучшей локализации и переводу текстов. В технологии активно применяется терминология, обозначающая пользовательский интерфейс и взаимодействие с ним.
Google предлагает не использовать общие или двусмысленные слова, такие как «button» для обозначения ссылок, а применять термины в соответствии с назначением элементов интерфейса. Например, для описания нажатия на экране мобильного устройства рекомендуется использовать «tap» вместо «click», что помогает сделать инструкции более точными и релевантными для целевой платформы. Также уделено внимание рекомендациям по ссылкам и кросс-ссылкам, что помогает улучшить навигацию по документации и сделать тексты более организованными и удобными для пользователя. Использование стандартизированных заголовков и ссылок повышает эффективность поиска нужной информации и снижает время на восприятие документов. Google Word List противопоставляет себя распространенным «жаргонам» и сленгу в технической среде.
Такие выражения, как «crazy», «bonkers», «ninja» и «guru» считаются неподходящими для официальной документации и нарушают профессиональный стиль. Вместо них следует применять более нейтральные и описательные термины, что позволяет сохранить уважительный тон и не отвлекать читателя неоправданными эмоциями. Независимо от специфики продукта или технологической области, использование Google Word List помогает создавать документацию, которая будет понятна широкой аудитории и комфортна при восприятии. Это особенно важно для открытых платформ, SDK, API и других инструментов, которые предназначены для международных пользователей с различным уровнем подготовки и различными культурными особенностями. Важно отметить, что Google поощряет гибкость и адаптацию рекомендаций под нужды конкретного проекта или аудитории.
