Руководство Microsoft по стилю
«Руководство Microsoft по стилю: ваше повседневное руководство по использованию, терминологии и стилю для профессиональных технических коммуникаций» ( MSTP ), в прежних выпусках « Руководство Microsoft по стилю для технических публикаций» , — руководство по стилю опубликованное Microsoft . Четвертое издание, ISBN 0-7356-4871-9 был опубликован в 2012 году. Microsoft Сотрудники и партнеры также имели доступ к версии справки Microsoft Compressed HTML (CHM).
В 2018 году книга была заменена веб-сайтом « Руководство по стилю письма Microsoft» , присоединившееся к другим онлайн-руководствам, таким как « Руководство по стилю Apple» и «Руководство по стилю документации для разработчиков Google» .
История
[ редактировать ]- Первое издание: Опубликовано в 1995 г. ( ISBN 1-55615-939-0 )
- Второе издание: опубликовано в июне 1998 г. ( ISBN 1-57231-890-2 )
- Третье издание: опубликовано в июне 2004 г. ( ISBN 0-7356-1746-5 )
- Четвертое издание: опубликовано в январе 2012 г. ( ISBN 0-7356-4871-9 )
Цель
[ редактировать ]Как и любое руководство по стилю , MSTP устанавливает стандарты и служит справочником для авторов. MSTP имеет конкретную цель — помочь техническим писателям, редакторам и менеджерам контента, работающим с Microsoft продуктами . Хотя в некоторых частях руководства основное внимание уделяется использованию конкретных продуктов, руководство также служит общим инструментом для технических писателей. Содержание варьируется от конкретных инструкций по названию отдельных элементов конкретных программ до общих правил грамматики .
Содержание
[ редактировать ]MSTP разделен на две части, которым предшествуют предисловие и введение.
Часть 1 называется «Общие темы» и разделена на следующие 11 глав:
- Контент для Интернета: определяет параметры для всех типов веб-контента, включая Интернет, видео, блоги, международные аспекты, а также доступность и юридические аспекты.
- Стиль и голос Microsoft: основные принципы и руководство по стилю.
- Контент для мировой аудитории: содержит инструкции по обеспечению понимания документов во всем мире за счет исключения местных ссылок и облегчения перевода текстов.
- Доступный контент: рассказывает о доступности во всех областях, включая дизайн, графику и текст; относится к приемлемой терминологии.
- Пользовательский интерфейс: предоставляет стандартизированные имена для элементов Microsoft пользовательского интерфейса .
- Процедуры и техническое содержание: содержит рекомендации по единообразному форматированию процедур и другого технического контента, чтобы помочь пользователям быстро и эффективно находить важную информацию.
- Практические вопросы стиля: указывает на общие проблемы, начиная от использования заглавных букв и заканчивая форматированием элементов стиля, таких как даты, числа и размеры.
- Грамматика: содержит разделы, посвященные общему использованию глаголов и существительных.
- Пунктуация: содержит информацию об использовании знаков препинания.
- Индексы и ключевые слова. Содержит рекомендации по индексированию и/или атрибутированию контента, чтобы обеспечить его доступность для пользователей.
- Акронимы и другие сокращения. Содержит рекомендации по последовательному использованию акронимов и аббревиатур, включая то, как и когда их использовать, чтобы избежать путаницы. Он также содержит список сокращений и сокращений.
Часть 2 представляет собой «Словарь использования» терминов, обычно используемых в технической письменной речи, в алфавитном порядке.