Microsoft Стиль бойынша нұсқаулық - Microsoft Manual of Style

The Microsoft Стиль бойынша нұсқаулық: кәсіби техникалық коммуникацияға арналған күнделікті пайдалану, терминология және стиль (MSTP), бұрынғы басылымдарда Техникалық басылымдарға арналған Microsoft нұсқасы, Бұл стиль бойынша нұсқаулық жариялаған Microsoft. Төртінші басылым, ISBN  0-7356-4871-9, 2012 жылы 15 қаңтарда жарияланған. Microsoft қызметкерлер мен серіктестер а Microsoft сығылған HTML анықтамасы (CHM) MSTP нұсқасы.

2018 жылы кітаптың орнына веб-сайт пайда болды Microsoft жазу стиліне арналған нұсқаулық, сияқты басқа онлайн гидтерге қосылу Apple Style нұсқаулығы және Google Developer Documentation Style нұсқаулығы.

Тарих

  • Бірінші басылым: 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 тарауға бөлінеді:

  1. Вебке арналған мазмұн: веб-мазмұнның барлық түрлеріне, оның ішінде веб, видео, блог, халықаралық мәселелер мен қол жетімділік пен заңды мәселелерді анықтайды.
  2. Microsoft стилі және дауысы: негізгі принциптер және стиль бойынша нұсқаулық.
  3. Әлемдік аудиторияға арналған мазмұн: жергілікті сілтемелерден аулақ болу және мәтіндерді аударуды жеңілдету арқылы бүкіл әлемде құжаттарды түсінуге кепілдік береді.
  4. Қол жетімді мазмұн: дизайн, графика және мәтін сияқты барлық салалардағы қол жетімділік туралы әңгімелер; қолайлы терминологияға сілтеме жасайды.
  5. Пайдаланушы интерфейсі: элементтерінің стандартталған атауларын ұсынады Microsoft пайдаланушы интерфейсі.
  6. Процедуралар мен техникалық мазмұн: пайдаланушыларға маңызды ақпаратты жылдам және тиімді табуға көмектесу үшін процедуралар мен басқа техникалық мазмұнды дәйекті пішімдеу бойынша нұсқаулар береді
  7. Стильдің практикалық мәселелері: бас әріптен бастап күндер, сандар және өлшемдер сияқты стиль элементтерін форматтауға дейінгі жалпы мәселелерді көрсетеді.
  8. Грамматика: етістіктер мен зат есімдердің жалпы қолданысына арналған бөлімдерден тұрады.
  9. Тыныс белгілері: тыныс белгілерін қолдану туралы ақпараттан тұрады.
  10. Индекстер мен кілт сөздер: индекстеу және / немесе мазмұнды атрибуциялау бойынша нұсқаулық, оның пайдаланушылар үшін ашылуына кепілдік береді.
  11. Қысқартулар және басқа аббревиатуралар: аббревиатуралар мен аббревиатураларды дәйекті қолдану, оның ішінде шатастырмау үшін оларды қалай және қашан қолдану керек екендігі туралы нұсқаулар береді. Онда қысқартулар мен қысқартулар тізімі де бар.

2 бөлім - техникалық жазуда жиі қолданылатын терминдердің алфавит бойынша реттелген «Қолдану сөздігі».

Сыртқы сілтемелер