Руководство по стилю Microsoft -Microsoft Manual of Style
Руководство Microsoft по стилю: ваше повседневное руководство по использованию, терминологии и стилю для профессиональных технических коммуникаций ( MSTP ), в прежних редакциях Microsoft Manual of Style for Technical Publications , было руководством по стилю, опубликованным Microsoft . Четвертое издание, ISBN 0-7356-4871-9 , было опубликовано в 2012 году. Сотрудники и партнеры Microsoft также имели доступ к версии Microsoft Compressed HTML Help (CHM).
В 2018 году книга была заменена веб-сайтом Microsoft Writing Style Guide , который присоединился к другим онлайн-руководствам, таким как Apple Style Guide и Google Developer Documentation Style Guide .
История
- Первое издание: опубликовано в 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 представляет собой упорядоченный в алфавитном порядке «Словарь терминов», обычно используемых в технической письменной форме.