Microsoft Manual of Style: Your Everyday Guide to Usage, Terminology, and Style for Professional Technical Communications ( 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.
История
Цель
Как и любое руководство по стилю , MSTP устанавливает стандарты и служит справочником для писателей. MSTP имеет конкретную цель — направлять технических писателей, редакторов и контент-менеджеров, работающих с продуктами Microsoft . Хотя руководство в некоторых частях фокусируется на использовании, характерном для этих продуктов, руководство также служит общим инструментом для технических писателей. Содержание варьируется от конкретных инструкций по именованию отдельных элементов конкретных программ до общих правил грамматики .
Содержание
MSTP разделен на две части, которым предшествуют предисловие и введение.
Часть 1 называется «Общие темы» и подразделяется на следующие 11 глав:
- Контент для Интернета: определяет параметры для всех типов веб-контента, включая веб-контент, видео, блоги, международные аспекты, а также аспекты доступности и юридические аспекты.
- Стиль и голос Microsoft: основные принципы и руководство по стилю.
- Контент для мировой аудитории: содержит инструкции, которые гарантируют, что документы будут понятны во всем мире, избегая местных ссылок и упрощая перевод текстов.
- Доступный контент: говорит о доступности во всех областях, включая дизайн, графику и текст; ссылается на приемлемую терминологию.
- Пользовательский интерфейс: предоставляет стандартизированные имена для элементов пользовательского интерфейса Microsoft .
- Процедуры и технический контент: предоставляет рекомендации по единообразному форматированию процедур и другого технического контента, чтобы помочь пользователям быстро и эффективно находить важную информацию.
- Практические вопросы стиля: указывает на распространенные проблемы, начиная от использования заглавных букв и заканчивая форматированием элементов стиля, таких как даты, числа и измерения.
- Грамматика: Содержит разделы об общем употреблении глаголов и существительных.
- Пунктуация: Содержит информацию об использовании знаков препинания.
- Индексы и ключевые слова: Содержит рекомендации по индексации и/или атрибуции контента, чтобы гарантировать его обнаружение пользователями.
- Акронимы и другие сокращения: Содержит рекомендации по последовательному использованию сокращений и аббревиатур, включая то, как и когда их использовать, чтобы избежать путаницы. Также содержит список сокращений и аббревиатур.
Часть 2 представляет собой «Словарь терминов», организованный в алфавитном порядке и обычно используемый в технической документации.
Внешние ссылки
