Microsofts stilmanual
The Microsoft Manual of Style: Your Everyday Guide to Usage, Terminology, and Style for Professional Technical Communications ( MSTP ), i tidigare utgåvor Microsoft Manual of Style for Technical Publications , var en stilguide utgiven av Microsoft . Den fjärde utgåvan, ISBN 0-7356-4871-9 , publicerades 2012. Microsofts anställda och partners hade också tillgång till en Microsoft Compressed HTML Help ( CHM)-version.
Under 2018 ersattes boken av en webbplats, Microsoft Writing Style Guide , och förenade sig med andra onlineguider som Apple Style Guide och Google Developer Documentation Style Guide .
Historia
- Första upplagan: Publicerad 1995 ( ISBN 1-55615-939-0 )
- Andra upplagan: Publicerad i juni 1998 ( ISBN 1-57231-890-2 )
- Tredje upplagan: Publicerad i juni 2004 ( ISBN 0-7356-1746-5 )
- Fjärde upplagan: Publicerad i januari 2012 ( ISBN 0-7356-4871-9 )
Syfte
Precis som vilken stilguide som helst , fastställer MSTP standarder och fungerar som en referens för författare. MSTP har det specifika syftet att vägleda tekniska skribenter, redaktörer och innehållshanterare som arbetar med Microsoft- produkter. Även om manualen i vissa delar fokuserar på användning som är specifik för dessa produkter, fungerar guiden också som ett allmänt verktyg för tekniska skribenter. Innehållet sträcker sig från specifika instruktioner för att namnge vissa delar av specifika program till allmänna grammatikregler .
Innehåll
MSTP:n är uppdelad i två delar, som föregås av ett förord och en inledning.
Del 1 har titeln "Allmänna ämnen" och är uppdelad i följande 11 kapitel:
- Innehåll för webben: Definierar parametrar för alla typer av webbinnehåll, inklusive webb, video, blogg, internationella överväganden samt tillgänglighet och juridiska överväganden.
- Microsofts stil och röst: Grundläggande principer och stilguide.
- Innehåll för en världsomspännande publik: Ger instruktioner för att säkerställa att dokument kommer att förstås i hela världen genom att undvika lokala referenser och göra texter lätta att översätta.
- Tillgängligt innehåll: Talar om tillgänglighet inom alla områden inklusive design, grafik och text; hänvisar till godtagbar terminologi.
- Användargränssnittet: Ger standardiserade namn för delar av Microsofts användargränssnitt .
- Procedurer och tekniskt innehåll: Ger riktlinjer för konsekvent formatering av procedurer och annat tekniskt innehåll för att hjälpa användare att snabbt och effektivt hitta viktig information
- Praktiska frågor om stil: Påpekar vanliga problem som sträcker sig från versaler till formatering av stilelement som datum, siffror och mått.
- Grammatik: Innehåller avsnitt om allmän användning av verb och substantiv.
- Skiljetecken: Innehåller information om hur du använder skiljetecken.
- Index och sökord: Ger riktlinjer för indexering och/eller tillskrivning av innehåll för att säkerställa att det är upptäckbart för användarna.
- Akronymer och andra förkortningar: Ger riktlinjer för konsekvent användning av akronymer och förkortningar, inklusive hur och när de ska användas för att undvika förvirring. Den innehåller också en lista över akronymer och förkortningar.
Del 2 är en alfabetiskt ordnad "Usage Dictionary" med termer som vanligtvis används i teknisk skrift.