Microsoft Manual of Style For Technical Publications - Contents

Contents

(Based upon Version 4.5 of the Help version)

The MSTP is divided into the following 13 sections:

Introduction: Provides acknowledgements and a brief guide to using the manual

Documenting the User Interface: Provides standardized names for elements of the Microsoft user interface. For example, it differentiates between a combo-box and a list-box and delineates how to refer to file names.

Content Formatting and Layout: Deals with several formatting and layout issues, including pictures with captions and tables.

Global Content: Provides instructions for ensuring that documents will be understood throughout the world by avoiding local references and making texts easy to translate.

Content for Software Developers: Gives conventions for code formatting and other issues that affect developers.

Web Content: Defines parameters for titles and descriptions of web pages, as well as ways of referring to tags, elements, and attributes in other documents.

Legal Content and Front Matter: Provides information about copyrights, trademarks, and other legal issues.

Indexing and Attributing: Contains guidelines for indexes and keywords.

Tone and Rhetoric: Urges the writer to avoid problems with tone. Specifically, it calls on technical writers to have a formal tone that is nevertheless interesting. It suggests writing should contain the following values: empathy, responsibility, passion, and inspiration.

Common Style Problems: Points out common problems ranging from capitalization to style used when describing a procedure.

Grammatical Elements: Contains sections on the general usage of verbs and nouns.

Punctuation: Contains not only information about using punctuation in general, but also some elements specific to the technical writing industry, such as formatting concerns.

Usage Dictionary: An alphabetized list of terms commonly used in technical writing. It also contains a list of acronyms and abbreviations.

Read more about this topic:  Microsoft Manual Of Style For Technical Publications

Famous quotes containing the word contents:

    Yet to speak of the whole world as metaphor
    Is still to stick to the contents of the mind
    And the desire to believe in a metaphor.
    It is to stick to the nicer knowledge of
    Belief, that what it believes in is not true.
    Wallace Stevens (1879–1955)

    How often we must remember the art of the surgeon, which, in replacing the broken bone, contents itself with releasing the parts from false position; they fly into place by the action of the muscles. On this art of nature all our arts rely.
    Ralph Waldo Emerson (1803–1882)

    To be, contents his natural desire;
    He asks no Angel’s wing, no Seraph’s fire;
    But thinks, admitted to that equal sky,
    His faithful dog shall bear him company.
    Alexander Pope (1688–1744)